Class DateBasedTimer

java.lang.Object

madkit.simulation.scheduler.SimuTimer<LocalDateTime>

madkit.simulation.scheduler.DateBasedTimer

public class DateBasedTimer
extends SimuTimer<LocalDateTime>

This class encapsulates the time of the simulation. Its purpose is that it can be passed across objects without problem. That is, BigDecimal is immutable and therefore creates a new instance for each modification.

Since:

MaDKit 5.3

See Also:

• LocalDateTime

Constructor Summary

Constructors

Constructor	Description
DateBasedTimer()	Creates a date-based time which value is LocalDateTime.of(1, 1, 1, 0, 0);
DateBasedTimer(LocalDateTime initialDate)	Creates a date-based instance using a specific LocalDateTime as starting point.
DateBasedTimer(LocalDateTime initialDate, LocalDateTime endDate)	Creates a date-based instance using a specific LocalDateTime as starting point.

Method Summary

Modifier and Type	Method	Description
void	addOneTimeUnit()	Adds one time unit to the current date using the default unit.
ChronoUnit	getDefaultTemporalUnit()	Gets the default temporal unit for date increments.
void	incrementCurrentDate(long amountToAdd)	Increments the current date by the specified amount using the default unit.
void	incrementCurrentDate(long amountToAdd, ChronoUnit unit)	Increments the current date by the specified amount and unit.
void	setDefaultTemporalUnit(ChronoUnit unit)	Sets the default temporal unit for date increments.

Methods inherited from class madkit.simulation.scheduler.SimuTimer

getCurrentTime, getEndTime, getStartTime, getTimeLabel, hasReachedEndTime, reset, setCurrentTime, setEndTime, setStartTime, setTimeFormat, toString

Methods inherited from class java.lang.Object

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

Constructor Details

DateBasedTimer

public DateBasedTimer(LocalDateTime initialDate,
 LocalDateTime endDate)

Creates a date-based instance using a specific LocalDateTime as starting point.

Parameters:

initialDate - a LocalDateTime to start with

endDate - a LocalDateTime to end with

See Also:

• LocalDateTime

DateBasedTimer

public DateBasedTimer(LocalDateTime initialDate)

Creates a date-based instance using a specific LocalDateTime as starting point.

Parameters:

initialDate - a LocalDateTime to start with

See Also:

• LocalDateTime

DateBasedTimer

public DateBasedTimer()

Creates a date-based time which value is LocalDateTime.of(1, 1, 1, 0, 0);

Method Details

incrementCurrentDate

public void incrementCurrentDate(long amountToAdd,
 ChronoUnit unit)

Increments the current date by the specified amount and unit.

Parameters:

amountToAdd - the amount to add

unit - the unit of the amount to add

incrementCurrentDate

public void incrementCurrentDate(long amountToAdd)

Increments the current date by the specified amount using the default unit.

Parameters:

amountToAdd - the amount to add

setDefaultTemporalUnit

public void setDefaultTemporalUnit(ChronoUnit unit)

Sets the default temporal unit for date increments.

Parameters:

unit - the default temporal unit

getDefaultTemporalUnit

public ChronoUnit getDefaultTemporalUnit()

Gets the default temporal unit for date increments.

Returns:

the default temporal unit

addOneTimeUnit

public void addOneTimeUnit()

Adds one time unit to the current date using the default unit.