Package org.goplanit.utils.cumulatives

Class CumulativePointImpl

java.lang.Object

org.goplanit.utils.cumulatives.CumulativePointImpl

All Implemented Interfaces:

Serializable, CumulativePoint

public class CumulativePointImpl
extends Object
implements CumulativePoint

Represents a cumulative point in time

Author:

markr

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
CumulativePointImpl(double cumulativeCount, double referenceTimeInSeconds)	Constructor

Method Summary

Modifier and Type	Method	Description
double	computeAbsFlowRate(CumulativePoint adjacentCumulativePoint)	Compute the absolute flow rate in cumulative units/h
double	getAbsCumulativeDifferenceWith(CumulativePoint otherCumulative)	Absolute cumulative difference between this and passed in cumulative point
double	getAbsTimeDifferenceWith(CumulativePoint otherCumulative)	Absolute time difference in seconds between this and passed in cumulative point
double	getCumulativeCount()
double	getReferenceTimeInSeconds()
boolean	isEarlier(CumulativePoint otherCumulativePoint, double timeInSecondsEpsilon)	Verify if this point occurs earlier (given epsilon) than the passed in other point
boolean	isEarlierOrEqual(CumulativePoint otherCumulativePoint, double timeInSecondsEpsilon)	Verify if this point occurs earlier or equal (given epsilon) than the passed in other point
boolean	isLater(CumulativePoint otherCumulativePoint, double timeInSecondsEpsilon)	Verify if this point occurs later (given epsilon) than the passed in other point
boolean	isLaterOrEqual(CumulativePoint otherCumulativePoint, double timeInSecondsEpsilon)	Verify if this point occurs later or equal (given epsilon) than the passed in other point

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CumulativePointImpl

public CumulativePointImpl(double cumulativeCount,
                           double referenceTimeInSeconds)

Constructor

Parameters:

cumulativeCount - the count

referenceTimeInSeconds - the reference time

Method Detail

getAbsTimeDifferenceWith

public double getAbsTimeDifferenceWith(CumulativePoint otherCumulative)

Absolute time difference in seconds between this and passed in cumulative point

Specified by:

getAbsTimeDifferenceWith in interface CumulativePoint

Parameters:

otherCumulative - to compare with

Returns:

difference in seconds

getAbsCumulativeDifferenceWith

public double getAbsCumulativeDifferenceWith(CumulativePoint otherCumulative)

Absolute cumulative difference between this and passed in cumulative point

Specified by:

getAbsCumulativeDifferenceWith in interface CumulativePoint

Parameters:

otherCumulative - to compare with

Returns:

difference in cumulative units

computeAbsFlowRate

public double computeAbsFlowRate(CumulativePoint adjacentCumulativePoint)

Compute the absolute flow rate in cumulative units/h

Specified by:

computeAbsFlowRate in interface CumulativePoint

Parameters:

adjacentCumulativePoint - to use

Returns:

flow rate between adjacent points in cumulative units/h

isLater

public boolean isLater(CumulativePoint otherCumulativePoint,
                       double timeInSecondsEpsilon)

Verify if this point occurs later (given epsilon) than the passed in other point

Specified by:

isLater in interface CumulativePoint

Parameters:

otherCumulativePoint - to compare with

timeInSecondsEpsilon - epsilon

Returns:

true if later

isLaterOrEqual

public boolean isLaterOrEqual(CumulativePoint otherCumulativePoint,
                              double timeInSecondsEpsilon)

Verify if this point occurs later or equal (given epsilon) than the passed in other point

Specified by:

isLaterOrEqual in interface CumulativePoint

Parameters:

otherCumulativePoint - to compare with

timeInSecondsEpsilon - epsilon

Returns:

true if later

isEarlier

public boolean isEarlier(CumulativePoint otherCumulativePoint,
                         double timeInSecondsEpsilon)

Verify if this point occurs earlier (given epsilon) than the passed in other point

Specified by:

isEarlier in interface CumulativePoint

Parameters:

otherCumulativePoint - to compare with

timeInSecondsEpsilon - epsilon

Returns:

true if later

isEarlierOrEqual

public boolean isEarlierOrEqual(CumulativePoint otherCumulativePoint,
                                double timeInSecondsEpsilon)

Verify if this point occurs earlier or equal (given epsilon) than the passed in other point

Specified by:

isEarlierOrEqual in interface CumulativePoint

Parameters:

otherCumulativePoint - to compare with

timeInSecondsEpsilon - epsilon

Returns:

true if later

getReferenceTimeInSeconds

public double getReferenceTimeInSeconds()

Specified by:

getReferenceTimeInSeconds in interface CumulativePoint

Returns:

the referenceTimeInSeconds

getCumulativeCount

public double getCumulativeCount()

Specified by:

getCumulativeCount in interface CumulativePoint

Returns:

the cumulativeCount