#include <CReactionParameter.h>

Inheritance diagram for CReactionParameter:

Private Member Functions
bool	addObject (const CDataObject *object)

	CReactionParameter ()

	CReactionParameter (const CReactionParameter &src) CReactionParameter(const CFunctionParameter &base) ~CReactionParameter() void setValue()

const std::vector< CRegisteredCommonName > &	getCNs () const

const std::vector< const CDataObject * > &	getObjects (const size_t &index) const

const C_FLOAT64 &	getValue () const

bool	isLocal () const

bool	setCNs (const std::vector< CRegisteredCommonName > &CNs)

bool	setObject (const CDataObject *object)

bool	setObjects (const std::vector< const CDataObject * > &objects)

Private Attributes
std::vector< CRegisteredCommonName >	mCNs

std::vector< C_FLOAT64 >	mLocalValues

std::vector< const CDataObject * >	mObjects

std::vector< C_FLOAT64 * >	mValuePointers

Additional Inherited Members
Public Types inherited from CFunctionParameter
enum class	DataType { INT32 , FLOAT64 , VINT32 , VFLOAT64 , __SIZE }

enum class	Role { SUBSTRATE , PRODUCT , MODIFIER , PARAMETER , VOLUME , TIME , VARIABLE , TEMPORARY , __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 Member Functions inherited from CFunctionParameter
virtual bool	applyData (const CData &data, CUndoData::CChangeSet &changes)

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

	CFunctionParameter (const std::string &name, const DataType &type, Role usage, const CDataContainer *pParent=NO_PARENT)

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

void	cleanup ()

virtual const std::string &	getKey () const

const CFunctionParameter::DataType &	getType () const

Role	getUsage () const

const bool &	isUsed () const

virtual void	load (CReadConfig &configbuffer, CReadConfig::Mode mode=CReadConfig::NEXT)

void	setIsUsed (const bool &isUsed)

void	setType (const CFunctionParameter::DataType &type)

void	setUsage (Role usage)

virtual CData	toData () const

virtual	~CFunctionParameter ()

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 void	createUndoData (CUndoData &undoData, const CUndoData::Type &type, const CData &oldData=CData(), const CCore::Framework &framework=CCore::Framework::ParticleNumbers) const override

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 CObjectInterface *	getObject (const CCommonName &cn) const override

virtual objectMap &	getObjects ()

virtual const objectMap &	getObjects () const

virtual const std::string	getUnits () const override

virtual const CDataObject *	getValueObject () const override

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

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)

virtual bool	setObjectParent (const CDataContainer *pParent)

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 inherited from CFunctionParameter
static CFunctionParameter *	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 Attributes inherited from CFunctionParameter
static const CEnumAnnotation< std::string, DataType >	DataTypeName

static const CEnumAnnotation< std::string, Role >	RoleNameDisplay

static const CEnumAnnotation< std::string, Role >	RoleNameXML

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

◆ CReactionParameter() [1/2]

CReactionParameter::CReactionParameter ( )

private

◆ CReactionParameter() [2/2]

CReactionParameter::CReactionParameter ( const CReactionParameter & src ) const &

private

Member Function Documentation

◆ addObject()

bool CReactionParameter::addObject ( const CDataObject * object )

private

◆ getCNs()

const std::vector< CRegisteredCommonName >& CReactionParameter::getCNs ( ) const

private

◆ getObjects()

const std::vector< const CDataObject * >& CReactionParameter::getObjects ( const size_t & index ) const

private

◆ getValue()

const C_FLOAT64& CReactionParameter::getValue ( ) const

private

◆ isLocal()

bool CReactionParameter::isLocal ( ) const

private

◆ setCNs()

bool CReactionParameter::setCNs ( const std::vector< CRegisteredCommonName > & CNs )

private

◆ setObject()

bool CReactionParameter::setObject ( const CDataObject * object )

private

◆ setObjects()

bool CReactionParameter::setObjects ( const std::vector< const CDataObject * > & objects )

private

Member Data Documentation

◆ mCNs

std::vector< CRegisteredCommonName > CReactionParameter::mCNs

private

◆ mLocalValues

std::vector< C_FLOAT64 > CReactionParameter::mLocalValues

private

◆ mObjects

std::vector< const CDataObject * > CReactionParameter::mObjects

private

◆ mValuePointers

std::vector< C_FLOAT64 * > CReactionParameter::mValuePointers

private

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

CReactionParameter.h

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ CReactionParameter() [1/2]

◆ CReactionParameter() [2/2]

Member Function Documentation

◆ addObject()

◆ getCNs()

◆ getObjects()

◆ getValue()

◆ isLocal()

◆ setCNs()

◆ setObject()

◆ setObjects()

Member Data Documentation

◆ mCNs

◆ mLocalValues

◆ mObjects

◆ mValuePointers