CNodeK Class Reference

#include <CNodeK.h>

Collaboration diagram for CNodeK:

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

Private Attributes
int	attribute1
C_FLOAT64	mConstant
std::string	mExplicitFunction
C_INT32	mIndex
CNodeK *	mLeft
std::string	mName
C_INT32	mOldIndex
CNodeK *	mRight
char	mSubtype
char	mType

Detailed Description

Definition at line 84 of file CNodeK.h.

Constructor & Destructor Documentation

CNodeK::CNodeK

(

)

Default constructor

Definition at line 31 of file CNodeK.cpp.

References CONSTRUCTOR_TRACE, mConstant, mIndex, mLeft, mOldIndex, mRight, mSubtype, mType, and N_NOP.

{
  CONSTRUCTOR_TRACE;
  mType = N_NOP;
  mSubtype = N_NOP;
  mLeft = NULL;
  mRight = NULL;
  mConstant = 0.0;
  mIndex = -1;
  mOldIndex = -1;
}

CNodeK::CNodeK

(

const CNodeK &

src

)

Copy constructor

Parameters

const CNodeK &

src

Definition at line 43 of file CNodeK.cpp.

References CONSTRUCTOR_TRACE, mConstant, mIndex, mLeft, mName, mOldIndex, mRight, mSubtype, and mType.

{
  CONSTRUCTOR_TRACE;
  mType = src.mType;
  mSubtype = src.mSubtype;
  mLeft = src.mLeft;
  mRight = src.mRight;
  mConstant = src.mConstant;
  mName = src.mName;
  mIndex = src.mIndex;
  mOldIndex = src.mOldIndex;
}

CNodeK::CNodeK	(	char	type,
		char	subtype
	)

Constructor for operator

Parameters

const char	type
const char	subtype

Definition at line 56 of file CNodeK.cpp.

References CONSTRUCTOR_TRACE, mConstant, mIndex, mLeft, mOldIndex, mRight, mSubtype, and mType.

{
  CONSTRUCTOR_TRACE;
  mType = type;
  mSubtype = subtype;
  mLeft = NULL;
  mRight = NULL;
  mConstant = 0.0;
  mIndex = -1;
  mOldIndex = -1;
}

CNodeK::CNodeK

(

const std::string &

name

)

Constructor for identifier

Parameters

const string

&name

Definition at line 68 of file CNodeK.cpp.

References CONSTRUCTOR_TRACE, mConstant, mIndex, mLeft, mName, mOldIndex, mRight, mSubtype, mType, N_IDENTIFIER, and N_NOP.

{
  CONSTRUCTOR_TRACE;
  mType = N_IDENTIFIER;
  mSubtype = N_NOP;
  mLeft = NULL;
  mRight = NULL;
  mConstant = 0.0;
  mName = name;
  mIndex = -1;
  mOldIndex = -1;
}

CNodeK::CNodeK

(

C_FLOAT64

constant

)

Constructor for a constant

Parameters

const C_FLOAT64

constant

Definition at line 81 of file CNodeK.cpp.

References CONSTRUCTOR_TRACE, mConstant, mIndex, mLeft, mOldIndex, mRight, mSubtype, mType, N_NOP, and N_NUMBER.

{
  CONSTRUCTOR_TRACE;
  mType = N_NUMBER;
  mSubtype = N_NOP;
  mLeft = NULL;
  mRight = NULL;
  mConstant = constant;
  mIndex = -1;
  mOldIndex = -1;
}

CNodeK::~CNodeK

(

)

Destructor

Definition at line 96 of file CNodeK.cpp.

References DESTRUCTOR_TRACE.

{
  DESTRUCTOR_TRACE;
}

Member Function Documentation

void CNodeK::cleanup

(

)

Delete

Definition at line 93 of file CNodeK.cpp.

{}

C_FLOAT64 CNodeK::getConstant

(

)

const

Retrieving value of a node

Returns

C_FLOAT64

Definition at line 375 of file CNodeK.cpp.

References mConstant.

{
  return mConstant;
}

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

Definition at line 380 of file CNodeK.cpp.

References mIndex.

{
  return mIndex;
}

CNodeK & CNodeK::getLeft

(

)

const

Retrieving mLeft the left branch of a node

Returns

CNodeK

Definition at line 340 of file CNodeK.cpp.

References fatalError, and mLeft.

{
  if (!mLeft)
    fatalError(); // Call LeftIsValid first to avoid this!

  return *mLeft;
}

std::string CNodeK::getName

(

)

const

Retrieving mName the name of a node

Returns

string

Definition at line 356 of file CNodeK.cpp.

References C_INT, isIdentifier(), and mName.

{
  return mName;
#ifdef XXXX

  static unsigned C_INT ctr = 0;
  char name[9];

  if (isIdentifier())
    return mName;
  else
    {
      sprintf(name, "%X", ctr++);
      return name;
    }

#endif // XXXX
}

CNodeK & CNodeK::getRight

(

)

const

Retrieving mName the name of a node

