abstract) base class for all simulation system state compartments More...

Inherits object_t.

Inherited by ldndc::substate_airchemistry_t, ldndc::substate_microclimate_t, ldndc::substate_physiology_t, ldndc::substate_soilchemistry_t, ldndc::substate_surfacebulk_t, and ldndc::substate_watercycle_t.

Public Member Functions
virtual lerr_t	initialize (cbm::io_kcomm_t , void =NULL)=0
	assigns dynamically allocated substate class members a memory area using offset given to this function More...

virtual size_t	member_cnt () const =0
	return number of substate container entities

virtual size_t	alloc_size () const =0
	returns the size of memory a substate needs to store its dynamically allocated objects (note that this is not allowed to change during program run)

virtual lerr_t	resize_entities (cbm::io_kcomm_t *)=0
	resize substate container entities

Static Public Attributes
static cbm::string_t	wr_type = "parameter"
	substate base class implementation, sources factories More...

Protected Member Functions
void	set_initialized ()
	sets initialization state to true (successful initialization (this has to be done by substate itself) More...

Detailed Description

abstract) base class for all simulation system state compartments

Member Function Documentation

◆ initialize()

virtual lerr_t ldndc::MoBiLE_Substate::initialize	(	cbm::io_kcomm_t *	,
		void *	= `NULL`
	)

pure virtual

assigns dynamically allocated substate class members a memory area using offset given to this function

Parameters

memory offset in state memory pool

◆ set_initialized()

ldndc::MoBiLE_Substate::set_initialized ( )

inlineprotected

sets initialization state to true (successful initialization (this has to be done by substate itself)

substates initialization status. if initialization succeeded the state should be set by calling

Note: for now this cannot be reset. currently, initialization occurs only once so this seems ok ;-)

Returns: true, if initialization succeeded. false, if it did not succeed or initialize was not called prior to calling

         {
             is_initialized_ = true;
         }

Member Data Documentation

◆ wr_type

cbm::string_t ldndc::MoBiLE_Substate::wr_type = "parameter"

static

substate base class implementation, sources factories

Author: edwin haas, steffen klatt

Public Member Functions