Action Class Reference

Inheritance diagram for Action:

Public Member Functions
void	Reset ()
virtual bool	Init ()
virtual bool	Apply (double date=0)
virtual bool	ApplyIfRecursive (const Time date)
int	GetIndexForInsertion (double date)
void	SetManager (ActionsManager *manager)
vecDouble	GetSporadicDates ()
int	GetSporadicItemsNb ()
void	IncrementCursor ()
bool	IsRecursive ()

Protected Attributes
ActionsManager *	_manager
int	_cursor
vecDouble	_sporadicDates
bool	_recursive
vecInt	_recursiveMonths
vecInt	_recursiveDays

Member Function Documentation

Apply()

bool Action::Apply ( double date = 0 )

virtual

Apply the action for a specific date.

Parameters

date	the date of the action.

Returns

true if the action was applied successfully.

Reimplemented in ActionGlacierEvolutionAreaScaling, ActionGlacierEvolutionDeltaH, and ActionLandCoverChange.

ApplyIfRecursive()

bool Action::ApplyIfRecursive ( const Time date )

virtual

Apply the recursive action, for a specific date.

Parameters

date	the date of the action.

Returns

true if the action was applied successfully.

GetIndexForInsertion()

int Action::GetIndexForInsertion

(

double

date

)

Get the index for insertion in the sporadic dates vector.

Parameters

date	the date to insert.

Returns

the index for insertion.

GetSporadicDates()

vecDouble Action::GetSporadicDates ( )

inline

Get the sporadic dates vector.

Returns

the sporadic dates vector.

GetSporadicItemsNb()

int Action::GetSporadicItemsNb ( )

inline

Get the number of sporadic items.

Returns

the number of sporadic items.

IncrementCursor()

void Action::IncrementCursor ( )

inline

Increment the cursor.

Init()

bool Action::Init ( )

virtual

Initialize the action.

Returns

true if the initialization was successful.

Reimplemented in ActionGlacierEvolutionAreaScaling, and ActionGlacierEvolutionDeltaH.

IsRecursive()

bool Action::IsRecursive ( )

inline

Check if the action is recursive.

Returns

true if the action is recursive.

Reset()

void Action::Reset

(

)

Reset the action to its initial state.

SetManager()

void Action::SetManager ( ActionsManager * manager )

inline

Set the manager of the action.

Parameters

manager

the manager to set.

---

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

• /github/workspace/core/src/actions/Action.h
• /github/workspace/core/src/actions/Action.cpp