COPASI API  4.40.278
CObjectInterface Class Referenceabstract

#include <CObjectInterface.h>

Inheritance diagram for CObjectInterface:
[legend]

Public Types

typedef std::vector< const CDataContainer * > ContainerList
 
typedef std::set< const CObjectInterface * > ObjectSet
 

Public Member Functions

virtual void calculateValue ()=0
 
 CObjectInterface ()
 
 CObjectInterface (const CObjectInterface &src)
 
virtual CCommonName getCN () const =0
 
virtual const CDataObjectgetDataObject () const =0
 
virtual const CObjectInterfacegetObject (const CCommonName &cn) const =0
 
virtual std::string getObjectDisplayName () const =0
 
virtual const CObjectInterface::ObjectSetgetPrerequisites () const =0
 
virtual const CValiditygetValidity () const =0
 
virtual void * getValuePointer () const =0
 
virtual bool isPrerequisiteForContext (const CObjectInterface *pObject, const CCore::SimulationContextFlag &context, const CObjectInterface::ObjectSet &changedObjects) const =0
 
virtual void print (std::ostream *ostream) const =0
 
virtual void validityChanged (const CValidity &changedValidity)=0
 
virtual ~CObjectInterface ()
 

Static Public Member Functions

static const CDataObjectDataObject (const CObjectInterface *pInterface)
 
static CObjectInterfaceGetObjectFromCN (const ContainerList &listOfContainer, const CCommonName &objName)
 

Protected Attributes

CValidity mValidity
 

Member Typedef Documentation

◆ ContainerList

typedef std::vector< const CDataContainer * > CObjectInterface::ContainerList

◆ ObjectSet

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

Constructor & Destructor Documentation

◆ CObjectInterface() [1/2]

CObjectInterface::CObjectInterface ( )

Constructor

◆ CObjectInterface() [2/2]

CObjectInterface::CObjectInterface ( const CObjectInterface src)

Copy Constructor

◆ ~CObjectInterface()

CObjectInterface::~CObjectInterface ( )
virtual

Destructor

Member Function Documentation

◆ calculateValue()

virtual void CObjectInterface::calculateValue ( )
pure virtual

Calculate the objects value.

Implemented in COptProblem, COptItem, CMathObject, CCopasiTimer, and CDataObject.

Referenced by CMathContainer::applyUpdateSequence().

◆ DataObject()

const CDataObject * CObjectInterface::DataObject ( const CObjectInterface pInterface)
static

References getDataObject().

Referenced by CCopasiParameterGroup::applyData(), CSBMLExporter::checkForUnsupportedObjectReferences(), CModelParameter::compile(), CModelParameterReactionParameter::compile(), CEvaluationNodeObject::compile(), CEventAssignment::compile(), CTimeSeries::compile(), COptItem::compile(), CExperimentObjectMap::compile(), CSlider::compile(), CReaction::compileFunctionParameters(), COptItem::compileLowerBound(), COptItem::compileUpperBound(), CMathContainer::copyBranch(), CDataArray::createDisplayName(), CDerive::deriveBranch(), SBMLImporter::doMapping(), CModelExpansion::duplicateEvent(), CSBMLExporter::exportEventAssignments(), CODEExporter::exportExpression(), CSEDMLExporter::exportPlotItem(), CSEDMLExporter::exportReport(), CSBMLExporter::findModelEntityDependencies(), CExperimentObjectMap::CDataColumn::getDefaultScale(), CMathDependencyGraph::getDOTNodeId(), CModelExpansion::ElementsMap::getDuplicateFromCN(), CEvaluationNodeObject::getMMLString(), COptItem::getObjectDisplayName(), COptItem::getStartValue(), CSensItem::getVariablesPointerList(), CSBMLExporter::hasVolumeAssignment(), SBMLImporter::isConstantFlux(), CSBMLExporter::isEventSBMLCompatible(), SBMLImporter::isMassActionExpression(), CODEExporter::isModelEntityExpressionODEExporterCompatible(), CSlider::isValid(), CEvaluationNodeObject::mapObject(), CReportDefinition::preCompileTable(), CTimeSensMethod::printUpdateSeq(), SBMLImporter::renameMassActionParameters(), CSBMLExporter::replace_local_parameters(), CSBMLExporter::replaceSpeciesReferences(), CReaction::resolveCN(), CSBMLExporter::restore_local_parameters(), SBMLImporter::setCorrectUsage(), SBMLImporter::setInitialValues(), COptItem::setObjectCN(), CReaction::setParameterCNs(), CEvaluationNodeObject::toAST(), CModelParameter::updateModel(), CArrayElementReference::updateObjectName(), and CReaction::variable2object().

