CStateTemplate Class Reference

#include <CState.h>

List of all members.

Public Member Functions
	CStateTemplate (CModel &model, CState &initialState, CState &currentState)
	~CStateTemplate ()
void	add (CModelEntity *entity)
void	remove (CModelEntity *entity)
unsigned C_INT32	getIndex (const CModelEntity *entity) const
void	reorder (const CVector< CModelEntity * > &newOrder)
void	setUserOrder (const CVector< CModelEntity * > &userOrder)
const CVector< unsigned C_INT32 > &	getUserOrder () const
CModelEntity **	getEntities ()
CModelEntity **	beginIndependent ()
CModelEntity **	endIndependent ()
CModelEntity **	beginDependent ()
CModelEntity **	endDependent ()
CModelEntity **	beginFixed ()
CModelEntity **	endFixed ()
CModelEntity *const *	getEntities () const
CModelEntity *const *	beginIndependent () const
CModelEntity *const *	endIndependent () const
CModelEntity *const *	beginDependent () const
CModelEntity *const *	endDependent () const
CModelEntity *const *	beginFixed () const
CModelEntity *const *	endFixed () const
unsigned C_INT32	getNumIndependent () const
unsigned C_INT32	getNumDependent () const
unsigned C_INT32	getNumVariable () const
unsigned C_INT32	getNumFixed () const
const unsigned C_INT32 &	size () const
Protected Member Functions
void	resize ()

---

Constructor & Destructor Documentation

CStateTemplate::CStateTemplate	(	CModel &	model,
		CState &	initialState,
		CState &	currentState
	)

Specific constructor

Parameters:

CModel	& model
CState	& initialState
CState	& currentState

CStateTemplate::~CStateTemplate

(

)

Destructor

---

Member Function Documentation

void CStateTemplate::add

(

CModelEntity *

entity

)

Add an entity to the template.

Parameters:

CModelEntity

* entity

CModelEntity ** CStateTemplate::beginDependent

(

)

Retrieve the array of pointers to all dependent entities, which are only dependent species for a reduced model.

Returns:

CModelEntities ** dependentEntities

CModelEntity *const * CStateTemplate::beginDependent

(

)

const

Retrieve the array of pointers to all dependent entities, which are only dependent species for a reduced model.

Returns:

CModelEntities *const* dependentEntities

CModelEntity ** CStateTemplate::beginFixed

(

)

Retrieve the array of pointers to all fixed entities.

Returns:

CModelEntities ** fixedEntities

CModelEntity *const * CStateTemplate::beginFixed

(

)

const

Retrieve the array of pointers to all fixed entities.

Returns:

CModelEntities *const* fixedEntities

CModelEntity ** CStateTemplate::beginIndependent

(

)

Retrieve the array of pointers to all independent entities.

Returns:

CModelEntities ** independentEntities

CModelEntity *const * CStateTemplate::beginIndependent

(

)

const

Retrieve the array of pointers to all independent entities.

Returns:

CModelEntities *const* independentEntities

CModelEntity ** CStateTemplate::endDependent

(

)

Retrieve pointer just beyond the dependent entities.

Returns:

CModelEntities ** endDependentEntities

CModelEntity *const * CStateTemplate::endDependent

(

)

const

Retrieve pointer just beyond the dependent entities.

Returns:

CModelEntities ** endDependentEntities

CModelEntity ** CStateTemplate::endFixed

(

)

Retrieve pointer just beyond the fixed entities.

Returns:

CModelEntities ** endFixedEntities

CModelEntity *const * CStateTemplate::endFixed

(

)

const

Retrieve pointer just beyond the fixed entities.

Returns:

CModelEntities *const* endFixedEntities

CModelEntity ** CStateTemplate::endIndependent

(

)

Retrieve pointer just beyond the independent entities.

Returns:

CModelEntities ** endIndependentEntities

CModelEntity *const * CStateTemplate::endIndependent

(

)

const

Retrieve pointer just beyond the independent entities.

Returns:

CModelEntities *const* endIndependentEntities

CModelEntity ** CStateTemplate::getEntities

(

)

Retrieve the array of pointers to all entities.

Returns:

CModelEntities ** entities

CModelEntity *const * CStateTemplate::getEntities

(

)

const

Retrieve the array of pointers to all entities.

Returns:

CModelEntities *const* entities

unsigned C_INT32 CStateTemplate::getIndex

(

const CModelEntity *

entity

)

const

Retrieve the index of an entity in the template. Returns C_INVALID_INDEX if the entity is not found.

Parameters:

const

CModelEntity * entity

Returns:

unsigned C_INT32 index

unsigned C_INT32 CStateTemplate::getNumDependent

(

)

const

Retrieve the number of dependent entities.

Returns:

unsigned C_INT32 numDependent

unsigned C_INT32 CStateTemplate::getNumFixed

(

)

const

Retrieve the number of fixed entities.

Returns:

unsigned C_INT32 numFixed

unsigned C_INT32 CStateTemplate::getNumIndependent

(

)

const

Retrieve the number of independent entities.

Returns:

unsigned C_INT32 numIndependent

unsigned C_INT32 CStateTemplate::getNumVariable

(

)

const

Retrieve the number of variable entities, i.e., the sum of independent and dependent variables.

Returns:

unsigned C_INT32 numVariable

const CVector< unsigned C_INT32 > & CStateTemplate::getUserOrder

(

)

const

Retrieve a pivot vector which can be used to reconstruct the user order.

Returns:

const CVector<unsigned C_INT32> & userOrder

void CStateTemplate::remove

(

CModelEntity *

entity

)

Remove an entity from the template.

Parameters:

CModelEntity

* entity

void CStateTemplate::reorder

(

const CVector< CModelEntity * > &

newOrder

)

Reorder the template.

Parameters:

const

CVector< CModelEntity * > & newOrder

void CStateTemplate::resize

(

)

[protected]

Resize the template

void CStateTemplate::setUserOrder

(

const CVector< CModelEntity * > &

userOrder

)

Set the user preferred order of the entities.

Parameters:

const

CVector< CModelEntity * > & userOrder

const unsigned C_INT32 & CStateTemplate::size

(

)

const

Retrieve size of the template, i.e., the number of entities.

Returns:

unsigned C_INT32 size

---

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

• copasi/model/CState.h
• copasi/model/CState.cpp