Returns

string

Definition at line 348 of file CNodeK.cpp.

References fatalError, and mRight.

{
  if (!mRight)
    fatalError(); // Call RightIsValid first to avoid this!

  return *mRight;
}

char CNodeK::getSubtype

(

)

const

Retrieving mSubtype the subtype of a node

Returns

char

Definition at line 335 of file CNodeK.cpp.

References mSubtype.

{
  return mSubtype;
}

char CNodeK::getType

(

)

const

Retrieving mType the type of a node

Returns

char

Definition at line 330 of file CNodeK.cpp.

References mType.

{
  return mType;
}

C_INT16 CNodeK::isIdentifier

(

)

const

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

Returns

int 1 or 0

Definition at line 450 of file CNodeK.cpp.

References mType, N_IDENTIFIER, N_KCONSTANT, N_MODIFIER, N_OBJECT, N_PRODUCT, N_SUBSTRATE, and N_VOLUME.

Referenced by getName().

{
  switch (mType)
    {
      case N_OBJECT:
      case N_IDENTIFIER:
      case N_SUBSTRATE:
      case N_PRODUCT:
      case N_MODIFIER:
      case N_KCONSTANT:
      case N_VOLUME:
        return true;
      default:
        return false;
    }
}

C_INT16 CNodeK::isLeftValid

(

)

const

This checks whether mLeft points to a valid CNodeK

Returns

int 1 or 0

Definition at line 435 of file CNodeK.cpp.

References mLeft.

{
  return (mLeft != NULL);
}

C_INT16 CNodeK::isNumber

(

)

const

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

Returns

int 1 or 0

Definition at line 445 of file CNodeK.cpp.

References mType, and N_NUMBER.

{
  return (mType == N_NUMBER);
}

C_INT16 CNodeK::isOperator

(

)

const

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

Returns

int 1 or 0

Definition at line 467 of file CNodeK.cpp.

References mType, and N_OPERATOR.

{
  return mType == N_OPERATOR;
}

C_INT16 CNodeK::isRightValid

(

)

const

This checks whether mRight points to a valid CNodeK

Returns

int 1 or 0

Definition at line 440 of file CNodeK.cpp.

References mRight.

{
  return (mRight != NULL);
}

C_INT16 CNodeK::leftPrecedence

(

)

const

This returns the left precedence value of a node

Returns

int

Definition at line 472 of file CNodeK.cpp.

References mSubtype, mType, N_FUNCTION, N_IDENTIFIER, N_NUMBER, and N_OBJECT.

{
  switch (mType)
    {
      case N_OBJECT:
      case N_NUMBER:
      case N_IDENTIFIER:
      case N_FUNCTION:
        return 5;
    }

  // if we got here then it is an operator
  switch (mSubtype)
    {
      case '+':
      case '-':
        return 1;
      case '*':
      case '/':
        return 3;
      case '(':
        return 6;
      case '^':
        return 5;
      case ')':
      case '%':
        return 0;
    }

  return 0;
}

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

Definition at line 101 of file CNodeK.cpp.

References C_INT32, CReadConfig::getVariable(), mConstant, mIndex, mName, mSubtype, mType, N_IDENTIFIER, N_KCONSTANT, N_MODIFIER, N_NUMBER, N_PRODUCT, N_SUBSTRATE, and CReadConfig::SEARCH.

{
  C_INT32 Fail = 0;

  if ((Fail = configbuffer.getVariable("Node", "node", &mType, &mSubtype,
                                       CReadConfig::SEARCH)))
    return Fail;

  /* This COPASI treats all these as identifiers */
  if (mType == N_SUBSTRATE ||
      mType == N_PRODUCT ||
      mType == N_MODIFIER ||
      mType == N_KCONSTANT)
    {
      mSubtype = mType;
      mType = N_IDENTIFIER;
    }

  // leave the Left & Right pointers out
  // value of the constant if one
  if (mType == N_NUMBER)
    {
      if ((Fail = configbuffer.getVariable("Value", "C_FLOAT64", &mConstant)))
        return Fail;
    }
  else if (mType == N_IDENTIFIER)
    {
      if ((Fail = configbuffer.getVariable("Index", "C_INT32", &mIndex)))
        return Fail;

      if ((Fail = configbuffer.getVariable("Name", "string", &mName)))
        return Fail;
    }

  return Fail;
}

C_INT16 CNodeK::rightPrecedence

(

)

const

This returns the right precedence value of a node

Returns

int

Definition at line 504 of file CNodeK.cpp.

References mSubtype, mType, N_FUNCTION, N_IDENTIFIER, N_NUMBER, and N_OBJECT.

{
  switch (mType)
    {
      case N_OBJECT:
      case N_NUMBER:
      case N_IDENTIFIER:
        return 6;
      case N_FUNCTION:
        return 4;
    }

  // if we got here then it is an operator
  switch (mSubtype)
    {
      case '+':
      case '-':
        return 2;
      case '*':
      case '/':
        return 4;
      case ')':
        return 6;
      case '^':
        return 4;
      case '(':
      case '%':
        return 0;
    }

  return 0;
}

