#include <CModelValue.h>

Inheritance diagram for CModelValue:

Public Member Functions
virtual bool	applyData (const CData &data, CUndoData::CChangeSet &changes)

	CModelValue (const CModelValue &src, const CDataContainer *pParent)

	CModelValue (const std::string &name="NoName", const CDataContainer *pParent=NO_PARENT)

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

virtual const std::string	getUnits () const

virtual CData	toData () const

	~CModelValue ()

Public Member Functions inherited from CModelEntity
virtual void	calculate ()

	CModelEntity (const CModelEntity &src, const CDataContainer *pParent)

	CModelEntity (const std::string &name="NoName", const CDataContainer *pParent=NO_PARENT, const std::string &type="ModelEntity", const CFlags< Flag > &flag=CFlags< Flag >::None)

virtual CIssue	compile ()

virtual std::string	getChildObjectUnits (const CDataObject *pObject) const override

std::string	getDefaultNoiseExpression () const

std::string	getExpression () const

CExpression *	getExpressionPtr ()

const CExpression *	getExpressionPtr () const

std::string	getInitialExpression () const

CExpression *	getInitialExpressionPtr ()

const CExpression *	getInitialExpressionPtr () const

const C_FLOAT64 &	getInitialValue () const

CDataObject *	getInitialValueReference () const

virtual const std::string &	getKey () const override

CModel *	getModel () const

std::string	getNoiseExpression () const

CExpression *	getNoiseExpressionPtr ()

const CExpression *	getNoiseExpressionPtr () const

CDataObject *	getNoiseReference () const

const C_FLOAT64 &	getRate () const

CDataObject *	getRateReference () const

const std::string &	getSBMLId () const

const CModelEntity::Status &	getStatus () const

virtual const std::string &	getUnitExpression () const

const C_FLOAT64 &	getValue () const

virtual const CDataObject *	getValueObject () const override

virtual void *	getValuePointer () const override

CDataObject *	getValueReference () const

const bool &	hasNoise () const

bool	isFixed () const

const bool &	isUsed () const

CIssue	setExpression (const std::string &expression)

bool	setExpressionPtr (CExpression *pExpression)

void	setHasNoise (const bool &hasNoise)

CIssue	setInitialExpression (const std::string &expression)

bool	setInitialExpressionPtr (CExpression *pExpression)

virtual void	setInitialValue (const C_FLOAT64 &initialValue)

bool	setNoiseExpression (const std::string &expression)

bool	setNoiseExpressionPtr (CExpression *pExpression)

virtual bool	setObjectParent (const CDataContainer *pParent) override

void	setRate (const C_FLOAT64 &rate)

void	setSBMLId (const std::string &id) const

bool	setStatus (const CModelEntity::Status &status)

virtual CIssue	setUnitExpression (std::string unitExpression)

void	setUsed (const bool &used)

virtual void	setValue (const C_FLOAT64 &value)

	~CModelEntity ()

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)

void	getDescendants (CDataObject::DataObjectSet &descendants, const bool &recursive=false) const

virtual size_t	getIndex (const CDataObject *pObject) const

virtual const CObjectInterface *	getObject (const CCommonName &cn) const override

virtual objectMap &	getObjects ()

virtual const objectMap &	getObjects () const

