DisturbanceMonitorModule Class Reference

#include <disturbancemonitormodule.h>

Inheritance diagram for DisturbanceMonitorModule:

Collaboration diagram for DisturbanceMonitorModule:

Public Member Functions
	DisturbanceMonitorModule ()
virtual	~DisturbanceMonitorModule ()=default
void	subscribe (NotificationCenter &notificationCenter) override
flint::ModuleTypes	moduleType ()
virtual void	doLocalDomainInit () override
virtual void	doTimingInit () override
virtual void	doOutputStep () override
virtual void	doDisturbanceEvent (DynamicVar) 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	doTimingPrePostInit ()
virtual void	doTimingPostInit ()
virtual void	doTimingPostInit2 ()
virtual void	doTimingShutdown ()
virtual void	doTimingStep ()
virtual void	doTimingPreEndStep ()
virtual void	doTimingEndStep ()
virtual void	doTimingPostStep ()
virtual void	doError (std::string msg)
virtual void	doPrePostDisturbanceEvent ()
virtual void	doPostDisturbanceEvent ()
virtual void	doPostDisturbanceEvent2 ()
virtual void	doPostNotification (short preMessageSignal)

Private Attributes
bool	_moduleEnabled = true
flint::IVariable *	_currentDisturbance

Constructor & Destructor Documentation

DisturbanceMonitorModule()

DisturbanceMonitorModule

(

)

~DisturbanceMonitorModule()

virtual ~DisturbanceMonitorModule ( )

virtualdefault

Member Function Documentation

doDisturbanceEvent()

void doDisturbanceEvent ( DynamicVar  e )

overridevirtual

doDisturbanceEvent

If DisturbanceMonitorModule._moduleEnabled is true, then assign the value of "disturbance_type_code" in parameter e to DisturbanceMonitorModule._currentDisturbance

Parameters

DynamicVar

e

Returns

void

Reimplemented from CBMModuleBase.

doLocalDomainInit()

void doLocalDomainInit ( )

overridevirtual

If _landUnitdata has the variable "current_disturbance", set DisturbanceMonitorModule._moduleEnabled as true,
DisturbanceMonitorModule._currentDisturbance as variable "current_disturbance" in _landUnitData

Returns

void

Reimplemented from CBMModuleBase.

doOutputStep()

void doOutputStep ( )

overridevirtual

If DisturbanceMonitorModule._moduleEnabled is true, set the value of DisturbanceMonitorModule._currentDisturbance to DynamicVar()

Returns

void

Reimplemented from CBMModuleBase.

doTimingInit()

void doTimingInit ( )

overridevirtual

If DisturbanceMonitorModule._moduleEnabled is true, set the value of DisturbanceMonitorModule._currentDisturbance to DynamicVar()

Returns

void

Reimplemented from CBMModuleBase.

moduleType()

flint::ModuleTypes moduleType

(

)

subscribe()

void subscribe ( NotificationCenter &  notificationCenter )

override

Subscribe to signals LocalDomainInit, TimingInit, OutputStep and DisturbanceEvent

Returns

void

Member Data Documentation

_currentDisturbance

flint::IVariable* _currentDisturbance

private

_moduleEnabled

bool _moduleEnabled = true

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/disturbancemonitormodule.h
• /home/runner/work/moja.canada/moja.canada/Source/moja.modules.cbm/src/disturbancemonitormodule.cpp