CCopasiContainer Class Reference

#include <CCopasiContainer.h>

Inheritance diagram for CCopasiContainer:

List of all members.

Public Types
typedef std::multimap< const std::string, CCopasiObject * >	objectMap
Public Member Functions
	CCopasiContainer (const std::string &name, const CCopasiContainer *pParent=NULL, const std::string &type="CN", const unsigned C_INT32 &flag=CCopasiObject::Container)
	CCopasiContainer (const CCopasiContainer &src, const CCopasiContainer *pParent=NULL)
virtual	~CCopasiContainer ()
virtual const CCopasiObject *	getObject (const CCopasiObjectName &cn) const
virtual const CCopasiObject *	getValueObject () const
virtual const objectMap &	getObjects () const
virtual bool	add (CCopasiObject *pObject, const bool &adopt=true)
virtual bool	remove (CCopasiObject *pObject)
virtual std::string	getUnits () const
virtual std::string	getChildObjectUnits (const CCopasiObject *pObject) const
Static Public Attributes
static const std::vector < CCopasiContainer * >	EmptyList
Protected Member Functions
void	initObjects ()
template<class CType >
CCopasiObject *	addObjectReference (const std::string &name, CType &reference, const unsigned C_INT32 &flag=0)
template<class CType >
CCopasiObject *	addVectorReference (const std::string &name, CType &reference, const unsigned C_INT32 &flag=0)
template<class CType >
CCopasiObject *	addMatrixReference (const std::string &name, CType &reference, const unsigned C_INT32 &flag=0)
Protected Attributes
objectMap	mObjects

---

Detailed Description

Class CCopasiContainer

This class is the is used to group CCopasiObjects logically. It inself is an object. Contained objects are still globally accessible.

Copyright Stefan Hoops 2002

---

Member Typedef Documentation

typedef std::multimap< const std::string, CCopasiObject * > CCopasiContainer::objectMap

---

Constructor & Destructor Documentation

CCopasiContainer::CCopasiContainer	(	const std::string &	name,
		const CCopasiContainer *	pParent = NULL,
		const std::string &	type = "CN",
		const unsigned C_INT32 &	flag = CCopasiObject::Container
	)

CCopasiContainer::CCopasiContainer	(	const CCopasiContainer &	src,
		const CCopasiContainer *	pParent = NULL
	)

CCopasiContainer::~CCopasiContainer

(

)

[virtual]

---

Member Function Documentation

bool CCopasiContainer::add	(	CCopasiObject *	pObject,
		const bool &	adopt = true
	)		[virtual]

template<class CType >

CCopasiObject* CCopasiContainer::addMatrixReference	(	const std::string &	name,
		CType &	reference,
		const unsigned C_INT32 &	flag = 0
	)		[inline, protected]

template<class CType >

CCopasiObject* CCopasiContainer::addObjectReference	(	const std::string &	name,
		CType &	reference,
		const unsigned C_INT32 &	flag = 0
	)		[inline, protected]

template<class CType >

CCopasiObject* CCopasiContainer::addVectorReference	(	const std::string &	name,
		CType &	reference,
		const unsigned C_INT32 &	flag = 0
	)		[inline, protected]

std::string CCopasiContainer::getChildObjectUnits

(

const CCopasiObject *

pObject

)

const [virtual]

Retrieve the units of the child object.

Returns:

std::string units

Reimplemented in CModel, CMetab, CReaction, and CCompartment.

const CCopasiObject * CCopasiContainer::getObject

(

const CCopasiObjectName &

cn

)

const [virtual]

Reimplemented from CCopasiObject.

