#include <CFunctionParameter.h>

Inheritance diagram for CFunctionParameter:

Public Types
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
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
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
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

Private Attributes
bool	mIsUsed

std::string	mKey

CFunctionParameter::DataType	mType

Role	mUsage

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

Additional Inherited Members
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

Detailed Description

CFunctionParameter

Created for Copasi by Stefan Hoops (C) Stefan Hoops 2001

Member Enumeration Documentation

◆ DataType

enum CFunctionParameter::DataType

strong

Valid data type for a function parameter

Enumerator
INT32
FLOAT64
VINT32
VFLOAT64
__SIZE

◆ Role

enum CFunctionParameter::Role

strong

Enumerator
SUBSTRATE
PRODUCT
MODIFIER
PARAMETER
VOLUME
TIME
VARIABLE
TEMPORARY
__SIZE

Constructor & Destructor Documentation

◆ CFunctionParameter() [1/3]

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

Default constructor

Parameters

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

Referenced by fromData().

◆ CFunctionParameter() [2/3]

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

Copy constructor

Parameters

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

◆ CFunctionParameter() [3/3]

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

Specified constructor, sets all member values at once

Parameters

const string &	name
const CFunctionParameter::DataType &	type
const string &	usage
const	CDataContainer * pParent (default: NULL)

◆ ~CFunctionParameter()

CFunctionParameter::~CFunctionParameter ( )

virtual

Destructor

References CRootContainer::getKeyFactory(), mKey, and CKeyFactory::remove().

Member Function Documentation

◆ applyData()

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

virtual

Apply the provided data to the object

Parameters

const CData & data

Returns: bool success

Reimplemented from CDataContainer.

References CDataContainer::applyData(), DataTypeName, CData::getProperty(), CData::isSetProperty(), mIsUsed, mType, mUsage, CData::PARAMETER_ROLE, CData::PARAMETER_TYPE, CData::PARAMETER_USED, RoleNameXML, CDataValue::toBool(), CEnumAnnotation< Type, Enum >::toEnum(), and CDataValue::toString().

◆ cleanup()

void CFunctionParameter::cleanup ( )

Cleanup

◆ fromData()

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

static

Static method to create a CDataObject based on the provided data

Parameters

const CData & data

Returns: CDataObject * CFunctionParameter

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

◆ getKey()

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

virtual

Retrieves the key of the function parameter.

Returns: std::string name

Reimplemented from CDataObject.

References mKey.

Referenced by CCopasiXML::saveFunctionList().

◆ getType()

const CFunctionParameter::DataType & CFunctionParameter::getType ( ) const

Retrieves the data type of the parameter

Returns: "const CFunctionParameter::DataType" & type

References mType.

Referenced by CFunctionParameterMap::addCallParameter(), CFunctionParameterMap::clearCallParameter(), CReactionInterface::connectFromScratch(), CModel::convert2NonReversible(), CReaction::initializeParameterMapping(), CReaction::loadOld(), CReaction::loadOneRole(), SourceParameterHandler::processStart(), CFunctionParameterMap::setCallParameter(), CReaction::setFunctionFromExpressionTree(), CReaction::setParameterValue(), and CReaction::variable2object().

◆ getUsage()

CFunctionParameter::Role CFunctionParameter::getUsage ( ) const

Retrieves the usage of the parameter

Returns: "const string" & usage

References mUsage.

Referenced by CFunctionParameterMap::addCallParameter(), SBMLImporter::areEqualFunctions(), CModel::convert2NonReversible(), CModelParameterSet::createFromModel(), CSBMLExporter::createKineticLaw(), CReactionInterface::getDeletedParameters(), CCopasiXML::saveFunctionList(), CFunctionParameterMap::setCallParameter(), and CReaction::setFunctionFromExpressionTree().

◆ isUsed()

const bool & CFunctionParameter::isUsed ( ) const

Retrieve whether the parameter is used within a function

Returns: const bool & isUsed

References mIsUsed.

