CFunctionParameters Class Reference

#include <CFunctionParameters.h>

Inheritance diagram for CFunctionParameters:

List of all members.

Public Member Functions
	CFunctionParameters (const std::string &name="NoName", const CCopasiContainer *pParent=NULL)
	CFunctionParameters (const CFunctionParameters &src, const CCopasiContainer *pParent=NULL)
	~CFunctionParameters ()
void	cleanup ()
CFunctionParameters &	operator= (const CFunctionParameters &src)
void	add (const CFunctionParameter &parameter)
bool	add (CFunctionParameter *parameter, const bool &adopt=false)
bool	add (const std::string &name, const CFunctionParameter::DataType &type, CFunctionParameter::Role usage)
void	remove (const std::string &name)
CFunctionParameter *	operator[] (unsigned C_INT32 index)
const CFunctionParameter *	operator[] (unsigned C_INT32 index) const
CFunctionParameter *	operator[] (const std::string &name)
const CFunctionParameter *	operator[] (const std::string &name) const
unsigned C_INT32	size () const
void	swap (const unsigned C_INT32 &from, const unsigned C_INT32 &to)
bool	isVector (CFunctionParameter::Role role) const
const CFunctionParameter *	getParameterByUsage (CFunctionParameter::Role usage, unsigned C_INT32 &pos) const
unsigned C_INT32	getNumberOfParametersByUsage (CFunctionParameter::Role usage) const
unsigned C_INT32	findParameterByName (const std::string &name, CFunctionParameter::DataType &dataType) const
bool	operator== (const CFunctionParameters &rhs) const
Friends
std::ostream &	operator<< (std::ostream &os, const CFunctionParameters &d)

---

Detailed Description

CFunctionParameters

Created for Copasi by Stefan Hoops (C) Stefan Hoops 2001 :pos 10.7176,6.51973

---

Constructor & Destructor Documentation

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

Default constructor

Parameters:

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

CFunctionParameters

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

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

Copy constructor

Parameters:

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

CFunctionParameters::~CFunctionParameters

(

)

Destructor

---

Member Function Documentation

void CFunctionParameters::add

(

const CFunctionParameter &

parameter

)

Add a parameter to the parameter list

Parameters:

const CFunctionParameter &

parameter

bool CFunctionParameters::add	(	CFunctionParameter *	parameter,
		const bool &	adopt = false
	)

Add a parameter to the parameter list

Parameters:

CFunctionParameter *	parameter
const	bool & adopt (Default: false)

Returns:

bool success

bool CFunctionParameters::add	(	const std::string &	name,
		const CFunctionParameter::DataType &	type,
		CFunctionParameter::Role	usage
	)

Add a parameter to the parameter list

Parameters:

"const	string & name
const CFunctionParameter::DataType &	type
const string &	usage

Returns:

bool success

void CFunctionParameters::cleanup

(

)

Cleanup

unsigned C_INT32 CFunctionParameters::findParameterByName	(	const std::string &	name,
		CFunctionParameter::DataType &	dataType
	)		const

find a parameter by its name and return its index

unsigned C_INT32 CFunctionParameters::getNumberOfParametersByUsage

(

CFunctionParameter::Role

usage

)

const

gets the number of Parameters with a specific usage

const CFunctionParameter * CFunctionParameters::getParameterByUsage	(	CFunctionParameter::Role	usage,
		unsigned C_INT32 &	pos
	)		const

Retrieves the first parameter with the specified usage after pos In a normal situation pos is set to 0 for the first call. It is increment by the method to allow subsequent searches to start after the last found item. This is usefull if several parameters with the same usage exist.

Parameters:

const string &	usage
unsigned C_INT32 &	pos (first call should be with 0)

Returns:

"CFunctionParameter &" usageRange

bool CFunctionParameters::isVector

(

CFunctionParameter::Role

role

)

const

tells whether there is a parameter with vector type and the given role (if there is one it is assumed it is the only one with this role)

CFunctionParameters & CFunctionParameters::operator=

(

const CFunctionParameters &

src

)

Assignment operator. Performs deep copy.

bool CFunctionParameters::operator==

(

const CFunctionParameters &

rhs

)

const

CFunctionParameter * CFunctionParameters::operator[]

(

unsigned C_INT32

index

)

const CFunctionParameter * CFunctionParameters::operator[]

(

unsigned C_INT32

index

)

const

CFunctionParameter * CFunctionParameters::operator[]

(

const std::string &

name

)

const CFunctionParameter * CFunctionParameters::operator[]

(

const std::string &

name

)

const

void CFunctionParameters::remove

(

const std::string &

name

)

Remove a parameter from the parameter list

Parameters:

const CFunctionParameter &

parameter

unsigned C_INT32 CFunctionParameters::size

(

)

const

number of parameters

void CFunctionParameters::swap	(	const unsigned C_INT32 &	from,
		const unsigned C_INT32 &	to
	)

Swap parameters

Parameters:

const	unsigned C_INT32 & from
const	unsigned C_INT32 & to

---

Friends And Related Function Documentation

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

insert operator

---

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

• copasi/function/CFunctionParameters.h
• copasi/function/CFunctionParameters.cpp