CBMModuleBase Class Reference

#include <cbmmodulebase.h>

Inheritance diagram for CBMModuleBase:

Collaboration diagram for CBMModuleBase:

Public Member Functions
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	doLocalDomainInit ()
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	doTimingStep ()
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 Member Functions
void	doWithHandling (const std::function< void()> &fn)
void	raiseModuleError (moja::Exception &e)
void	raiseModuleError (boost::exception &e)
void	raiseModuleError (std::exception &e)

Constructor & Destructor Documentation

~CBMModuleBase()

virtual ~CBMModuleBase ( )

virtualdefault

Member Function Documentation

doDisturbanceEvent()

virtual void doDisturbanceEvent ( DynamicVar  )

virtual

Reimplemented in CBMDisturbanceListener, GrowthMultiplierModule, CBMTransitionRulesModule, CBMPeatlandSpinupOutput, MossDisturbanceModule, PeatlandDisturbanceModule, CBMDisturbanceEventModule, CBMSpinupDisturbanceModule, DisturbanceMonitorModule, and CBMPartitioningModule.

doError()

virtual void doError ( std::string  msg )

virtual

Reimplemented in CBMAggregatorLandUnitData, and CBMFlatAggregatorLandUnitData.

doLocalDomainInit()

virtual void doLocalDomainInit ( )

virtual

Reimplemented in CBMDisturbanceListener, GrowthMultiplierModule, SawtoothModule, CBMAggregatorCsvWriter, CBMAggregatorLandUnitData, CBMTransitionRulesModule, CBMFlatAggregatorLandUnitData, CBMAggregatorLibPQXXWriter, CBMDecayModule, YieldTableGrowthModule, SmallTreeGrowthModule, MossDisturbanceModule, PeatlandSpinupNext, MossDecayModule, PeatlandDisturbanceModule, ESGYMModule, PeatlandAfterCBMModule, CBMDisturbanceEventModule, CBMPeatlandSpinupOutput, PeatlandDecayModule, CBMSpinupDisturbanceModule, MossGrowthModule, CBMAgeIndicators, PeatlandGrowthModule, CBMLandClassTransitionModule, CBMPartitioningModule, PeatlandSpinupTurnOverModule, StandMaturityModule, MossTurnoverModule, DisturbanceMonitorModule, PeatlandTurnoverModule, and CBMBuildLandUnitModule.

doLocalDomainProcessingUnitInit()

virtual void doLocalDomainProcessingUnitInit ( )

virtual

doLocalDomainProcessingUnitShutdown()

virtual void doLocalDomainProcessingUnitShutdown ( )

virtual

doLocalDomainShutdown()

virtual void doLocalDomainShutdown ( )

virtual

Reimplemented in CBMPeatlandSpinupOutput.

doOutputStep()

virtual void doOutputStep ( )

virtual

Reimplemented in CBMAggregatorLandUnitData, CBMFlatAggregatorLandUnitData, and DisturbanceMonitorModule.

doPostDisturbanceEvent()

virtual void doPostDisturbanceEvent ( )

virtual

doPostDisturbanceEvent2()

virtual void doPostDisturbanceEvent2 ( )

virtual

doPostNotification()

virtual void doPostNotification ( short  preMessageSignal )

virtual

doPrePostDisturbanceEvent()

virtual void doPrePostDisturbanceEvent ( )

virtual

Reimplemented in PeatlandSpinupNext, and CBMPeatlandSpinupOutput.

doPreTimingSequence()

virtual void doPreTimingSequence ( )

virtual

Reimplemented in CBMBuildLandUnitModule.

doSystemInit()

virtual void doSystemInit ( )

virtual

Reimplemented in CBMAggregatorCsvWriter, CBMAggregatorPostgreSQLWriter, CBMAggregatorSQLiteWriter, and CBMAggregatorLibPQXXWriter.

doSystemShutdown()

virtual void doSystemShutdown ( )

virtual

Reimplemented in CBMDisturbanceListener, SawtoothModule, CBMAggregatorCsvWriter, CBMAggregatorPostgreSQLWriter, CBMAggregatorSQLiteWriter, and CBMAggregatorLibPQXXWriter.

doTimingEndStep()

virtual void doTimingEndStep ( )

virtual

Reimplemented in StandMaturityModule.