Referenced by setIsUsed().

◆ load()

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

virtual

Loads an object with data coming from a CReadConfig object. (CReadConfig object reads an input stream)

Parameters

pconfigbuffer reference to a CReadConfig object.

Returns: Fail

References CReadConfig::getVariable(), mType, mUsage, and CDataObject::setObjectName().

◆ setIsUsed()

void CFunctionParameter::setIsUsed ( const bool & isUsed )

Set whether the parameter is used within a function

Parameters

const bool & isUsed

References isUsed(), and mIsUsed.

Referenced by ParameterDescriptionHandler::processStart().

◆ setType()

void CFunctionParameter::setType ( const CFunctionParameter::DataType & type )

Sets the data type of the parameter

Parameters

const CFunctionParameter::DataType & type

References mType.

Referenced by CKinFunction::createParameters(), and ParameterDescriptionHandler::processStart().

◆ setUsage()

void CFunctionParameter::setUsage ( Role usage )

Sets the usage of the parameter

Parameters

const string & usage

References mUsage.

Referenced by CKinFunction::createParameters(), ParameterDescriptionHandler::processStart(), and SBMLImporter::setCorrectUsage().

◆ toData()

CData CFunctionParameter::toData ( ) const

virtual

Retrieve the data describing the object

Returns: CData data

Reimplemented from CDataContainer.

References CData::addProperty(), DataTypeName, mIsUsed, mType, mUsage, CData::PARAMETER_ROLE, CData::PARAMETER_TYPE, CData::PARAMETER_USED, RoleNameXML, and CDataContainer::toData().

Friends And Related Function Documentation

◆ operator<<

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

friend

insert operator

Member Data Documentation

◆ DataTypeName

const CEnumAnnotation< std::string, CFunctionParameter::DataType > CFunctionParameter::DataTypeName

static

Referenced by applyData(), and toData().

◆ mIsUsed

bool CFunctionParameter::mIsUsed

private

Specifies whether the parameter is used in the function

Referenced by applyData(), isUsed(), setIsUsed(), and toData().

◆ mKey

std::string CFunctionParameter::mKey

private

The key of the function parameter

Referenced by getKey(), and ~CFunctionParameter().

◆ mType

CFunctionParameter::DataType CFunctionParameter::mType

private

The data type of the parameter this may be one of INT16, INT32, UINT16, UINT32, FLOAT32, FLOAT64, VINT16, VINT32, VUINT16, VUINT32, VFLOAT32, VFLOAT64

Referenced by applyData(), getType(), load(), setType(), and toData().

◆ mUsage

Role CFunctionParameter::mUsage

private

The usage or meaning of the parameter. This has no functional implication for CFunction but it might be used in derived classes. Possible usage is SUBSTRATE, PRODUCT, MODIFIER, or PARAMETER

Referenced by applyData(), getUsage(), load(), setUsage(), and toData().

◆ RoleNameDisplay

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

static

Referenced by CFunctionParameters::getParameterByUsage().

◆ RoleNameXML

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

static

The string representation of valid roles of a function parameter

CFunctionParameter

Created for COPASI by Stefan Hoops (C) Stefan Hoops 2001

Referenced by applyData(), ParameterDescriptionHandler::processStart(), CCopasiXML::saveFunctionList(), and toData().

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ DataType

◆ Role

Constructor & Destructor Documentation

◆ CFunctionParameter() [1/3]

◆ CFunctionParameter() [2/3]

◆ CFunctionParameter() [3/3]

◆ ~CFunctionParameter()

Member Function Documentation

◆ applyData()

◆ cleanup()

◆ fromData()

◆ getKey()

◆ getType()

◆ getUsage()

◆ isUsed()

◆ load()

◆ setIsUsed()

◆ setType()

◆ setUsage()

◆ toData()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ DataTypeName

◆ mIsUsed

◆ mKey

◆ mType

◆ mUsage

◆ RoleNameDisplay

◆ RoleNameXML