SeapodymCohortFake Class Reference

Inheritance diagram for SeapodymCohortFake:

Collaboration diagram for SeapodymCohortFake:

Public Member Functions
	SeapodymCohortFake (int milliseconds_step, std::size_t data_size, int id)
	Constructor.
	SeapodymCohortFake (const std::string &parFile, int id)
	Constructor.
	SeapodymCohortFake (const std::string &restartFile)
	Constructor.
	SeapodymCohortFake (const std::vector< double > &data, int id)
void	stepForward (const dvar_vector &paramVector)
	Step forward.
void	setStateFromArray (const std::vector< double > &array)
std::vector< double >	getArrayFromState () const
	Serialize the state.
void	save (const std::string &restartFile) const
	Save the current state to a file.

Constructor & Destructor Documentation

SeapodymCohortFake() [1/4]

SeapodymCohortFake::SeapodymCohortFake ( int milliseconds_step, std::size_t data_size, int id )

inline

Constructor.

Parameters

milliseconds_step	execution time for a single step
id	unique identifier of this cohort

SeapodymCohortFake() [2/4]

SeapodymCohortFake::SeapodymCohortFake	(	const std::string &	parFile,
		int	id )

Constructor.

Parameters

parFile	XML input file
id	unique identifier of this cohort (e.g. based on the date yyyymmdd of birth)

SeapodymCohortFake() [3/4]

SeapodymCohortFake::SeapodymCohortFake

(

const std::string &

restartFile

)

Constructor.

Parameters

restartFile

Restaret file

SeapodymCohortFake() [4/4]

SeapodymCohortFake::SeapodymCohortFake	(	const std::vector< double > &	data,
		int	id )

Constructor from other cohorts' spawning data

Parameters

data	serialized data
id	unique identifier of this cohort

Member Function Documentation

getArrayFromState()

std::vector< double > SeapodymCohortFake::getArrayFromState ( ) const

virtual

Serialize the state.

Returns

array serialization of the object's state

Implements SeapodymCohortAbstract.

save()

void SeapodymCohortFake::save ( const std::string & restartFile ) const

virtual

Save the current state to a file.

Parameters

restartFile

Implements SeapodymCohortAbstract.

setStateFromArray()

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

virtual

Set state from array

Parameters

array

serialization of the object's state

Implements SeapodymCohortAbstract.

stepForward()

void SeapodymCohortFake::stepForward ( const dvar_vector & paramVector )

virtual

Step forward.

Parameters

paramVector

Implements SeapodymCohortAbstract.

---

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

• src/SeapodymCohortFake.h
• src/SeapodymCohortFake.cpp