CNodeK Class Reference

#include <CNodeK.h>

List of all members.

Public Member Functions
	CNodeK ()
	CNodeK (const CNodeK &src)
	CNodeK (char type, char subtype)
	CNodeK (const std::string &name)
	CNodeK (C_FLOAT64 constant)
	~CNodeK ()
void	cleanup ()
C_INT32	load (CReadConfig &configbuffer)
std::string	getExplicitFunctionString (const std::vector< std::vector< std::string > > &callParameterNames, const std::string &r)
void	writeMathML (std::ostream &out, C_INT32 level) const
char	getType () const
char	getSubtype () const
CNodeK &	getLeft () const
CNodeK &	getRight () const
std::string	getName () const
C_FLOAT64	getConstant () const
C_INT32	getIndex () const
void	setType (const char ype)
void	setSubtype (const char subtype)
void	setLeft (CNodeK &left)
void	setLeft (CNodeK *pleft)
void	setRight (CNodeK &right)
void	setRight (CNodeK *pright)
void	setName (const std::string &name)
void	setConstant (C_FLOAT64 &constant)
void	setIndex (C_INT32 index)
void	setOldIndex (C_INT32 oldindex)
C_INT16	isLeftValid () const
C_INT16	isRightValid () const
C_INT16	isNumber () const
C_INT16	isIdentifier () const
C_INT16	isOperator () const
C_INT16	leftPrecedence () const
C_INT16	rightPrecedence () const
C_FLOAT64	value (const CCallParameters< C_FLOAT64 > &callParameters) const

---

Detailed Description

:pos 12.7478,42.4925

---

Constructor & Destructor Documentation

CNodeK::CNodeK

(

)

Default constructor

CNodeK::CNodeK

(

const CNodeK &

src

)

Copy constructor

Parameters:

const CNodeK &

src

CNodeK::CNodeK	(	char	type,
		char	subtype
	)

Constructor for operator

Parameters:

const char	type
const char	subtype

CNodeK::CNodeK

(

const std::string &

name

)

Constructor for identifier

Parameters:

const string

&name

CNodeK::CNodeK

(

C_FLOAT64

constant

)

Constructor for a constant

Parameters:

const C_FLOAT64

constant

CNodeK::~CNodeK

(

)

Destructor

---

Member Function Documentation

void CNodeK::cleanup

(

)

Delete

C_FLOAT64 CNodeK::getConstant

(

)

const

Retrieving value of a node

Returns:

C_FLOAT64

std::string CNodeK::getExplicitFunctionString	(	const std::vector< std::vector< std::string > > &	callParameterNames,
		const std::string &	r
	)

Returns a string that contains the equation defined from this node downwards. The function contains explicit names of node identifiers, rather than the abstract symbol.

Parameters:

const CCallParameters &	callParameterNames a vector of string pointers with identifier names
const string &	r a suffix for parameter names (usually reaction number)

Returns:

string

C_INT32 CNodeK::getIndex

(

)

const

Retrieving index the name of a node

Returns:

C_INT32

CNodeK & CNodeK::getLeft

(

)

const

Retrieving mLeft the left branch of a node

Returns:

CNodeK

std::string CNodeK::getName

(

)

const

Retrieving mName the name of a node

Returns:

string

CNodeK & CNodeK::getRight

(

)

const

Retrieving mName the name of a node

Returns:

string

char CNodeK::getSubtype

(

)

const

Retrieving mSubtype the subtype of a node

Returns:

char

char CNodeK::getType

(

)

const

Retrieving mType the type of a node

Returns:

char

C_INT16 CNodeK::isIdentifier

(

)

const

This checks whether the node is an identifier (mType = N_IDENTIFIER)

Returns:

int 1 or 0

C_INT16 CNodeK::isLeftValid

(

)

const

This checks whether mLeft points to a valid CNodeK

Returns:

int 1 or 0

C_INT16 CNodeK::isNumber

(

)

const

This checks whether the node is a number (mType = N_NUMBER)

Returns:

int 1 or 0

C_INT16 CNodeK::isOperator

(

)

const

This checks whether the node is a operator (mType = N_OPERATOR)

Returns:

int 1 or 0

C_INT16 CNodeK::isRightValid

(

)

const

This checks whether mRight points to a valid CNodeK

Returns:

int 1 or 0

C_INT16 CNodeK::leftPrecedence

(

)

const

This returns the left precedence value of a node

Returns:

int

C_INT32 CNodeK::load

(

CReadConfig &

configbuffer

)

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

C_INT16 CNodeK::rightPrecedence

(

)

const

This returns the right precedence value of a node

Returns:

int

void CNodeK::setConstant

(

C_FLOAT64 &

constant

)

Setting the value of a number

Parameters:

C_FLOAT64

&constant

void CNodeK::setIndex

(

C_INT32

index

)

Setting the index of an identifier

Parameters:

C_INT32

&index

void CNodeK::setLeft

(

CNodeK &

left

)

Setting mLeft the pointer to the left branch

Parameters:

CNodeK

&left

void CNodeK::setLeft

(

CNodeK *

pleft

)

Setting mLeft the pointer to the left branch

Parameters:

CNodeK

*pleft

void CNodeK::setName

(

const std::string &

name

)

Setting mName the name of an identifier

Parameters:

const string

&name

void CNodeK::setOldIndex

(

C_INT32

oldindex

)

Setting the old index (Gepasi format, each type is indexed separately)

Parameters:

C_INT32

&index

void CNodeK::setRight

(

CNodeK &

right

)

Setting mRight the pointer to the right branch

Parameters:

CNodeK

&right

void CNodeK::setRight

(

CNodeK *

pright

)

Setting mRight the pointer to the right branch

Parameters:

CNodeK

*pright

void CNodeK::setSubtype

(

const char

subtype

)

Setting mSubtype the subtype of a node

Parameters:

const char

subtype

void CNodeK::setType

(

const char

ype

)

Setting mType the subtype of a node

Parameters:

const char

type

C_FLOAT64 CNodeK::value

(

const CCallParameters< C_FLOAT64 > &

callParameters

)

const

This calculates the value of this sub-tree (ie with this node as root)

Parameters:

const

CCallParameters<C_FLOAT64> & callParameters

Returns:

C_FLOAT64

void CNodeK::writeMathML	(	std::ostream &	out,
		C_INT32	level
	)		const

---

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

• copasi/function/CNodeK.h
• copasi/function/CNodeK.cpp