doTimingInit()

virtual void doTimingInit ( )

virtual

Reimplemented in CBMDisturbanceListener, GrowthMultiplierModule, SawtoothModule, CBMAggregatorLandUnitData, CBMTransitionRulesModule, CBMFlatAggregatorLandUnitData, CBMDecayModule, YieldTableGrowthModule, SmallTreeGrowthModule, MossDisturbanceModule, MossDecayModule, PeatlandDisturbanceModule, ESGYMModule, CBMPeatlandSpinupOutput, PeatlandDecayModule, CBMSpinupDisturbanceModule, MossGrowthModule, PeatlandGrowthModule, CBMLandClassTransitionModule, CBMPartitioningModule, PeatlandSpinupTurnOverModule, StandMaturityModule, MossTurnoverModule, DisturbanceMonitorModule, and PeatlandTurnoverModule.

doTimingPostInit()

virtual void doTimingPostInit ( )

virtual

doTimingPostInit2()

virtual void doTimingPostInit2 ( )

virtual

doTimingPostStep()

virtual void doTimingPostStep ( )

virtual

doTimingPreEndStep()

virtual void doTimingPreEndStep ( )

virtual

doTimingPrePostInit()

virtual void doTimingPrePostInit ( )

virtual

doTimingShutdown()

virtual void doTimingShutdown ( )

virtual

Reimplemented in GrowthMultiplierModule, SawtoothModule, and CBMTransitionRulesModule.

doTimingStep()

virtual void doTimingStep ( )

virtual

Reimplemented in CBMDisturbanceListener, GrowthMultiplierModule, SawtoothModule, CBMDecayModule, YieldTableGrowthModule, SmallTreeGrowthModule, MossDecayModule, CBMPeatlandSpinupOutput, ESGYMModule, PeatlandAfterCBMModule, PeatlandDecayModule, MossGrowthModule, CBMPartitioningModule, PeatlandGrowthModule, CBMAgeIndicators, CBMLandClassTransitionModule, PeatlandSpinupTurnOverModule, MossTurnoverModule, and PeatlandTurnoverModule.

doWithHandling()

void doWithHandling ( const std::function< void()> &  fn )

private

onDisturbanceEvent()

void onDisturbanceEvent ( DynamicVar  e )

override

onError()

void onError ( std::string  msg )

override

onLocalDomainInit()

void onLocalDomainInit ( )

override

onLocalDomainProcessingUnitInit()

void onLocalDomainProcessingUnitInit ( )

override

onLocalDomainProcessingUnitShutdown()

void onLocalDomainProcessingUnitShutdown ( )

override

onLocalDomainShutdown()

void onLocalDomainShutdown ( )

override

onOutputStep()

void onOutputStep ( )

override

onPostDisturbanceEvent()

void onPostDisturbanceEvent ( )

override

onPostDisturbanceEvent2()

void onPostDisturbanceEvent2 ( )

override

onPostNotification()

void onPostNotification ( short  preMessageSignal )

override

onPrePostDisturbanceEvent()

void onPrePostDisturbanceEvent ( )

override

onPreTimingSequence()

void onPreTimingSequence ( )

override

onSystemInit()

void onSystemInit ( )

override

onSystemShutdown()

void onSystemShutdown ( )

override

onTimingEndStep()

void onTimingEndStep ( )

override

onTimingInit()

void onTimingInit ( )

override

onTimingPostInit()

void onTimingPostInit ( )

override

onTimingPostInit2()

void onTimingPostInit2 ( )

override

onTimingPostStep()

void onTimingPostStep ( )

override

onTimingPreEndStep()

void onTimingPreEndStep ( )

override

onTimingPrePostInit()

void onTimingPrePostInit ( )

override

onTimingShutdown()

void onTimingShutdown ( )

override

onTimingStep()

void onTimingStep ( )

override

raiseModuleError() [1/3]

void raiseModuleError ( boost::exception &  e )

private

raiseModuleError() [2/3]

void raiseModuleError ( moja::Exception &  e )

private

raiseModuleError() [3/3]

void raiseModuleError ( std::exception &  e )

private

---

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

• /home/runner/work/moja.canada/moja.canada/Source/moja.modules.cbm/include/moja/modules/cbm/cbmmodulebase.h