COPASI API  4.16.103
Public Types | Public Member Functions | List of all members
CObjectInterface Class Referenceabstract

#include <CCopasiObject.h>

Inheritance diagram for CObjectInterface:
Inheritance graph
[legend]

Public Types

typedef std::set< const
CObjectInterface * > 
ObjectSet
 
typedef std::vector
< CObjectInterface * > 
UpdateSequence
 

Public Member Functions

 CObjectInterface ()
 
virtual CCopasiObjectName getCN () const =0
 
virtual const CObjectInterfacegetObject (const CCopasiObjectName &cn) const =0
 
virtual const
CObjectInterface::ObjectSet
getPrerequisites () const =0
 
virtual voidgetValuePointer () const =0
 
virtual bool isPrerequisiteForContext (const CObjectInterface *pObject, const CMath::SimulationContextFlag &context, const CObjectInterface::ObjectSet &changedObjects) const =0
 
virtual void print (std::ostream *ostream) const =0
 
virtual ~CObjectInterface ()
 

Detailed Description

Definition at line 154 of file CCopasiObject.h.

Member Typedef Documentation

typedef std::set< const CObjectInterface * > CObjectInterface::ObjectSet

Definition at line 157 of file CCopasiObject.h.

Definition at line 158 of file CCopasiObject.h.

Constructor & Destructor Documentation

CObjectInterface::CObjectInterface ( )
inline

Constructor

Definition at line 163 of file CCopasiObject.h.

163 {};
virtual CObjectInterface::~CObjectInterface ( )
inlinevirtual

Destructor

Definition at line 168 of file CCopasiObject.h.

168 {};

Member Function Documentation

virtual CCopasiObjectName CObjectInterface::getCN ( ) const
pure virtual
virtual const CObjectInterface* CObjectInterface::getObject ( const CCopasiObjectName cn) const
pure virtual

Retrieve a descendant object by its CN.

Parameters
constCCopasiObjectName & cn
Returns
const CObjectInterface * pObject

Implemented in CCopasiVectorN< CType >, CCopasiVectorN< CReaction >, CCopasiVectorN< CEventAssignment >, CCopasiVectorN< CFunctionParameter >, CCopasiVectorN< CCopasiTask >, CCopasiVectorN< CPlotSpecification >, CCopasiVectorN< CCompartment >, CCopasiVectorN< CModelParameterSet >, CCopasiVectorN< CEvent >, CCopasiVectorN< CMetab >, CCopasiVectorN< CFunction >, CCopasiVectorN< CModelValue >, CCopasiVectorN< CReportDefinition >, CCopasiVector< T >, CCopasiVector< CLGlobalRenderInformation >, CCopasiVector< CModification >, CCopasiVector< CLMetabGlyph >, CCopasiVector< CLCompartmentGlyph >, CCopasiVector< CLReferenceGlyph >, CCopasiVector< CSlider >, CCopasiVector< CBiologicalDescription >, CCopasiVector< CLGlobalStyle >, CCopasiVector< CEventAssignment >, CCopasiVector< CReference >, CCopasiVector< CMathEvent::CAssignment >, CCopasiVector< CLayout >, CCopasiVector< CLGradientStop >, CCopasiVector< CLMetabReferenceGlyph >, CCopasiVector< CMoiety >, CCopasiVector< CType >, CCopasiVector< CChemEqElement >, CCopasiVector< CLColorDefinition >, CCopasiVector< CLReactionGlyph >, CCopasiVector< CEvent >, CCopasiVector< CMathEvent >, CCopasiVector< CLGradientBase >, CCopasiVector< CLLocalRenderInformation >, CCopasiVector< CMetab >, CCopasiVector< CPlotItem >, CCopasiVector< CCopasiDataModel >, CCopasiVector< CLLineEnding >, CCopasiVector< CFittingPoint >, CCopasiVector< CLTextGlyph >, CCopasiVector< CCopasiObject >, CCopasiVector< CMathTrigger::CRootFinder >, CCopasiVector< CLLocalStyle >, CCopasiVector< CCreator >, CCopasiVector< CLGraphicalObject >, CCopasiVector< CMetabOld >, CCopasiVector< CLGeneralGlyph >, CCopasiObject, CReaction, CArrayAnnotation, CMathContainer, CCopasiParameterGroup, CCopasiContainer, and CMathObject.

Referenced by CMathDependencyGraph::exportDOTFormat(), and CCopasiContainer::getObject().

virtual const CObjectInterface::ObjectSet& CObjectInterface::getPrerequisites ( ) const
pure virtual

Retrieve the prerequisites, i.e., the objects which need to be evaluated before this.

Returns
const CObjectInterface::ObjectSet & prerequisites

Implemented in CCopasiObject, CParticleReference, CMathExpression, and CMathObject.

Referenced by CMathDependencyGraph::addObject().

virtual void* CObjectInterface::getValuePointer ( ) const
pure virtual
virtual bool CObjectInterface::isPrerequisiteForContext ( const CObjectInterface pObject,
const CMath::SimulationContextFlag context,
const CObjectInterface::ObjectSet changedObjects 
) const
pure virtual

Check whether a given object is a prerequisite for a context.

Parameters
constCObjectInterface * pObject
constCMath::SimulationContextFlag & context
constCObjectInterface::ObjectSet & changedObjects
Returns
bool isPrerequisiteForContext

Implemented in CCopasiObject, CParticleReference, CDependentNumberReference, CConcentrationReference, CMathObject, and CTotalNumberReference.

Referenced by CMathDependencyNode::updateDependentState(), and CMathDependencyNode::updatePrerequisiteState().

virtual void CObjectInterface::print ( std::ostream *  ostream) const
pure virtual

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