COPASI API  4.40.278
CEventAssignment Class Reference

#include <CEvent.h>

Inheritance diagram for CEventAssignment:

Public Member Functions

virtual bool applyData (const CData &data, CUndoData::CChangeSet &changes)
 CEventAssignment (const CEventAssignment &src, const CDataContainer *pParent)
 CEventAssignment (const std::string &targetCN="", const CDataContainer *pParent=NO_PARENT)
CIssue compile (CObjectInterface::ContainerList listOfContainer)
virtual void createUndoData (CUndoData &undoData, const CUndoData::Type &type, const CData &oldData=CData(), const CCore::Framework &framework=CCore::Framework::ParticleNumbers) const
std::string getExpression () const
CExpressiongetExpressionPtr ()
const CExpressiongetExpressionPtr () const
const std::string & getKey () const
const std::string & getTargetCN () const
const CDataObjectgetTargetObject () const
bool operator!= (const CEventAssignment &rhs) const
bool setExpression (const std::string &expression)
bool setExpressionPtr (CExpression *pExpression)
virtual bool setObjectParent (const CDataContainer *pParent)
bool setTargetCN (const std::string &targetCN)
virtual CData toData () const
 ~CEventAssignment ()
- Public Member Functions inherited from CDataContainer
virtual bool add (CDataObject *pObject, const bool &adopt=true)
virtual bool appendDeletedDependentData (CUndoData &undoData) const
 CDataContainer (const CDataContainer &src, const CDataContainer *pParent)
 CDataContainer (const std::string &name, const CDataContainer *pParent=NO_PARENT, const std::string &type="CN", const CFlags< Flag > &flag=CFlags< Flag >::None)
virtual std::string getChildObjectUnits (const CDataObject *pObject) const
void getDescendants (CDataObject::DataObjectSet &descendants, const bool &recursive=false) const
virtual size_t getIndex (const CDataObject *pObject) const
virtual const CObjectInterfacegetObject (const CCommonName &cn) const override
virtual objectMapgetObjects ()
virtual const objectMapgetObjects () const
virtual const std::string getUnits () const override
virtual const CDataObjectgetValueObject () const override
virtual CUndoObjectInterfaceinsert (const CData &data) override
void objectRenamed (CDataObject *pObject, const std::string &oldName)
virtual bool remove (CDataObject *pObject)
virtual ~CDataContainer ()
- Public Member Functions inherited from CDataObject
void addIssue (const CIssue &issue)
void addReference (const CDataContainer *pReference)
virtual void calculateValue () override
 CDataObject (const CDataObject &src, const CDataContainer *pParent=NULL)
virtual void destruct () override
virtual CCommonName getCN () const override
virtual const CDataObjectgetDataObject () const override
CDataContainergetObjectAncestor (const std::string &type) const
CDataModelgetObjectDataModel () const
virtual std::string getObjectDisplayName () const override
const CObjectInterfacegetObjectFromCN (const CCommonName &cn) const
const std::string & getObjectName () const
CDataContainergetObjectParent () const
const std::string & getObjectType () const
virtual const CObjectInterface::ObjectSetgetPrerequisites () const override
virtual const CValiditygetValidity () const override
virtual void * getValuePointer () const override
bool hasFlag (const Flag &flag) const
virtual bool isPrerequisiteForContext (const CObjectInterface *pObject, const CCore::SimulationContextFlag &context, const CObjectInterface::ObjectSet &changedObjects) const override
bool prerequisitsContains (const DataObjectSet &objects) const
virtual void print (std::ostream *ostream) const override
void removeIssue (const CIssue &issue)
void removeReference (const CDataContainer *pReference)
bool setObjectName (const std::string &name)
void validityChanged (const CValidity &changedValidity) override
void validityRemoved (const CValidity &changedValidity)
virtual ~CDataObject ()
- Public Member Functions inherited from CObjectInterface
 CObjectInterface ()
 CObjectInterface (const CObjectInterface &src)
virtual ~CObjectInterface ()
- Public Member Functions inherited from CUndoObjectInterface
 CUndoObjectInterface ()
 CUndoObjectInterface (const CUndoObjectInterface &src)
bool generateUuid ()
const xg::Guid & getUuid () const
bool setUuid (const std::string &uuid)
bool setUuid (const xg::Guid &uuid)
virtual void updateIndex (const size_t &index, const CUndoObjectInterface *pUndoObject)
virtual ~CUndoObjectInterface ()

Static Public Member Functions

