TimeMachine Class Reference

Inheritance diagram for TimeMachine:

Public Member Functions
void	Initialize (double start, double end, int timeStep, TimeUnit timeStepUnit)
void	Initialize (const TimerSettings &settings)
void	Reset ()
bool	IsOver ()
void	IncrementTime ()
int	GetTimeStepsNb ()
double	GetDate ()
double	GetStart ()
double	GetEnd ()
double *	GetTimeStepPointer ()
void	SetParametersUpdater (ParametersUpdater *parametersUpdater)
void	SetActionsManager (ActionsManager *actionsManager)

Member Function Documentation

GetDate()

double TimeMachine::GetDate ( )

inline

Get the current date as a MJD.

Returns

current date

GetEnd()

double TimeMachine::GetEnd ( )

inline

Get the end date as a MJD.

Returns

end date

GetStart()

double TimeMachine::GetStart ( )

inline

Get the start date as a MJD.

Returns

start date

GetTimeStepPointer()

double * TimeMachine::GetTimeStepPointer ( )

inline

Get a pointer to the time step in days.

Returns

pointer to the time step in days

GetTimeStepsNb()

int TimeMachine::GetTimeStepsNb

(

)

Get the number of time steps.

Returns

number of time steps

IncrementTime()

void TimeMachine::IncrementTime

(

)

Increment the timer.

Initialize() [1/2]

void TimeMachine::Initialize

(

const TimerSettings &

settings

)

Initialize the time machine (timer).

Parameters

settings

settings of the timer

Initialize() [2/2]

void TimeMachine::Initialize	(	double	start,
		double	end,
		int	timeStep,
		TimeUnit	timeStepUnit )

Initialize the time machine (timer).

Parameters

start	start date
end	end date
timeStep	time step
timeStepUnit	time step unit

IsOver()

bool TimeMachine::IsOver

(

)

Check if the timer is over.

Returns

true if the timer is over

Reset()

void TimeMachine::Reset

(

)

Reset the timer.

SetActionsManager()

void TimeMachine::SetActionsManager ( ActionsManager * actionsManager )

inline

Set the actions manager.

Parameters

actionsManager

pointer to the actions manager

SetParametersUpdater()

void TimeMachine::SetParametersUpdater ( ParametersUpdater * parametersUpdater )

inline

Set the parameters updater.

Parameters

parametersUpdater

pointer to the parameters updater

---

The documentation for this class was generated from the following files:

• /github/workspace/core/src/base/TimeMachine.h
• /github/workspace/core/src/base/TimeMachine.cpp