CArrayElementReference Class Reference

#include <CArrayElementReference.h>

Inheritance diagram for CArrayElementReference:

List of all members.

Public Member Functions
	CArrayElementReference (const std::string &index, const CCopasiContainer *pParent)
virtual	~CArrayElementReference ()
virtual void *	getValuePointer () const
virtual const CCopasiObject *	getValueObject () const
virtual void	print (std::ostream *ostream) const
virtual std::string	getObjectDisplayName (bool regular=true, bool richtext=false) const
virtual CCopasiObjectName	getCN () const

---

Detailed Description

Class CArrayElementReference

This class is used to make an element of an array accessible as a CCopasiObject. Usually an object from this class will be a child of a CArrayAnnotation and will reference a single element of the array that the CArrayAnnotation points to.

---

Constructor & Destructor Documentation

CArrayElementReference::CArrayElementReference	(	const std::string &	index,
		const CCopasiContainer *	pParent
	)

create an element reference with a given index. The index is passed as a string, e.g. "[3][2]" The object name will be the index string, the type is "ElementReference" pParent may not be NULL.

virtual CArrayElementReference::~CArrayElementReference

(

)

[inline, virtual]

---

Member Function Documentation

CCopasiObjectName CArrayElementReference::getCN

(

)

const [virtual]

Reimplemented from CCopasiObject.

std::string CArrayElementReference::getObjectDisplayName	(	bool	regular = true,
		bool	richtext = false
	)		const [virtual]

generate a display name.

Reimplemented from CCopasiObject.

virtual const CCopasiObject* CArrayElementReference::getValueObject

(

)

const [inline, virtual]

Reimplemented from CCopasiObject.

void * CArrayElementReference::getValuePointer

(

)

const [virtual]

returns a pointer to the numerical values of the array element this will be a *C_FLOAT64 for this class.

Reimplemented from CCopasiObject.

void CArrayElementReference::print

(

std::ostream *

ostream

)

const [virtual]

This is the output method for any object. The default implementation provided with CCopasiObject uses the ostream operator<< of the object to print the object.To override this default behavior one needs to reimplement the virtual print function.

Parameters:

std::ostream

* ostream

Reimplemented from CCopasiObject.

---

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

• copasi/report/CArrayElementReference.h
• copasi/report/CArrayElementReference.cpp