CEvaluationNodeCall Class Reference

#include <CEvaluationNodeCall.h>

Inheritance diagram for CEvaluationNodeCall:

List of all members.

Public Types
enum	SubType { INVALID = 0x00FFFFFF, FUNCTION = 0x00000000, EXPRESSION = 0x00000001 }
Public Member Functions
	CEvaluationNodeCall (const SubType &subType, const Data &data)
	CEvaluationNodeCall (const CEvaluationNodeCall &src)
virtual	~CEvaluationNodeCall ()
virtual const C_FLOAT64 &	value () const
virtual bool	compile (const CEvaluationTree *pTree)
bool	calls (std::set< std::string > &list) const
virtual std::string	getInfix () const
virtual std::string	getDisplayString (const CEvaluationTree *pTree) const
virtual std::string	getDisplay_C_String (const CEvaluationTree *pTree) const
virtual std::string	getDisplay_MMD_String (const CEvaluationTree *pTree) const
virtual std::string	getDisplay_XPP_String (const CEvaluationTree *pTree) const
virtual ASTNode *	toAST (const CCopasiDataModel *pDataModel) const
virtual bool	addChild (CCopasiNode< Data > *pChild, CCopasiNode< Data > *pAfter=NULL)
virtual bool	removeChild (CCopasiNode< Data > *pChild)
const CEvaluationTree *	getCalledTree () const
virtual void	writeMathML (std::ostream &out, const std::vector< std::vector< std::string > > &env, bool expand=true, unsigned C_INT32 l=0) const
const std::vector < CEvaluationNode * >	getListOfChildNodes () const
void	setBooleanRequired (const bool &booleanRequired)
const bool &	isBooleanRequired () const
virtual bool	isBoolean () const
Static Public Member Functions
static CEvaluationNode *	createNodeFromASTTree (const ASTNode &node)

---

Detailed Description

This is the class for nodes presenting opertors used in an evaluation trees.

---

Member Enumeration Documentation

enum CEvaluationNodeCall::SubType

Enumeration of possible node types.

Enumerator:

INVALID
FUNCTION
EXPRESSION

---

Constructor & Destructor Documentation

CEvaluationNodeCall::CEvaluationNodeCall	(	const SubType &	subType,
		const Data &	data
	)

Default constructor

Parameters:

const	SubType & subType
const	Data & data

CEvaluationNodeCall::CEvaluationNodeCall

(

const CEvaluationNodeCall &

src

)

Copy constructor

Parameters:

const

CEvaluationNodeCall & src

CEvaluationNodeCall::~CEvaluationNodeCall

(

)

[virtual]

Destructor

---

Member Function Documentation

bool CEvaluationNodeCall::addChild	(	CCopasiNode< Data > *	pChild,
		CCopasiNode< Data > *	pAfter = NULL
	)		[virtual]

Add a child to a node. If pAfter == this the child will be inserted at the front of the list of children.

Parameters:

CCopasiNode<	Data > * pChild
CCopasiNode<	Data > * pAfter (default: NULL appended to the list of children)

Returns:

bool Success

Reimplemented from CCopasiNode< std::string >.

bool CEvaluationNodeCall::calls

(

std::set< std::string > &

list

)

const

Check whether node the calls any tree in the list

Parameters:

std::set<

std::string > & list

Returns:

bool calls

bool CEvaluationNodeCall::compile

(

const CEvaluationTree *

pTree

)

[virtual]

Compile a node;

Parameters:

const

CEvaluationTree * pTree

Returns:

bool success;

Reimplemented from CEvaluationNode.

CEvaluationNode * CEvaluationNodeCall::createNodeFromASTTree

(

const ASTNode &

node

)

[static]

Creates a new CEvaluationNodeCall from an ASTNode.

Parameters:

const

ASTNode* node

Returns:

CEvaluationNode* return a pointer to the newly created node;

const CEvaluationTree * CEvaluationNodeCall::getCalledTree

(

)

const

Retrieve the tree which is called from this node

Returns:

const CEvaluationTree * calledTree

std::string CEvaluationNodeCall::getDisplay_C_String

(

const CEvaluationTree *

pTree

)

const [virtual]

Retrieve the display string of the node and its eventual child nodes in C.

Returns:

const Data & value

Reimplemented from CEvaluationNode.

std::string CEvaluationNodeCall::getDisplay_MMD_String

(

const CEvaluationTree *

pTree

)

const [virtual]

Retrieve the display string of the node and its eventual child nodes in Berkeley Madonna format.

Returns:

const Data & value

Reimplemented from CEvaluationNode.

std::string CEvaluationNodeCall::getDisplay_XPP_String

(

const CEvaluationTree *

pTree

)

const [virtual]

Retrieve the display string of the node and its eventual child nodes in XPPAUT format.

Returns:

const Data & value

Reimplemented from CEvaluationNode.

std::string CEvaluationNodeCall::getDisplayString

(

const CEvaluationTree *

pTree

)

const [virtual]

Retrieve the display string of the node and its eventual child nodes.

Returns:

const Data & value

Reimplemented from CEvaluationNode.

std::string CEvaluationNodeCall::getInfix

(

)

const [virtual]

Retrieve the infix value of the node and its eventual child nodes.

Returns:

const Data & value

Reimplemented from CEvaluationNode.

const std::vector<CEvaluationNode *> CEvaluationNodeCall::getListOfChildNodes

(

)

const [inline]

returns the vector of child nodes, corresponding to the arguments of a function call

bool CEvaluationNodeCall::isBoolean

(

)

const [virtual]

Check whether the result is Boolean

Returns:

bool isBoolean

Reimplemented from CEvaluationNode.

const bool & CEvaluationNodeCall::isBooleanRequired

(

)

const

Check whether the result must be Boolean

Returns:

const bool & isBooleanRequired

bool CEvaluationNodeCall::removeChild

(

CCopasiNode< Data > *

pChild

)

[virtual]

Remove a child from a node.

Parameters:

CCopasiNode<

Data > * pChild

Returns:

bool Success

Reimplemented from CCopasiNode< std::string >.

void CEvaluationNodeCall::setBooleanRequired

(

const bool &

booleanRequired

)

Set whether the result of the node must be Boolean

Parameters:

const

bool & booleanRequired

ASTNode * CEvaluationNodeCall::toAST

(

const CCopasiDataModel *

pDataModel

)

const [virtual]

Create a new ASTNode corresponding to this choice node.

Returns:

ASTNode* return a pointer to the newly created node;

Reimplemented from CEvaluationNode.

const C_FLOAT64 & CEvaluationNodeCall::value

(

)

const [virtual]

Retrieve the value of the node

Returns:

const C_FLOAT64 & value

Reimplemented from CEvaluationNode.

void CEvaluationNodeCall::writeMathML	(	std::ostream &	out,
		const std::vector< std::vector< std::string > > &	env,
		bool	expand = true,
		unsigned C_INT32	l = 0
	)		const [virtual]

generate display MathML recursively

Reimplemented from CEvaluationNode.

---

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

• copasi/function/CEvaluationNodeCall.h
• copasi/function/CEvaluationNodeCall.cpp