CFunctionParameter Class Reference

#include <CFunctionParameter.h>

Inheritance diagram for CFunctionParameter:

List of all members.

Public Types
enum	Role {   SUBSTRATE = 0, PRODUCT, MODIFIER, PARAMETER,   VOLUME, TIME, VARIABLE, TEMPORARY }
enum	DataType { INT32 = 0, FLOAT64, VINT32, VFLOAT64 }
Public Member Functions
	CFunctionParameter (const std::string &name="NoName", const CCopasiContainer *pParent=NULL)
	CFunctionParameter (const CFunctionParameter &src, const CCopasiContainer *pParent=NULL)
	CFunctionParameter (const std::string &name, const DataType &type, Role usage, const CCopasiContainer *pParent=NULL)
virtual	~CFunctionParameter ()
void	cleanup ()
virtual void	load (CReadConfig &configbuffer, CReadConfig::Mode mode=CReadConfig::NEXT)
virtual const std::string &	getKey () const
const CFunctionParameter::DataType &	getType () const
void	setType (const CFunctionParameter::DataType &type)
Role	getUsage () const
void	setUsage (Role usage)
void	setIsUsed (const bool &isUsed)
const bool &	isUsed () const
Static Public Member Functions
static Role	xmlRole2Enum (const std::string &role)
Static Public Attributes
static const std::string	DataTypeName []
static const std::string	RoleNameXML []
static const std::string	RoleNameDisplay []
Friends
std::ostream &	operator<< (std::ostream &os, const CFunctionParameter &d)

---

Detailed Description

CFunctionParameter

Created for Copasi by Stefan Hoops (C) Stefan Hoops 2001 :pos 15.1888,24.6765

---

Member Enumeration Documentation

enum CFunctionParameter::DataType

Valid data type for a function parameter

Enumerator:

INT32
FLOAT64
VINT32
VFLOAT64

enum CFunctionParameter::Role

Enumerator:

SUBSTRATE
PRODUCT
MODIFIER
PARAMETER
VOLUME
TIME
VARIABLE
TEMPORARY

---

Constructor & Destructor Documentation

CFunctionParameter::CFunctionParameter	(	const std::string &	name = "NoName",
		const CCopasiContainer *	pParent = NULL
	)

Default constructor

Parameters:

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

CFunctionParameter::CFunctionParameter	(	const CFunctionParameter &	src,
		const CCopasiContainer *	pParent = NULL
	)

Copy constructor

Parameters:

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

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

Specified constuctor, sets all member values at once

Parameters:

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

CFunctionParameter::~CFunctionParameter

(

)

[virtual]

Destructor

---

Member Function Documentation

void CFunctionParameter::cleanup

(

)

Cleanup

const std::string & CFunctionParameter::getKey

(

)

const [virtual]

Retrieves the key of the function parameter.

Returns:

std::string name

Reimplemented from CCopasiObject.

const CFunctionParameter::DataType & CFunctionParameter::getType

(

)

const

Retrieves the data type of the parameter

Returns:

"const CFunctionParameter::DataType" & type

CFunctionParameter::Role CFunctionParameter::getUsage

(

)

const

Retrieves the usage of the parameter

Returns:

"const string" & usage

const bool & CFunctionParameter::isUsed

(

)

const

Retrieve whether the parameter is used within a function

Returns:

const bool & isUsed

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

void CFunctionParameter::setIsUsed

(

const bool &

isUsed

)

Set whether the parameter is used within a function

Parameters:

const

bool & isUsed

void CFunctionParameter::setType

(

const CFunctionParameter::DataType &

type

)

Sets the data type of the parameter

Parameters:

const CFunctionParameter::DataType

& type

void CFunctionParameter::setUsage

(

Role

usage

)

Sets the usage of the parameter

Parameters:

const string

& usage

CFunctionParameter::Role CFunctionParameter::xmlRole2Enum

(

const std::string &

role

)

[static]

---

Friends And Related Function Documentation

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

insert operator

---

Member Data Documentation

const std::string CFunctionParameter::DataTypeName [static]

Initial value:

  {"Integer", "Double", "Vector of Integer", "Vector of Double", ""}

A string representation of the data type

CFunctionParameter

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

const std::string CFunctionParameter::RoleNameDisplay [static]

Initial value:

  {"Substrate", "Product", "Modifier", "Parameter", "Volume", "Time", "Variable", ""}

const std::string CFunctionParameter::RoleNameXML [static]

Initial value:

  {"substrate", "product", "modifier", "constant", "volume", "time", "variable", ""}

The string representation of valid roles of a function parameter

---

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

• copasi/function/CFunctionParameter.h
• copasi/function/CFunctionParameter.cpp