hydrobricks
Loading...
Searching...
No Matches
Action Class Reference
Inheritance diagram for Action:
ActionGlacierEvolutionDeltaH ActionLandCoverChange

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

ActionsManagerm_manager
 
int m_cursor
 
vecDouble m_sporadicDates
 
bool m_recursive
 
vecInt m_recursiveMonths
 
vecInt m_recursiveDays
 

Member Function Documentation

◆ Apply()

bool Action::Apply ( double date = 0)
virtual

Apply the action for a specific date.

Parameters
datethe date of the action.
Returns
true if the action was applied successfully.

Reimplemented in ActionGlacierEvolutionDeltaH, and ActionLandCoverChange.

◆ ApplyIfRecursive()

bool Action::ApplyIfRecursive ( const Time date)
virtual

Apply the recursive action, for a specific date.

Parameters
datethe 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
datethe 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 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
managerthe manager to set.

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