Reimplemented in CCopasiVectorN< CType >, CCopasiVectorN< CEvaluationTree >, CCopasiVectorN< CReaction >, CCopasiVectorN< CEventAssignment >, CCopasiVectorN< CFunctionParameter >, CCopasiVectorN< CCopasiTask >, CCopasiVectorN< CPlotSpecification >, CCopasiVectorN< CCompartment >, CCopasiVectorN< CEvent >, CCopasiVectorN< CMetab >, CCopasiVectorN< CModelValue >, CCopasiVectorN< CReportDefinition >, CCopasiVector< CType >, CCopasiVector< CModification >, CCopasiVector< CLMetabGlyph >, CCopasiVector< CLCompartmentGlyph >, CCopasiVector< CEvaluationTree >, CCopasiVector< CReaction >, CCopasiVector< CSlider >, CCopasiVector< CRootFinder >, CCopasiVector< CBiologicalDescription >, CCopasiVector< CEventAssignment >, CCopasiVector< CReference >, CCopasiVector< CFunctionParameter >, CCopasiVector< CCopasiTask >, CCopasiVector< CLayout >, CCopasiVector< CPlotSpecification >, CCopasiVector< CLMetabReferenceGlyph >, CCopasiVector< CMoiety >, CCopasiVector< CCompartment >, CCopasiVector< CAssignment >, CCopasiVector< CChemEqElement >, CCopasiVector< CEvent >, CCopasiVector< CLReactionGlyph >, CCopasiVector< CMathEvent >, CCopasiVector< CMetab >, CCopasiVector< CModelValue >, CCopasiVector< CPlotItem >, CCopasiVector< CCopasiDataModel >, CCopasiVector< CFittingPoint >, CCopasiVector< CLTextGlyph >, CCopasiVector< CReportDefinition >, CCopasiVector< CCreator >, CCopasiVector< CMetabOld >, CCopasiVector< CLGraphicalObject >, and CArrayAnnotation.

const CCopasiContainer::objectMap & CCopasiContainer::getObjects

(

)

const [virtual]

std::string CCopasiContainer::getUnits

(

)

const [virtual]

Retrieve the units of the object.

Returns:

std::string units

Reimplemented from CCopasiObject.

const CCopasiObject * CCopasiContainer::getValueObject

(

)

const [virtual]

Reimplemented from CCopasiObject.

Reimplemented in CModelEntity, and CMetab.

void CCopasiContainer::initObjects

(

)

[protected]

Reimplemented in CFunctionDB, and CMathTrigger::CRootFinder.

bool CCopasiContainer::remove

(

CCopasiObject *

pObject

)

[virtual]

Reimplemented in CCopasiVector< CType >, CCopasiVector< CModification >, CCopasiVector< CLMetabGlyph >, CCopasiVector< CLCompartmentGlyph >, CCopasiVector< CEvaluationTree >, CCopasiVector< CReaction >, CCopasiVector< CSlider >, CCopasiVector< CRootFinder >, CCopasiVector< CBiologicalDescription >, CCopasiVector< CEventAssignment >, CCopasiVector< CReference >, CCopasiVector< CFunctionParameter >, CCopasiVector< CCopasiTask >, CCopasiVector< CLayout >, CCopasiVector< CPlotSpecification >, CCopasiVector< CLMetabReferenceGlyph >, CCopasiVector< CMoiety >, CCopasiVector< CCompartment >, CCopasiVector< CAssignment >, CCopasiVector< CChemEqElement >, CCopasiVector< CEvent >, CCopasiVector< CLReactionGlyph >, CCopasiVector< CMathEvent >, CCopasiVector< CMetab >, CCopasiVector< CModelValue >, CCopasiVector< CPlotItem >, CCopasiVector< CCopasiDataModel >, CCopasiVector< CFittingPoint >, CCopasiVector< CLTextGlyph >, CCopasiVector< CReportDefinition >, CCopasiVector< CCreator >, CCopasiVector< CMetabOld >, and CCopasiVector< CLGraphicalObject >.

---

Member Data Documentation

const std::vector< CCopasiContainer * > CCopasiContainer::EmptyList [static]

Class CCopasiContainer

This class is the is used to group CCopasiObjects logically. It inself is an object. Contained objects are still globally accessible.

Copyright Stefan Hoops 2002

objectMap CCopasiContainer::mObjects [protected]

---

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

• copasi/report/CCopasiContainer.h
• copasi/report/CCopasiContainer.cpp