void CNodeK::setConstant

(

C_FLOAT64 &

constant

)

Setting the value of a number

Parameters

C_FLOAT64

&constant

Definition at line 420 of file CNodeK.cpp.

References mConstant.

{
  mConstant = constant;
}

void CNodeK::setIndex

(

C_INT32

index

)

Setting the index of an identifier

Parameters

C_INT32

&index

Definition at line 425 of file CNodeK.cpp.

References mIndex.

{
  mIndex = index;
}

void CNodeK::setLeft

(

CNodeK &

left

)

Setting mLeft the pointer to the left branch

Parameters

CNodeK

&left

Definition at line 395 of file CNodeK.cpp.

References mLeft.

{
  mLeft = &left;
}

void CNodeK::setLeft

(

CNodeK *

pleft

)

Setting mLeft the pointer to the left branch

Parameters

CNodeK

*pleft

Definition at line 400 of file CNodeK.cpp.

References mLeft.

{
  mLeft = pleft;
}

void CNodeK::setName

(

const std::string &

name

)

Setting mName the name of an identifier

Parameters

const string

&name

Definition at line 415 of file CNodeK.cpp.

References mName.

{
  mName = name;
}

void CNodeK::setOldIndex

(

C_INT32

oldindex

)

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

Parameters

C_INT32

&index

Definition at line 430 of file CNodeK.cpp.

References mOldIndex.

{
  mOldIndex = oldindex;
}

void CNodeK::setRight

(

CNodeK &

right

)

Setting mRight the pointer to the right branch

Parameters

CNodeK

&right

Definition at line 405 of file CNodeK.cpp.

References mRight.

{
  mRight = &right;
}

void CNodeK::setRight

(

CNodeK *

pright

)

Setting mRight the pointer to the right branch

Parameters

CNodeK

*pright

Definition at line 410 of file CNodeK.cpp.

References mRight.

{
  mRight = pright;
}

void CNodeK::setSubtype

(

const char

subtype

)

Setting mSubtype the subtype of a node

Parameters

const char

subtype

Definition at line 390 of file CNodeK.cpp.

References mSubtype.

{
  mSubtype = subtype;
}

void CNodeK::setType

(

const char

ype

)

Setting mType the subtype of a node

Parameters

const char

type

Definition at line 385 of file CNodeK.cpp.

References mType.

{
  mType = 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

Member Data Documentation

int CNodeK::attribute1

private

WHAT IS THIS FOR??? PLEASE ADD COMMENT!

Definition at line 137 of file CNodeK.h.

C_FLOAT64 CNodeK::mConstant

private

The value of a node of type N_NUMBER

Definition at line 117 of file CNodeK.h.

Referenced by CNodeK(), getConstant(), load(), and setConstant().

std::string CNodeK::mExplicitFunction

private

The explicit function string

Definition at line 142 of file CNodeK.h.

C_INT32 CNodeK::mIndex

private

The index of the node for type N_IDENTIFIER

Definition at line 127 of file CNodeK.h.

Referenced by CNodeK(), getIndex(), load(), and setIndex().

CNodeK* CNodeK::mLeft

private

The left branch of the tree originating from tyhis node

Definition at line 107 of file CNodeK.h.

Referenced by CNodeK(), getLeft(), isLeftValid(), and setLeft().

std::string CNodeK::mName

private

The name of the node for type N_IDENTIFIER

Definition at line 122 of file CNodeK.h.

Referenced by CNodeK(), getName(), load(), and setName().

C_INT32 CNodeK::mOldIndex

private

The index in old Gepasi format

Definition at line 132 of file CNodeK.h.

Referenced by CNodeK(), and setOldIndex().

CNodeK* CNodeK::mRight

private

The right branch of the tree originating from tyhis node

Definition at line 112 of file CNodeK.h.

Referenced by CNodeK(), getRight(), isRightValid(), and setRight().

char CNodeK::mSubtype

private

The subtype of a node. for type N_FUNCTION one of: N_LOG10, N_LOG, N_EXP, N_SIN, N_COS, N_RND, N_GAUSS, N_BOLTZ for type N_IDENTIFIER one of:N_SUBSTRATE, N_PRODUCT, N_MODIFIER, N_KCONSTANT for type N_OPERATOR one of: + - * / ^ () ...

Definition at line 102 of file CNodeK.h.

Referenced by CNodeK(), getSubtype(), leftPrecedence(), load(), rightPrecedence(), and setSubtype().

char CNodeK::mType

private

The type of the node. One of N_ROOT, N_OPERATOR, N_IDENTIFIER, N_FUNCTION, N_NUMBER

Definition at line 92 of file CNodeK.h.

Referenced by CNodeK(), getType(), isIdentifier(), isNumber(), isOperator(), leftPrecedence(), load(), rightPrecedence(), and setType().

---

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

• CNodeK.h
• CNodeK.cpp