static CEventAssignmentfromData (const CData &data, CUndoObjectInterface *pParent)
- Static Public Member Functions inherited from CDataContainer
static CDataContainerfromData (const CData &data, CUndoObjectInterface *pParent)
- Static Public Member Functions inherited from CDataObject
static CDataObjectfromData (const CData &data, CUndoObjectInterface *pParent)
static void sanitizeObjectName (std::string &name)
- Static Public Member Functions inherited from CObjectInterface
static const CDataObjectDataObject (const CObjectInterface *pInterface)
static CObjectInterfaceGetObjectFromCN (const ContainerList &listOfContainer, const CCommonName &objName)
- Static Public Member Functions inherited from CUndoObjectInterface
template<class CType >
static CType * fromData (const CData &, CUndoObjectInterface *)

Private Attributes

std::string mKey
const CDataObjectmpTarget
CRegisteredCommonName mTargetCN

Additional Inherited Members

- Public Types inherited from CDataContainer
typedef CDataObjectMap objectMap
- Public Types inherited from CDataObject
typedef std::set< const CDataObject * > DataObjectSet
enum  Flag {
  Container , Vector , Matrix , NameVector ,
  Reference , ValueBool , ValueInt , ValueInt64 ,
  ValueDbl , NonUniqueName , StaticString , ValueString ,
  Separator , DisplayName , ModelEntity , Array ,
  DataModel , Root , Gui , __SIZE
- Public Types inherited from CObjectInterface
typedef std::vector< const CDataContainer * > ContainerList
typedef std::set< const CObjectInterface * > ObjectSet
- Static Public Attributes inherited from CDataContainer
static const CObjectInterface::ContainerList EmptyList
- Protected Member Functions inherited from CDataContainer
template<class CType >
CDataMatrixReference< CType > * addMatrixReference (const std::string &name, CType &reference, const CFlags< Flag > &flag=CFlags< Flag >::None)
template<class CType >
CDataObjectReference< CType > * addObjectReference (const std::string &name, CType &reference, const CFlags< Flag > &flag=CFlags< Flag >::None)
template<class CType >
CDataVectorReference< CType > * addVectorReference (const std::string &name, CType &reference, const CFlags< Flag > &flag=CFlags< Flag >::None)
 CDataContainer (const CDataContainer &src)
void initObjects ()
- Protected Member Functions inherited from CDataObject
 CDataObject ()
 CDataObject (const std::string &name, const CDataContainer *pParent=static_cast< CDataContainer * >((void *) 0), const std::string &type="CN", const CFlags< Flag > &flag=CFlags< Flag >::None)
- Protected Attributes inherited from CDataContainer
objectMap mObjects
- Protected Attributes inherited from CDataObject
ObjectSet mPrerequisits
std::set< CDataContainer * > mReferences
- Protected Attributes inherited from CObjectInterface
CValidity mValidity

Constructor & Destructor Documentation

◆ CEventAssignment() [1/2]

CEventAssignment::CEventAssignment ( const std::string &  targetCN = "",
const CDataContainer pParent = NO_PARENT 

Default constructor

conststd::string & targetCN (default: "")
"constCDataContainer * pParent (default: NULL)

Even though this constuctor usually expects the CN of a target, it will also work with a key

References CKeyFactory::get(), CDataObject::getCN(), CRootContainer::getKeyFactory(), CModelEntity::getValueObject(), mpModel, mTargetCN, CModel::setCompileFlag(), and CDataObject::setObjectName().

Referenced by fromData().

◆ CEventAssignment() [2/2]

CEventAssignment::CEventAssignment ( const CEventAssignment src,
const CDataContainer pParent 

Copy constructor

const CEventAssignment &src
"constCDataContainer * pParent (default: NULL)

References getExpression(), mpModel, CModel::setCompileFlag(), and setExpression().

◆ ~CEventAssignment()

CEventAssignment::~CEventAssignment ( )


References mpExpression, mpModel, pdelete, and CModel::setCompileFlag().

Member Function Documentation

◆ applyData()

bool CEventAssignment::applyData ( const CData data,
CUndoData::CChangeSet changes 

◆ compile()

◆ createUndoData()

void CEventAssignment::createUndoData ( CUndoData undoData,
const CUndoData::Type type,
const CData oldData = CData(),
const CCore::Framework framework = CCore::Framework::ParticleNumbers 
) const

Create the undo data which represents the changes recording the differences between the provided oldData and the current data.

CUndoData& undoData
constCUndoData::Type & type
constCData & oldData (default: empty data)
constCCore::Framework & framework (default: CCore::Framework::ParticleNumbers)
CUndoData undoData

Reimplemented from CDataContainer.

References CUndoData::addProperty(), CUndoData::CHANGE, CDataContainer::createUndoData(), CData::EXPRESSION, getExpression(), CData::getProperty(), getTargetCN(), and CData::OBJECT_REFERENCE_CN.

◆ fromData()

CEventAssignment * CEventAssignment::fromData ( const CData data,
CUndoObjectInterface pParent 

Static method to create a CDataObject based on the provided data

constCData & data
CEventAssignment * pDataObject

References CEventAssignment(), CData::getProperty(), NO_PARENT, CData::OBJECT_NAME, and CDataValue::toString().

◆ getExpression()

std::string CEventAssignment::getExpression ( ) const

◆ getExpressionPtr() [1/2]

CExpression * CEventAssignment::getExpressionPtr ( )

Retrieve the pointer to the expression.

CExpression * pExpression

References mpExpression, and CExpression::updateInfix().

◆ getExpressionPtr() [2/2]

◆ getKey()

const std::string & CEventAssignment::getKey ( ) const

Retrieve the key

const std::string & key

Reimplemented from CDataObject.

References mKey.

◆ getTargetCN()

const std::string & CEventAssignment::getTargetCN ( ) const

Retrieve the target CN

const std::string & targetCN

References mTargetCN.

Referenced by compile(), createUndoData(), CModelExpansion::duplicateEvent(), operator!=(), setTargetCN(), and toData().

◆ getTargetObject()

const CDataObject * CEventAssignment::getTargetObject ( ) const

Retrieve a pointer to the target object.

const CDataObject * targetObject

References mpTarget.

Referenced by CMathEvent::CAssignment::compile(), CEvent::getOriginFor(), and CModelExpansion::replaceInEvent().

◆ operator!=()

bool CEventAssignment::operator!= ( const CEventAssignment rhs) const

Comparison operator

constCEventAssignment & rhs
bool notEqual

References getExpression(), and getTargetCN().

◆ setExpression()

bool CEventAssignment::setExpression ( const std::string &  expression)

Set the expression from an infix string. The return value indicates if parsing the expression was successful.

conststd::string & expression
bool success

References CEvaluationTree::getInfix(), mpExpression, mpModel, CModel::setCompileFlag(), and CExpression::setInfix().

Referenced by applyData(), CEventAssignment(), CModelAdd::copyEventAssignmentExpression(), CModel::createEventsForTimeseries(), CModelExpansion::duplicateEvent(), and AssignmentHandler::processEnd().

◆ setExpressionPtr()

bool CEventAssignment::setExpressionPtr ( CExpression pExpression)

Set the expression from an expression pointer. CEventAssignment takes ownership.

bool success

References CDataContainer::add(), CExpression::compile(), mpExpression, mpModel, pdelete, CDataContainer::remove(), CModel::setCompileFlag(), CDataObject::setObjectName(), and CDataObject::setObjectParent().

Referenced by SBMLImporter::importEvent().

◆ setObjectParent()

bool CEventAssignment::setObjectParent ( const CDataContainer pParent)

Set the object parent

constCDataContainer * pParent
bool success

Reimplemented from CDataObject.

References CDataObject::getObjectAncestor(), CDataObject::getObjectParent(), mpModel, CModel::setCompileFlag(), and CDataObject::setObjectParent().

◆ setTargetCN()

bool CEventAssignment::setTargetCN ( const std::string &  targetCN)

Set the CN of the target

conststd::string & targetCN
bool success;

References getTargetCN(), mpModel, mTargetCN, CModel::setCompileFlag(), and CDataObject::setObjectName().

Referenced by applyData(), compile(), and CModelExpansion::replaceInEvent().

◆ toData()

CData CEventAssignment::toData ( ) const

Retrieve the data describing the object

CData data

Reimplemented from CDataContainer.

References CData::addProperty(), CData::EXPRESSION, getExpression(), getTargetCN(), CData::OBJECT_REFERENCE_CN, and CDataContainer::toData().

Member Data Documentation

◆ mKey

std::string CEventAssignment::mKey

The key

Referenced by getKey().

◆ mpExpression

CExpression* CEventAssignment::mpExpression

The expression to calculate the new value

Referenced by compile(), getExpression(), getExpressionPtr(), setExpression(), setExpressionPtr(), and ~CEventAssignment().

◆ mpModel

CModel* CEventAssignment::mpModel

◆ mpTarget

const CDataObject* CEventAssignment::mpTarget

The target object

Referenced by compile(), and getTargetObject().

◆ mTargetCN

CRegisteredCommonName CEventAssignment::mTargetCN

target object CN

Referenced by CEventAssignment(), getTargetCN(), and setTargetCN().

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