Package org.planit.utils.cumulatives

Interface CumulativePoint

All Superinterfaces:

Serializable

All Known Implementing Classes:

CumulativePointImpl

public interface CumulativePoint
extends Serializable

Represents a cumulative point in time

Author:

markr

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

Method Detail

getAbsTimeDifferenceWith

double getAbsTimeDifferenceWith(CumulativePoint otherCumulative)

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

Parameters:

otherCumulative - to compare with

Returns:

difference in seconds

getAbsCumulativeDifferenceWith

double getAbsCumulativeDifferenceWith(CumulativePoint otherCumulative)

Absolute cumulative difference between this and passed in cumulative point

Parameters:

otherCumulative - to compare with

Returns:

differece in cumulative units

computeAbsFlowRate

double computeAbsFlowRate(CumulativePoint adjacentCumulativePoint)

Compute the absolute flow rate in cumulative units/h

Parameters:

adjacentCumulativePoint - to use

Returns:

flow rate between adjacent points in cumulative units/h

isLater

boolean isLater(CumulativePoint otherCumulativePoint,
                double timeInSecondsEpsilon)

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

Parameters:

otherCumulativePoint - to compare with

timeInSecondsEpsilon - epsilon

Returns:

true if later

isLaterOrEqual

boolean isLaterOrEqual(CumulativePoint otherCumulativePoint,
                       double timeInSecondsEpsilon)

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

Parameters:

otherCumulativePoint - to compare with

timeInSecondsEpsilon - epsilon

Returns:

true if later

isEarlier

boolean isEarlier(CumulativePoint otherCumulativePoint,
                  double timeInSecondsEpsilon)

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

Parameters:

otherCumulativePoint - to compare with

timeInSecondsEpsilon - epsilon

Returns:

true if later

isEarlierOrEqual

boolean isEarlierOrEqual(CumulativePoint otherCumulativePoint,
                         double timeInSecondsEpsilon)

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

Parameters:

otherCumulativePoint - to compare with

timeInSecondsEpsilon - epsilon

Returns:

true if later

getReferenceTimeInSeconds

double getReferenceTimeInSeconds()

Returns:

the referenceTimeInSeconds

getCumulativeCount

double getCumulativeCount()

Returns:

the cumulativeCount