COPASI API  4.16.103
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
CCopasiVectorReference< CType > Class Template Reference

#include <CCopasiObject.h>

Inheritance diagram for CCopasiVectorReference< CType >:
Inheritance graph
Collaboration diagram for CCopasiVectorReference< CType >:
Collaboration graph

Public Types

typedef CType referenceType
- Public Types inherited from CCopasiObject
typedef std::set< const
CCopasiObject * > 
typedef std::vector< Refresh * > DataUpdateSequence
- Public Types inherited from CObjectInterface
typedef std::set< const
CObjectInterface * > 
typedef std::vector
< CObjectInterface * > 

Public Member Functions

 CCopasiVectorReference (const std::string &name, const CCopasiContainer *pParent, referenceType &reference, const unsigned C_INT32 &flag=0)
 CCopasiVectorReference (const CCopasiVectorReference< referenceType > &src, const CCopasiContainer *pParent)
virtual CCopasiObjectgetObject (const CCopasiObjectName &cn)
virtual const CCopasiObjectgetValueObject () const
virtual voidgetValuePointer () const
virtual void print (std::ostream *ostream) const
virtual ~CCopasiVectorReference ()
- Public Member Functions inherited from CCopasiObject
void addDirectDependency (const CCopasiObject *pObject)
 CCopasiObject (const CCopasiObject &src, const CCopasiContainer *pParent=NULL)
void clearDirectDependencies ()
void clearRefresh ()
bool dependsOn (DataObjectSet candidates, const DataObjectSet &context=DataObjectSet()) const
void getAllDependencies (DataObjectSet &dependencies, const DataObjectSet &context) const
virtual CCopasiObjectName getCN () const
virtual const DataObjectSetgetDirectDependencies (const DataObjectSet &context=DataObjectSet()) const
virtual const std::string & getKey () const
virtual const CObjectInterfacegetObject (const CCopasiObjectName &cn) const
CCopasiContainergetObjectAncestor (const std::string &type) const
CCopasiDataModelgetObjectDataModel ()
const CCopasiDataModelgetObjectDataModel () const
virtual std::string getObjectDisplayName (bool regular=true, bool richtext=false) const
const std::string & getObjectName () const
CCopasiContainergetObjectParent () const
const std::string & getObjectType () const
virtual const
getPrerequisites () const
virtual RefreshgetRefresh () const
virtual std::string getUnits () const
UpdateMethodgetUpdateMethod () const
bool hasCircularDependencies (DataObjectSet &candidates, DataObjectSet &verified, const DataObjectSet &context) const
bool hasUpdateMethod () const
bool isArray () const
bool isContainer () const
bool isDataModel () const
bool isMatrix () const
bool isNameVector () const
bool isNonUniqueName () const
virtual bool isPrerequisiteForContext (const CObjectInterface *pObject, const CMath::SimulationContextFlag &context, const CObjectInterface::ObjectSet &changedObjects) const
bool isReference () const
bool isRoot () const
bool isSeparator () const
bool isStaticString () const
bool isValueBool () const
bool isValueDbl () const
bool isValueInt () const
bool isValueInt64 () const
bool isValueString () const
bool isVector () const
virtual bool mustBeDeleted (const DataObjectSet &deletedObjects) const
void removeDirectDependency (const CCopasiObject *pObject)
void setDirectDependencies (const DataObjectSet &directDependencies)
bool setObjectName (const std::string &name)
virtual bool setObjectParent (const CCopasiContainer *pParent)
void setObjectValue (const C_FLOAT64 &value)
void setObjectValue (const C_INT32 &value)
void setObjectValue (const bool &value)
template<class CType >
void setRefresh (CType *pType, void(CType::*method)(void))
template<class CType >
void setUpdateMethod (CType *pType, void(CType::*method)(const C_FLOAT64 &))
template<class CType >
void setUpdateMethod (CType *pType, void(CType::*method)(const C_INT32 &))
template<class CType >
void setUpdateMethod (CType *pType, void(CType::*method)(const bool &))
virtual ~CCopasiObject ()
- Public Member Functions inherited from CObjectInterface
 CObjectInterface ()
virtual ~CObjectInterface ()

Private Member Functions

 CCopasiVectorReference ()

Private Attributes

CType & mReference

Additional Inherited Members

