COPASI API  4.40.278
CFunctionParameter Class Reference

#include <CFunctionParameter.h>

Inheritance diagram for CFunctionParameter:
[legend]

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::DataTypegetType () 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 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)
 
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 CFunctionParameterfromData (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 *)
 

Static Public Attributes

static const CEnumAnnotation< std::string, DataTypeDataTypeName
 
static const CEnumAnnotation< std::string, RoleRoleNameDisplay
 
static const CEnumAnnotation< std::string, RoleRoleNameXML
 
- 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

Valid data type for a function parameter

Enumerator
INT32 
FLOAT64 
VINT32 
VFLOAT64 
__SIZE 

◆ Role

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
conststd::string & name (default: "NoName")
constCDataContainer * pParent (default: NULL)

Referenced by fromData().

◆ CFunctionParameter() [2/3]

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

Copy constructor

Parameters
const CFunctionParameter& src
constCDataContainer * 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
constCDataContainer * pParent (default: NULL)

◆ ~CFunctionParameter()

CFunctionParameter::~CFunctionParameter ( )
virtual

Member Function Documentation

◆ applyData()

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

◆ 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
constCData & 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()

◆ getUsage()

◆ 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
pconfigbufferreference 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
constbool & 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

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

◆ 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: