CFunctionParameterMap Class Reference

#include <CCallParameters.h>

List of all members.

Public Member Functions
	CFunctionParameterMap ()
	CFunctionParameterMap (const CFunctionParameterMap &src)
	~CFunctionParameterMap ()
void	setCallParameter (const std::string paramName, const CCopasiObject *obj)
void	addCallParameter (const std::string paramName, const CCopasiObject *obj)
void	removeCallParameter (const std::string paramName, const CCopasiObject *obj)
void	clearCallParameter (const std::string paramName)
void	initializeFromFunctionParameters (const CFunctionParameters &src)
unsigned C_INT32	findParameterByName (const std::string &name, CFunctionParameter::DataType &dataType) const
const CFunctionParameters &	getFunctionParameters () const
CCallParameters< C_FLOAT64 > &	getPointers ()
CCallParameters< CCopasiObject > &	getObjects ()
const CCallParameters < CCopasiObject > &	getObjects () const
std::vector< const CCopasiObject * >	getObjects (const unsigned C_INT32 &index) const

---

Detailed Description

CFunctionParameterMap

This class describes how a reaction fills the call parameters of a function. It is generated from a CFunctionParameters object. The reaction provides what exactly is to be passed as function parameters.

---

Constructor & Destructor Documentation

CFunctionParameterMap::CFunctionParameterMap

(

)

CFunctionParameterMap::CFunctionParameterMap

(

const CFunctionParameterMap &

src

)

CFunctionParameterMap::~CFunctionParameterMap

(

)

Destructor();

---

Member Function Documentation

void CFunctionParameterMap::addCallParameter	(	const std::string	paramName,
		const CCopasiObject *	obj
	)

Adds an object to a specific parameter vector. Works only if the parameter is a vector

void CFunctionParameterMap::clearCallParameter

(

const std::string

paramName

)

Removes all objects from a specific parameter vector. Works only if the parameter is a vector.

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

const CFunctionParameters & CFunctionParameterMap::getFunctionParameters

(

)

const

CCallParameters<CCopasiObject>& CFunctionParameterMap::getObjects

(

)

const CCallParameters< CCopasiObject > & CFunctionParameterMap::getObjects

(

)

const

std::vector< const CCopasiObject * > CFunctionParameterMap::getObjects

(

const unsigned C_INT32 &

index

)

const

CCallParameters< C_FLOAT64 > & CFunctionParameterMap::getPointers

(

)

void CFunctionParameterMap::initializeFromFunctionParameters

(

const CFunctionParameters &

src

)

Initializes a CallParameters object from a CFunctionParameters object.

void CFunctionParameterMap::removeCallParameter	(	const std::string	paramName,
		const CCopasiObject *	obj
	)

Removes an object from a specific parameter vector. Works only if the parameter is a vector

void CFunctionParameterMap::setCallParameter	(	const std::string	paramName,
		const CCopasiObject *	obj
	)

Sets a specific parameter. Works only if the parameter is no vector

---

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

• copasi/function/CCallParameters.h
• copasi/function/CCallParameters.cpp