CBMAgeIndicators Class Reference

#include <cbmageindicators.h>

Inheritance diagram for CBMAgeIndicators:

Collaboration diagram for CBMAgeIndicators:

Public Member Functions
	CBMAgeIndicators ()
virtual	~CBMAgeIndicators ()
void	configure (const DynamicObject &config) override
void	subscribe (NotificationCenter &notificationCenter) override
void	doLocalDomainInit () override
void	doTimingStep () override
Public Member Functions inherited from CBMModuleBase
virtual	~CBMModuleBase ()=default
void	onSystemInit () override
void	onSystemShutdown () override
void	onLocalDomainInit () override
void	onLocalDomainShutdown () override
void	onLocalDomainProcessingUnitInit () override
void	onLocalDomainProcessingUnitShutdown () override
void	onPreTimingSequence () override
void	onTimingInit () override
void	onTimingPrePostInit () override
void	onTimingPostInit () override
void	onTimingPostInit2 () override
void	onTimingShutdown () override
void	onTimingStep () override
void	onTimingPreEndStep () override
void	onTimingEndStep () override
void	onTimingPostStep () override
void	onOutputStep () override
void	onPrePostDisturbanceEvent () override
void	onPostDisturbanceEvent () override
void	onPostDisturbanceEvent2 () override
void	onError (std::string msg) override
void	onDisturbanceEvent (DynamicVar e) override
void	onPostNotification (short preMessageSignal) override
virtual void	doSystemInit ()
virtual void	doSystemShutdown ()
virtual void	doLocalDomainShutdown ()
virtual void	doLocalDomainProcessingUnitInit ()
virtual void	doLocalDomainProcessingUnitShutdown ()
virtual void	doPreTimingSequence ()
virtual void	doTimingInit ()
virtual void	doTimingPrePostInit ()
virtual void	doTimingPostInit ()
virtual void	doTimingPostInit2 ()
virtual void	doTimingShutdown ()
virtual void	doTimingPreEndStep ()
virtual void	doTimingEndStep ()
virtual void	doTimingPostStep ()
virtual void	doOutputStep ()
virtual void	doError (std::string msg)
virtual void	doDisturbanceEvent (DynamicVar)
virtual void	doPrePostDisturbanceEvent ()
virtual void	doPostDisturbanceEvent ()
virtual void	doPostDisturbanceEvent2 ()
virtual void	doPostNotification (short preMessageSignal)

Private Attributes
AgeClassHelper	_ageClassHelper

Constructor & Destructor Documentation

CBMAgeIndicators()

CBMAgeIndicators

(

)

~CBMAgeIndicators()

virtual ~CBMAgeIndicators ( )

virtual

Member Function Documentation

configure()

void configure ( const DynamicObject &  config )

override

Configuration function

Parameters

config

DynamicObject&

Returns

void

doLocalDomainInit()

void doLocalDomainInit ( )

overridevirtual

Event is fired at the start of the simulation. Instantiate an object of class AgeClassHelper with values of variables "age_class_range" and "age_maximum", if the variables are present in _landUnitData

Returns

void

Reimplemented from CBMModuleBase.

doTimingStep()

void doTimingStep ( )

overridevirtual

Obtain the ageClass of variable "age" in _landUnitData using AgeClassHelper.toAgeClass(),
assign this to variable "age_class" in _landUnitData

Returns

void

Reimplemented from CBMModuleBase.

subscribe()

void subscribe ( NotificationCenter &  notificationCenter )

override

Subscribe to the signals TimingInit, TimingEndStep and LocalDomainInit.

Parameters

notificationCenter

NotificationCenter&

Returns

void

Member Data Documentation

_ageClassHelper

AgeClassHelper _ageClassHelper

private

---

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

• /home/runner/work/moja.canada/moja.canada/Source/moja.modules.cbm/include/moja/modules/cbm/cbmageindicators.h
• /home/runner/work/moja.canada/moja.canada/Source/moja.modules.cbm/src/cbmageindicators.cpp