Package com.amalgamasimulation.utils.time

Class EveryNDaysTimeSeries

java.lang.Object

com.amalgamasimulation.utils.time.TimeSeries

com.amalgamasimulation.utils.time.RepeatingTimeSeries

com.amalgamasimulation.utils.time.EveryNDaysTimeSeries

public class EveryNDaysTimeSeries
extends RepeatingTimeSeries

Time series containing instants formed according to the rule: "At the specified time of day every n days".

This class must be used to represent time series with daily instants. This can be achieved by specifying nDays = 1.

Author:

Alexey Kirillov

Field Summary

Fields inherited from class com.amalgamasimulation.utils.time.RepeatingTimeSeries

instantTime

Fields inherited from class com.amalgamasimulation.utils.time.TimeSeries

timeable

Constructor Summary

Constructors

Constructor	Description
EveryNDaysTimeSeries(LocalTime instantTime, int nDays, Timeable timeable)	Creates a new instance of TimeSeries containing instants formed according to the rule: "At the specified time of day every n days".

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
List<Double>	getInstantsTimes(double beginTime, double endTime, boolean beginTimeInclusive, boolean endTimeInclusive)	Returns an unmodifiable list containing all times of instants of this time series between the specified times.
double	getNextInstantTime(double time, boolean timeInclusive)	Returns the time of the smallest instant of this time series after the specified time, or Double.POSITIVE_INFINITY if there are no such instants in this time series.
double	getPreviousInstantTime(double time)	Returns the time of the biggest instant of this time series that is strictly less than the the specified time, or Double.NEGATIVE_INFINITY if there is no such instant.
int	hashCode()
int	nDays()

Methods inherited from class com.amalgamasimulation.utils.time.RepeatingTimeSeries

instantTime

Methods inherited from class com.amalgamasimulation.utils.time.TimeSeries

everyMonth, everyMonthLastDay, everyNDaysTimeSeries, everyWeekTimeSeries, getInstantsTimes, getNextInstantTime, of, of, of, relativeTimeSeries, singleTimeSeries

Methods inherited from class java.lang.Object

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

Constructor Details

EveryNDaysTimeSeries

public EveryNDaysTimeSeries(LocalTime instantTime,
 int nDays,
 Timeable timeable)

Creates a new instance of TimeSeries containing instants formed according to the rule: "At the specified time of day every n days". Time series with daily instants can be produced by specifying nDays = 1.

Parameters:

instantTime - specified time of day

nDays - period in days, must be positive

timeable - Timeable instance that provides translation from calendar dates to number based values of instants

Method Details

nDays

public int nDays()

getNextInstantTime

public double getNextInstantTime(double time,
 boolean timeInclusive)

Description copied from class: TimeSeries

Returns the time of the smallest instant of this time series after the specified time, or Double.POSITIVE_INFINITY if there are no such instants in this time series. Allows to include or exclude the specified time itself.

Specified by:

getNextInstantTime in class TimeSeries

Parameters:

time - specified time

timeInclusive - whether to include or exclude the specified time

Returns:

time of the smallest instant of this time series after the specified time, or Double.POSITIVE_INFINITY

getPreviousInstantTime

public double getPreviousInstantTime(double time)

Description copied from class: TimeSeries

Returns the time of the biggest instant of this time series that is strictly less than the the specified time, or Double.NEGATIVE_INFINITY if there is no such instant.

Specified by:

getPreviousInstantTime in class TimeSeries

Parameters:

time - specified time

Returns:

time of the biggest instant of this time series that is strictly less than the the specified time, or Double.NEGATIVE_INFINITY

getInstantsTimes

public List<Double> getInstantsTimes(double beginTime,
 double endTime,
 boolean beginTimeInclusive,
 boolean endTimeInclusive)

Description copied from class: TimeSeries

Returns an unmodifiable list containing all times of instants of this time series between the specified times. If there are no such instants, an empty list is returned. Allows to include or exclude the boundaries of the specified time interval.

Specified by:

getInstantsTimes in class TimeSeries

Parameters:

beginTime - smallest time of instants being returned

endTime - biggest time of instants being returned

beginTimeInclusive - whether to include or exclude the right boundary (beginTime)

endTimeInclusive - whether to include or exclude the left boundary (endTime)

Returns:

unmodifiable list containing all times of instants of this time series between the specified times

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object