◆ getCN()

virtual CCommonName CObjectInterface::getCN ( ) const
pure virtual

◆ getDataObject()

virtual const CDataObject* CObjectInterface::getDataObject ( ) const
pure virtual

◆ getObject()

virtual const CObjectInterface* CObjectInterface::getObject ( const CCommonName cn) const
pure virtual

Retrieve a descendant object by its CN.

Parameters
constCCommonName & cn
Returns
const CObjectInterface * pObject

Implemented in CDataVectorN< CType >, CDataVectorN< CEventAssignment >, CDataVectorN< CCopasiTask >, CDataVectorN< CLayout >, CDataVectorN< CUnitDefinition >, CDataVectorN< CPlotSpecification >, CDataVectorN< CModelParameterSet >, CDataVectorN< CEvent >, CDataVectorN< CFunction >, CDataVectorN< CModelValue >, CDataVectorN< CReportDefinition >, CDataVector< CType >, CDataVector< CLGlobalRenderInformation >, CDataVector< CModification >, CDataVector< CLMetabGlyph >, CDataVector< CLCompartmentGlyph >, CDataVector< CSlider >, CDataVector< CLReferenceGlyph >, CDataVector< CBiologicalDescription >, CDataVector< CLGlobalStyle >, CDataVector< CReference >, CDataVector< CLGradientStop >, CDataVector< CMoiety >, CDataVector< CLMetabReferenceGlyph >, CDataVector< CDataModel >, CDataVector< CChemEqElement >, CDataVector< CEvent >, CDataVector< CLReactionGlyph >, CDataVector< CLColorDefinition >, CDataVector< CMetab >, CDataVector< CLLocalRenderInformation >, CDataVector< CLGradientBase >, CDataVector< CPlotItem >, CDataVector< CDataObject >, CDataVector< CLTextGlyph >, CDataVector< CLLineEnding >, CDataVector< CFittingPoint >, CDataVector< CLLocalStyle >, CDataVector< CCreator >, CDataVector< CLGeneralGlyph >, CDataVector< CLGraphicalObject >, CMathObject, CDataObject, CDataContainer, CCopasiParameterGroup, CReaction, CMathContainer, and CDataArray.

Referenced by CScanItem::CScanItem(), CMathDependencyGraph::exportDOTFormat(), CExpression::getNodeObject(), CDataContainer::getObject(), and GetObjectFromCN().

◆ getObjectDisplayName()

virtual std::string CObjectInterface::getObjectDisplayName ( ) const
pure virtual

◆ GetObjectFromCN()

◆ getPrerequisites()

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 CMathObject, CMathExpression, and CDataObject.

Referenced by CMathDependencyGraph::addObject(), and COptProblem::initialize().

◆ getValidity()

virtual const CValidity& CObjectInterface::getValidity ( ) const
pure virtual

Get the aggregation of any issues associated with this object

Returns
const CValidity & validity

Implemented in CMathObject, and CDataObject.

◆ getValuePointer()

◆ isPrerequisiteForContext()

virtual bool CObjectInterface::isPrerequisiteForContext ( const CObjectInterface pObject,
const CCore::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 CMathObject, CDataObject, CDependentNumberReference, and CTotalNumberReference.

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

◆ print()

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

◆ validityChanged()

virtual void CObjectInterface::validityChanged ( const CValidity changedValidity)
pure virtual

This method is called whenever the validity object changes.

Parameters
constCValidity & changedValidity

Implemented in CMathObject, and CDataObject.

Referenced by CValidity::add(), CValidity::clear(), CValidity::operator=(), CValidity::operator|=(), and CValidity::remove().

Member Data Documentation

◆ mValidity


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