CFunctionAnalyzer Class Reference

#include <CFunctionAnalyzer.h>

List of all members.

Classes
class	CValue
class	Result
Public Types
enum	Mode { NOOBJECT, GENERAL, POSITIVE, ACTUAL }
Public Member Functions
void	checkKineticFunction (const CFunction *f, const CReaction *reaction=NULL)
	CFunctionAnalyzer (const CFunction *f, const CReaction *reaction=NULL)
const Result &	getResult () const
Static Public Member Functions
static CValue	evaluateNode (const CEvaluationNode *node, const std::vector< CValue > &callParameters, Mode mode)
static void	constructCallParameters (const CFunctionParameters &fp, std::vector< CValue > &callParameters, bool posi)
static std::string	write (int level, bool rt, const std::string &text, const std::string &longText)
Static Protected Member Functions
static void	constructCallParametersActualValues (std::vector< CValue > &callParameters, const CReaction *reaction)
Protected Attributes
Result	mResult

---

Detailed Description

This class performs an analysis of a kinetic function. The function to analyze is passed to the constructor. The result can be retrieved with the getResult() method. The Result class has methods for reporting. The reporting methods may assume that the function (and possibly the reaction) still exists, so don't delete the function between the analysis and the reporting of the results!

---

Member Enumeration Documentation

enum CFunctionAnalyzer::Mode

Mode tells how to interpret an object in CValue arithmetics. NOOBJECT means objects are invalid (e.g. for functions, where no object nodes should occur). GENERAL means concentrations and volumes are positive, all other values positive, zero, or negative. POSITIVE means all objects are positive. ACTUAL means the actual value is used for local parameters and constant values.

Enumerator:

NOOBJECT
GENERAL
POSITIVE
ACTUAL

---

Constructor & Destructor Documentation

CFunctionAnalyzer::CFunctionAnalyzer	(	const CFunction *	f,
		const CReaction *	reaction = NULL
	)		[inline]

---

Member Function Documentation

void CFunctionAnalyzer::checkKineticFunction	(	const CFunction *	f,
		const CReaction *	reaction = NULL
	)

void CFunctionAnalyzer::constructCallParameters	(	const CFunctionParameters &	fp,
		std::vector< CValue > &	callParameters,
		bool	posi
	)		[static]

constructs call parameters for use with the evaluateNode() method

void CFunctionAnalyzer::constructCallParametersActualValues	(	std::vector< CValue > &	callParameters,
		const CReaction *	reaction
	)		[static, protected]

constructs call parameters for use with the evaluateNode() method, using the actual values for local parameters and fixed entities.

CFunctionAnalyzer::CValue CFunctionAnalyzer::evaluateNode	(	const CEvaluationNode *	node,
		const std::vector< CValue > &	callParameters,
		Mode	mode
	)		[static]

Do the CValue arithmetics of a tree. The callParameters contain the CValues corresponding to the CEvaluationNodeVariable nodes. The value of mode should not have an effect if this is called for a function tree.

const Result& CFunctionAnalyzer::getResult

(

)

const [inline]

std::string CFunctionAnalyzer::write	(	int	level,
		bool	rt,
		const std::string &	text,
		const std::string &	longText
	)		[static]

---

Member Data Documentation

Result CFunctionAnalyzer::mResult [protected]

---

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

• copasi/function/CFunctionAnalyzer.h
• copasi/function/CFunctionAnalyzer.cpp