CCopasiVectorN< CType > Class Template Reference

#include <CCopasiVector.h>

Inheritance diagram for CCopasiVectorN< CType >:

List of all members.

Public Types
typedef std::vector< CType * > ::value_type	value_type
typedef std::vector< CType * > ::iterator	iterator
typedef std::vector< CType * > ::const_iterator	const_iterator
Public Member Functions
	CCopasiVectorN (const std::string &name="NoName", const CCopasiContainer *pParent=NULL)
	CCopasiVectorN (const CCopasiVectorN< CType > &src, const CCopasiContainer *pParent=NULL)
virtual	~CCopasiVectorN ()
CCopasiVectorN< CType > &	operator= (const std::vector< CType * > &rhs)
virtual bool	add (const CType &src)
virtual bool	add (CType *src, const bool &adopt=false)
virtual void	remove (const std::string &name)
value_type &	operator[] (const unsigned C_INT32 &index)
const value_type &	operator[] (const unsigned C_INT32 &index) const
value_type &	operator[] (const std::string &name)
const value_type &	operator[] (const std::string &name) const
virtual const CCopasiObject *	getObject (const CCopasiObjectName &name) const
virtual unsigned C_INT32	getIndex (const std::string &name) const

template<class CType>
class CCopasiVectorN< CType >

---

Member Typedef Documentation

template<class CType>

typedef std::vector< CType * >::const_iterator CCopasiVectorN< CType >::const_iterator

Reimplemented from CCopasiVector< CType >.

Reimplemented in CCopasiVectorNS< CType >, CCopasiVectorNS< CReaction >, CCopasiVectorNS< CFunctionParameter >, CCopasiVectorNS< CCompartment >, and CCopasiVectorNS< CMetab >.

template<class CType>

typedef std::vector< CType * >::iterator CCopasiVectorN< CType >::iterator

Reimplemented from CCopasiVector< CType >.

Reimplemented in CCopasiVectorNS< CType >, CCopasiVectorNS< CReaction >, CCopasiVectorNS< CFunctionParameter >, CCopasiVectorNS< CCompartment >, and CCopasiVectorNS< CMetab >.

template<class CType>

typedef std::vector< CType * >::value_type CCopasiVectorN< CType >::value_type

Reimplemented from CCopasiVector< CType >.

Reimplemented in CCopasiVectorNS< CType >, CCopasiVectorNS< CReaction >, CCopasiVectorNS< CFunctionParameter >, CCopasiVectorNS< CCompartment >, and CCopasiVectorNS< CMetab >.

---

Constructor & Destructor Documentation

template<class CType>

CCopasiVectorN< CType >::CCopasiVectorN	(	const std::string &	name = "NoName",
		const CCopasiContainer *	pParent = NULL
	)		[inline]

Default constructor

Parameters:

const	std::string & name (Default: "NoName")
const	CCopasiContainer * pParent (Default: NULL)

template<class CType>

CCopasiVectorN< CType >::CCopasiVectorN	(	const CCopasiVectorN< CType > &	src,
		const CCopasiContainer *	pParent = NULL
	)		[inline]

Copy constructor

Parameters:

const	CCopasiVectorN < CType > & src
const	CCopasiContainer * pParent (Default: NULL)

template<class CType>

virtual CCopasiVectorN< CType >::~CCopasiVectorN

(

)

[inline, virtual]

Destructor

---

Member Function Documentation

template<class CType>

virtual bool CCopasiVectorN< CType >::add

(

const CType &

src

)

[inline, virtual]

Add a copy of the object to the end of the vector.

Parameters:

const

CType & src

Returns:

bool success.

Reimplemented from CCopasiVector< CType >.

template<class CType>

virtual bool CCopasiVectorN< CType >::add	(	CType *	src,
		const bool &	adopt = false
	)		[inline, virtual]

Add an object to the end of the vector, if adobt is true the vector. becomes the parent of the object.

Parameters:

CType	* src
const	bool & adopt (Default: false)

Returns:

bool success

template<class CType>

virtual unsigned C_INT32 CCopasiVectorN< CType >::getIndex

(

const std::string &

name

)

const [inline, virtual]

Retrieve the index of the named object in the vector. If an object with the given name is not found C_INVALID_INDEX is returned.

Parameters:

const

std::string & name

Returns:

unsigned C_INT32 index

template<class CType>

virtual const CCopasiObject* CCopasiVectorN< CType >::getObject

(

const CCopasiObjectName &

name

)

const [inline, virtual]

Retrieve a pointer to the named object.

Parameters:

const

std::string & name

Returns:

const CCopasiObject * pObject

Reimplemented from CCopasiVector< CType >.

template<class CType>

CCopasiVectorN< CType >& CCopasiVectorN< CType >::operator=

(

const std::vector< CType * > &

rhs

)

[inline]

Assignment operator.

Parameters:

const

std::vector< CType * > & rhs

Returns:

CCopasiVectorN< CType > & lhs

Reimplemented from CCopasiVector< CType >.

template<class CType>

value_type& CCopasiVectorN< CType >::operator[]

(

const unsigned C_INT32 &

index

)

[inline]

Retrieve the indexed object.

Parameters:

const

unsigned C_INT32 & index

Returns:

value_type & object

Reimplemented from CCopasiVector< CType >.

template<class CType>

const value_type& CCopasiVectorN< CType >::operator[]

(

const unsigned C_INT32 &

index

)

const [inline]

Retrieve the indexed object.

Parameters:

const

unsigned C_INT32 & index

Returns:

const value_type & object

Reimplemented from CCopasiVector< CType >.

template<class CType>

value_type& CCopasiVectorN< CType >::operator[]

(

const std::string &

name

)

[inline]

Retrieve the named object.

Parameters:

const

std::string & name

Returns:

value_type & object

template<class CType>

const value_type& CCopasiVectorN< CType >::operator[]

(

const std::string &

name

)

const [inline]

Retrieve the named object.

Parameters:

const

std::string & name

Returns:

const value_type & object

template<class CType>

virtual void CCopasiVectorN< CType >::remove

(

const std::string &

name

)

[inline, virtual]

Remove the object with the given name from the vector.

Parameters:

const

std::string & name

---

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

• copasi/utilities/CCopasiVector.h