SeapodymCohortAbstract Class Reference

Abstract class for a cohort object. Specific implementation must derive from this class and override its methods. More...

#include <SeapodymCohortAbstract.h>

Inheritance diagram for SeapodymCohortAbstract:

Public Member Functions
virtual void	stepForward (const dvar_vector &paramVector)=0
	Step forward.
virtual void	setStateFromArray (const std::vector< double > &array)=0
	Set state from array.
virtual std::vector< double >	getArrayFromState () const =0
	Serialize the state.
virtual void	save (const std::string &restartFile) const =0
	Save the current state to a file.

Detailed Description

Abstract class for a cohort object. Specific implementation must derive from this class and override its methods.

Member Function Documentation

getArrayFromState()

virtual std::vector< double > SeapodymCohortAbstract::getArrayFromState ( ) const

pure virtual

Serialize the state.

Returns

array serialization of the object's state

Implemented in SeapodymCohortFake.

save()

virtual void SeapodymCohortAbstract::save ( const std::string & restartFile ) const

pure virtual

Save the current state to a file.

Parameters

restartFile

Implemented in SeapodymCohortFake.

setStateFromArray()

virtual void SeapodymCohortAbstract::setStateFromArray ( const std::vector< double > & array )

pure virtual

Set state from array.

Parameters

array

serialization of the object's state

Implemented in SeapodymCohortFake.

stepForward()

virtual void SeapodymCohortAbstract::stepForward ( const dvar_vector & paramVector )

pure virtual

Step forward.

Parameters

paramVector

Implemented in SeapodymCohortFake.

---

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

• src/SeapodymCohortAbstract.h