virtual CUndoObjectInterface *	insert (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 CDataObject *	getDataObject () const override

CDataContainer *	getObjectAncestor (const std::string &type) const

CDataModel *	getObjectDataModel () const

virtual std::string	getObjectDisplayName () const override

const CObjectInterface *	getObjectFromCN (const CCommonName &cn) const

const std::string &	getObjectName () const

CDataContainer *	getObjectParent () const

const std::string &	getObjectType () const

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

virtual const CValidity &	getValidity () 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 ()

Public Member Functions inherited from CAnnotation
bool	addUnsupportedAnnotation (const std::string &name, const std::string &xml)

bool	applyData (const CData &data, CUndoData::CChangeSet &changes)

	CAnnotation ()

	CAnnotation (const CAnnotation &src)

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

const std::string &	getMiriamAnnotation () const

const std::string &	getNotes () const

UnsupportedAnnotation &	getUnsupportedAnnotations ()

const UnsupportedAnnotation &	getUnsupportedAnnotations () const

void	initMiriamAnnotation (const std::string &newId)

bool	operator== (const CAnnotation &rhs) const

bool	removeUnsupportedAnnotation (const std::string &name)

bool	replaceUnsupportedAnnotation (const std::string &name, const std::string &xml)

void	setMiriamAnnotation (const std::string &miriamAnnotation, const std::string &newId, const std::string &oldId)

void	setNotes (const std::string &notes)

CData	toData () const

virtual	~CAnnotation ()

Static Public Member Functions
static CModelValue *	fromData (const CData &data, CUndoObjectInterface *pParent)

Static Public Member Functions inherited from CModelEntity
static CModelEntity *	fromData (const CData &data, CUndoObjectInterface *pParent)

Static Public Member Functions inherited from CDataContainer
static CDataContainer *	fromData (const CData &data, CUndoObjectInterface *pParent)

Static Public Member Functions inherited from CDataObject
static CDataObject *	fromData (const CData &data, CUndoObjectInterface *pParent)

static void	sanitizeObjectName (std::string &name)

Static Public Member Functions inherited from CObjectInterface
static const CDataObject *	DataObject (const CObjectInterface *pInterface)

static CObjectInterface *	GetObjectFromCN (const ContainerList &listOfContainer, const CCommonName &objName)

Static Public Member Functions inherited from CUndoObjectInterface
template<class CType >
static CType *	fromData (const CData &, CUndoObjectInterface *)

Static Public Member Functions inherited from CAnnotation
static CMIRIAMInfo *	allocateMiriamInfo (CDataContainer *pParent)

static CAnnotation *	castObject (CDataObject *pObject)

static const CAnnotation *	castObject (const CDataObject *pObject)

static void	freeMiriamInfo (CDataContainer *pParent)

Private Member Functions
void	initObjects ()

Friends
std::ostream &	operator<< (std::ostream &os, const CModelValue &d)

Additional Inherited Members
Public Types inherited from CModelEntity
enum class	Status { FIXED = 0 , ASSIGNMENT , REACTIONS , ODE , TIME , __SIZE }

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

Public Types inherited from CAnnotation
typedef std::map< std::string, std::string >	UnsupportedAnnotation

Static Public Attributes inherited from CModelEntity
static const CEnumAnnotation< std::string, Status >	StatusName

static const CEnumAnnotation< std::string, Status >	XMLStatus

Static Public Attributes inherited from CDataContainer
static const CObjectInterface::ContainerList	EmptyList

Protected Member Functions inherited from CModelEntity
	CModelEntity (const CModelEntity &src)

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 CModelEntity
bool	mHasNoise

C_FLOAT64	mIValue

C_FLOAT64	mNoise

CExpression *	mpExpression

CExpression *	mpInitialExpression

CDataObjectReference< C_FLOAT64 > *	mpIValueReference

CModel *	mpModel

CExpression *	mpNoiseExpression

CDataObjectReference< C_FLOAT64 > *	mpNoiseReference

CDataObjectReference< C_FLOAT64 > *	mpRateReference

CDataObjectReference< C_FLOAT64 > *	mpValueReference

C_FLOAT64	mRate

std::string	mSBMLId

std::string	mUnitExpression

C_FLOAT64	mValue

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

Protected Attributes inherited from CAnnotation
std::string	mKey

Detailed Description

CModelValue represents an entity in the model that has a value but is not a concentration (like species) or a volume (like compartments). It correspondents to global parameters in SBML

Constructor & Destructor Documentation

◆ CModelValue() [1/2]

CModelValue::CModelValue	(	const std::string &	name = `"NoName"`,
		const CDataContainer *	pParent = `NO_PARENT`
	)

Default constructor

Parameters

const	std::string & name (default: "NoName")
const	CDataContainer * pParent (default: NULL)

References CONSTRUCTOR_TRACE, and initObjects().

Referenced by fromData().

◆ CModelValue() [2/2]

CModelValue::CModelValue	(	const CModelValue &	src,
		const CDataContainer *	pParent
	)

Copy constructor

Parameters

const	CModelValue & src
const	CDataContainer * pParent (default: NULL)

References CONSTRUCTOR_TRACE, and initObjects().

◆ ~CModelValue()

CModelValue::~CModelValue ( )

Destructor.

References DESTRUCTOR_TRACE.

Member Function Documentation

◆ applyData()

bool CModelValue::applyData	(	const CData &	data,
		CUndoData::CChangeSet &	changes
	)

virtual

Apply the provided data to the object

Parameters

const CData & data

Returns: bool success

Reimplemented from CModelEntity.

References CModelEntity::applyData(), CData::getProperty(), CData::isSetProperty(), CModelEntity::setUnitExpression(), CDataValue::toString(), and CData::UNIT.

◆ createUndoData()

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

virtual

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

Parameters

CUndoData	& undoData
const	CUndoData::Type & type
const	CData & oldData (default: empty data)
const	CCore::Framework & framework (default: CCore::Framework::ParticleNumbers)

Returns: CUndoData undoData

Reimplemented from CModelEntity.

References CUndoData::addProperty(), CUndoData::CHANGE, CModelEntity::createUndoData(), CData::getProperty(), CModelEntity::mUnitExpression, and CData::UNIT.

◆ fromData()

CModelValue * CModelValue::fromData	(	const CData &	data,
		CUndoObjectInterface *	pParent
	)

static

Static method to create a CDataObject based on the provided data

Parameters

const CData & data

Returns: CModelValue * pDataObject

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

◆ getUnits()

const std::string CModelValue::getUnits ( ) const

virtual

Retrieve the units of the object.

Returns: std::string units

Reimplemented from CDataContainer.

References CModelEntity::mUnitExpression.

◆ initObjects()

void CModelValue::initObjects ( )

private

Initialize the contained CDataObjects

Referenced by CModelValue().

◆ toData()

CData CModelValue::toData ( ) const

virtual

Retrieve the data describing the object

Returns: CData data

Reimplemented from CModelEntity.

References CData::addProperty(), CModelEntity::mUnitExpression, CModelEntity::toData(), and CData::UNIT.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	os,
		const CModelValue &	d
	)

friend

insert operator

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CModelValue() [1/2]

◆ CModelValue() [2/2]

◆ ~CModelValue()

Member Function Documentation

◆ applyData()

◆ createUndoData()

◆ fromData()

◆ getUnits()

◆ initObjects()

◆ toData()

Friends And Related Function Documentation

◆ operator<<