ActionsManager Class Reference

Inheritance diagram for ActionsManager:

Public Member Functions
void	Reset ()
ModelHydro *	GetModel () const
void	SetModel (ModelHydro *model)
bool	AddAction (Action *action)
int	GetActionCount () const
int	GetSporadicActionItemCount () const
void	DateUpdate (double date)
SubBasin *	GetSubBasin () const
HydroUnit *	GetHydroUnitById (int id) const
const vecDouble &	GetSporadicActionDates () const
bool	IsValid () const
void	Validate () const

Protected Attributes
ModelHydro *	_model
int	_cursorManager
vector< Action * >	_actions
vecDouble	_sporadicActionDates
vecInt	_sporadicActionIndices
vecInt	_recursiveActionIndices

Member Function Documentation

AddAction()

bool ActionsManager::AddAction

(

Action *

action

)

Add an action to the manager.

Parameters

action

pointer to the action.

Returns

true if the action was added successfully.

DateUpdate()

void ActionsManager::DateUpdate

(

double

date

)

Update the date during the simulation. Triggers the actions that are scheduled for the current date.

Parameters

date	corresponding date of the simulation.

GetActionCount()

int ActionsManager::GetActionCount

(

)

const

Get the number of actions.

Returns

number of actions.

GetHydroUnitById()

HydroUnit * ActionsManager::GetHydroUnitById

(

int

id

)

const

Get hydro unit by ID.

Parameters

id	ID of the hydro unit.

Returns

pointer to the hydro unit.

GetModel()

ModelHydro * ActionsManager::GetModel ( ) const

inline

Get the associated model.

Returns

pointer to the model.

GetSporadicActionDates()

const vecDouble & ActionsManager::GetSporadicActionDates ( ) const

inline

Get the list of sporadic action dates (i.e., actions that are not recursive).

Returns

vector of sporadic action dates.

GetSporadicActionItemCount()

int ActionsManager::GetSporadicActionItemCount

(

)

const

Get the number of sporadic action items (i.e., actions that are not recursive).

Returns

number of sporadic action items.

GetSubBasin()

SubBasin * ActionsManager::GetSubBasin

(

)

const

Get the sub basin associated with the model.

Returns

pointer to the sub basin.

IsValid()

bool ActionsManager::IsValid ( ) const

nodiscard

Check if the actions manager is valid. Verifies that the manager is properly configured with a model.

Returns

true if the actions manager is valid, false otherwise.

Reset()

void ActionsManager::Reset

(

)

Reset the actions manager.

SetModel()

void ActionsManager::SetModel

(

ModelHydro *

model

)

Set the associated model.

Parameters

model

pointer to the model.

Validate()

void ActionsManager::Validate

(

)

const

Validate the actions manager. Throws an exception if the actions manager is invalid.

Exceptions

ModelConfigError

if validation fails.

---

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

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