ActionGlacierSnowToIceTransformation Class Reference

Inheritance diagram for ActionGlacierSnowToIceTransformation:

Public Member Functions
	ActionGlacierSnowToIceTransformation (int month, int day, const string &landCoverName)
bool	Init () override
void	Reset () override
bool	Apply (double date) override
const string &	GetLandCoverName () const
const vecInt &	GetHydroUnitIds () const
Public Member Functions inherited from Action
void	ResetCursor ()
void	AddRecursiveDate (int month, int day)
virtual bool	ApplyIfRecursive (const Time date)
int	GetIndexForInsertion (double date) const
double	CheckLandCoverAreaFraction (const string &name, int id, double fraction, double unitArea, double lcArea)
void	SetManager (ActionsManager *manager)
const vecDouble &	GetSporadicDates () const
int	GetSporadicItemCount () const
void	IncrementCursor ()
bool	IsRecursive () const
virtual bool	IsValid () const
virtual void	Validate () const

Protected Attributes
string	_landCoverName
vecInt	_hydroUnitIds
Protected Attributes inherited from Action
ActionsManager *	_manager
int	_cursor
vecDouble	_sporadicDates
bool	_recursive
vecInt	_recursiveMonths
vecInt	_recursiveDays

Constructor & Destructor Documentation

ActionGlacierSnowToIceTransformation()

ActionGlacierSnowToIceTransformation::ActionGlacierSnowToIceTransformation	(	int	month,
		int	day,
		const string &	landCoverName )

Constructor for the ActionGlacierSnowToIceTransformation class.

Parameters

month	month of the year (1-12).
day	day of the month (1-31).
landCoverName	name of the land cover associated with the action. It is used to identify the specific glacier 'name' as we can have multiple glacier land covers in the model.

Member Function Documentation

Apply()

bool ActionGlacierSnowToIceTransformation::Apply ( double date )

nodiscardoverridevirtual

Apply the action.

Parameters

date	date of the action.

Returns

true if the action was applied successfully.

Reimplemented from Action.

GetHydroUnitIds()

const vecInt & ActionGlacierSnowToIceTransformation::GetHydroUnitIds ( ) const

inline

Get the hydro unit IDs associated with the action.

Returns

vector of hydro unit IDs.

GetLandCoverName()

const string & ActionGlacierSnowToIceTransformation::GetLandCoverName ( ) const

inline

Get the land cover name (glacier name) associated with the action.

Returns

land cover name (glacier name).

Init()

bool ActionGlacierSnowToIceTransformation::Init ( )

nodiscardoverridevirtual

Initialize the action.

Reimplemented from Action.

Reset()

void ActionGlacierSnowToIceTransformation::Reset ( )

overridevirtual

Reset the action to its initial state.

Reimplemented from Action.

---

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

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