- Static Public Member Functions inherited from CCopasiObject
static std::vector< Refresh * > buildUpdateSequence (const DataObjectSet &objects, const DataObjectSet &uptoDateObjects, const DataObjectSet &context=DataObjectSet())
static void setRenameHandler (CRenameHandler *rh)
- Protected Types inherited from CCopasiObject
enum  Flag {
  Container = 0x1, Vector = 0x2, Matrix = 0x4, NameVector = 0x8,
  Reference = 0x10, ValueBool = 0x20, ValueInt = 0x40, ValueInt64 = 0x80,
  ValueDbl = 0x100, NonUniqueName = 0x200, StaticString = 0x400, ValueString = 0x800,
  Separator = 0x1000, ModelEntity = 0x2000, Array = 0x4000, DataModel = 0x8000,
  Root = 0x10000, Gui = 0x20000
- Protected Member Functions inherited from CCopasiObject
 CCopasiObject ()
 CCopasiObject (const std::string &name, const CCopasiContainer *pParent=NULL, const std::string &type="CN", const unsigned C_INT32 &flag=0)
- Static Protected Attributes inherited from CCopasiObject
static CRenameHandlersmpRenameHandler = NULL

Detailed Description

template<class CType>
class CCopasiVectorReference< CType >

Definition at line 44 of file CCopasiObject.h.

Member Typedef Documentation

template<class CType>
typedef CType CCopasiVectorReference< CType >::referenceType

Definition at line 166 of file CCopasiObjectReference.h.

Constructor & Destructor Documentation

template<class CType>
CCopasiVectorReference< CType >::CCopasiVectorReference ( )

Definition at line 174 of file CCopasiObjectReference.h.

174  :
175  mReference(CType())
176  {};
template<class CType>
CCopasiVectorReference< CType >::CCopasiVectorReference ( const std::string &  name,
const CCopasiContainer pParent,
referenceType reference,
const unsigned C_INT32 flag = 0 

Definition at line 179 of file CCopasiObjectReference.h.

182  :
183  CCopasiObject(name, pParent, "Reference",
186  flag),
187  mReference(reference)
188  {assert(pParent != NULL);}
long int flag
Definition: f2c.h:52
template<class CType>
CCopasiVectorReference< CType >::CCopasiVectorReference ( const CCopasiVectorReference< referenceType > &  src,
const CCopasiContainer pParent 

Definition at line 190 of file CCopasiObjectReference.h.

191  :
192  CCopasiObject(src, pParent),
194  {}
template<class CType>
virtual CCopasiVectorReference< CType >::~CCopasiVectorReference ( )

Definition at line 196 of file CCopasiObjectReference.h.

196 {}

Member Function Documentation

template<class CType>
virtual CCopasiObject* CCopasiVectorReference< CType >::getObject ( const CCopasiObjectName cn)

Definition at line 198 of file CCopasiObjectReference.h.

References CCopasiObject::getObjectName(), CCopasiObject::getObjectParent(), CCopasiObject::isValueBool(), CCopasiObject::isValueDbl(), CCopasiObject::isValueInt(), CCopasiVectorReference< CType >::mReference, CCopasiObject::ValueBool, CCopasiObject::ValueDbl, and CCopasiObject::ValueInt.

199  {
200 #ifdef WIN32
202 #else
204 #endif
205  (getObjectName() + cn,
206  getObjectParent(),
207  mReference[cn.getElementIndex()],
211  );
212  }
bool isValueInt() const
const std::string & getObjectName() const
bool isValueBool() const
bool isValueDbl() const
CCopasiContainer * getObjectParent() const
template<class CType>
virtual const CCopasiObject* CCopasiVectorReference< CType >::getValueObject ( ) const

Reimplemented from CCopasiObject.

Definition at line 215 of file CCopasiObjectReference.h.

215 {return this;}
template<class CType>
virtual void* CCopasiVectorReference< CType >::getValuePointer ( ) const

Retrieve a pointer to the value of the object

Reimplemented from CCopasiObject.

Definition at line 214 of file CCopasiObjectReference.h.

References CCopasiVectorReference< CType >::mReference.

214 {return &mReference;}
template<class CType>
virtual void CCopasiVectorReference< CType >::print ( std::ostream *  ostream) const

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.

std::ostream* ostream

Reimplemented from CCopasiObject.

Definition at line 224 of file CCopasiObjectReference.h.

References CCopasiVectorReference< CType >::mReference.

225  {*ostream << mReference;}

Member Data Documentation

template<class CType>
CType& CCopasiVectorReference< CType >::mReference

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