libSBML C# API  libSBML 5.8.0 C# API
 All Classes Namespaces Files Functions Variables Properties Pages
libsbmlcs.ASTNode Class Reference
Inheritance diagram for libsbmlcs.ASTNode:
[legend]

Detailed Description

Abstract Syntax Tree (AST) representation of a mathematical expression.

This class of objects is defined by libSBML only and has no direct equivalent in terms of SBML components. This class is not prescribed by the SBML specifications, although it is used to implement features defined in SBML.

Abstract Syntax Trees (ASTs) are a simple kind of data structure used in libSBML for storing mathematical expressions. The ASTNode is the cornerstone of libSBML's AST representation. An AST 'node' represents the most basic, indivisible part of a mathematical formula and come in many types. For instance, there are node types to represent numbers (with subtypes to distinguish integer, real, and rational numbers), names (e.g., constants or variables), simple mathematical operators, logical or relational operators and functions. LibSBML ASTs provide a canonical, in-memory representation for all mathematical formulas regardless of their original format (which might be MathML or might be text strings).

An AST node in libSBML is a recursive structure containing a pointer to the node's value (which might be, for example, a number or a symbol) and a list of children nodes. Each ASTNode node may have none, one, two, or more children depending on its type. The following diagram illustrates an example of how the mathematical expression '1 + 2' is represented as an AST with one plus node having two integer children nodes for the numbers 1 and 2. The figure also shows the corresponding MathML representation:

Example AST representation of a mathematical expression.
Infix AST MathML
1 + 2 <math xmlns="http://www.w3.org/1998/Math/MathML">
  <apply>
    <plus/>
    <cn type="integer"> 1 </cn>
    <cn type="integer"> 2 </cn>
  </apply>
</math>

The following are other noteworthy points about the AST representation in libSBML:

  • A numerical value represented in MathML as a real number with an exponent is preserved as such in the AST node representation, even if the number could be stored in a double data type. This is done so that when an SBML model is read in and then written out again, the amount of change introduced by libSBML to the SBML during the round-trip activity is minimized.

  • Rational numbers are represented in an AST node using separate numerator and denominator values. These can be retrieved using the methods ASTNode::getNumerator() and ASTNode::getDenominator().

  • The children of an ASTNode are other ASTNode objects. The list of children is empty for nodes that are leaf elements, such as numbers. For nodes that are actually roots of expression subtrees, the list of children points to the parsed objects that make up the rest of the expression.

The set of possible ASTNode types

Every ASTNode has an associated type code to indicate, for example, whether it holds a number or stands for an arithmetic operator. The type is recorded as a value drawn from a set of static integer constants defined in the class libsbml. Their names begin with the characters AST_. The list of possible types is quite long, because it covers all the mathematical functions that are permitted in SBML. The values are shown in the following table:

  • AST_CONSTANT_E
  • AST_CONSTANT_FALSE
  • AST_CONSTANT_PI
  • AST_CONSTANT_TRUE
  • AST_DIVIDE
  • AST_FUNCTION
  • AST_FUNCTION_ABS
  • AST_FUNCTION_ARCCOS
  • AST_FUNCTION_ARCCOSH
  • AST_FUNCTION_ARCCOT
  • AST_FUNCTION_ARCCOTH
  • AST_FUNCTION_ARCCSC
  • AST_FUNCTION_ARCCSCH
  • AST_FUNCTION_ARCSEC
  • AST_FUNCTION_ARCSECH
  • AST_FUNCTION_ARCSIN
  • AST_FUNCTION_ARCSINH
  • AST_FUNCTION_ARCTAN
  • AST_FUNCTION_ARCTANH
  • AST_FUNCTION_CEILING
  • AST_FUNCTION_COS
  • AST_FUNCTION_COSH
  • AST_FUNCTION_COT
  • AST_FUNCTION_COTH
  • AST_FUNCTION_CSC
  • AST_FUNCTION_CSCH
  • AST_FUNCTION_DELAY
  • AST_FUNCTION_EXP
  • AST_FUNCTION_FACTORIAL
  • AST_FUNCTION_FLOOR
  • AST_FUNCTION_LN
  • AST_FUNCTION_LOG
  • AST_FUNCTION_PIECEWISE
  • AST_FUNCTION_POWER
  • AST_FUNCTION_ROOT
  • AST_FUNCTION_SEC
  • AST_FUNCTION_SECH
  • AST_FUNCTION_SIN
  • AST_FUNCTION_SINH
  • AST_FUNCTION_TAN
  • AST_FUNCTION_TANH
  • AST_INTEGER
  • AST_LAMBDA
  • AST_LOGICAL_AND
  • AST_LOGICAL_NOT
  • AST_LOGICAL_OR
  • AST_LOGICAL_XOR
  • AST_MINUS
  • AST_NAME
  • AST_NAME_AVOGADRO (Level 3 only)
  • AST_NAME_TIME
  • AST_PLUS
  • AST_POWER
  • AST_RATIONAL
  • AST_REAL
  • AST_REAL_E
  • AST_RELATIONAL_EQ
  • AST_RELATIONAL_GEQ
  • AST_RELATIONAL_GT
  • AST_RELATIONAL_LEQ
  • AST_RELATIONAL_LT
  • AST_RELATIONAL_NEQ
  • AST_TIMES
  • AST_UNKNOWN

The types have the following meanings:

  • If the node is basic mathematical operator (e.g., '+'), then the node's type will be AST_PLUS, AST_MINUS, AST_TIMES, AST_DIVIDE, or AST_POWER, as appropriate.

  • If the node is a predefined function or operator from SBML Level 1 (in the string-based formula syntax used in Level 1) or SBML Levels 2 and 3 (in the subset of MathML used in SBML Levels 2 and 3), then the node's type will be either AST_FUNCTION_X, AST_LOGICAL_X, or AST_RELATIONAL_X, as appropriate. (Examples: AST_FUNCTION_LOG, AST_RELATIONAL_LEQ.)

  • If the node refers to a user-defined function, the node's type will be AST_FUNCTION (because it holds the name of the function).

  • If the node is a lambda expression, its type will be AST_LAMBDA.

  • If the node is a predefined constant ('ExponentialE', 'Pi', 'True' or 'False'), then the node's type will be AST_CONSTANT_E, AST_CONSTANT_PI, AST_CONSTANT_TRUE, or AST_CONSTANT_FALSE.

  • (Levels 2 and 3 only) If the node is the special MathML csymbol time, the value of the node will be AST_NAME_TIME. (Note, however, that the MathML csymbol delay is translated into a node of type AST_FUNCTION_DELAY. The difference is due to the fact that time is a single variable, whereas delay is actually a function taking arguments.)

  • (Level 3 only) If the node is the special MathML csymbol avogadro, the value of the node will be AST_NAME_AVOGADRO.

  • If the node contains a numerical value, its type will be AST_INTEGER, AST_REAL, AST_REAL_E, or AST_RATIONAL, as appropriate.

Converting between ASTs and text strings

The text-string form of mathematical formulas produced bylibsbmlcs.libsbml.formulaToString() and read bylibsbmlcs.libsbml.parseFormula() and SBML_parseL3Formula() are in a simple C-inspired infix notation. A formula in this text-string form can be handed to a program that understands SBML mathematical expressions, or used as part of a translation system. The libSBML distribution comes with an example program in the 'examples' subdirectory called translateMath that implements an interactive command-line demonstration of translating infix formulas into MathML and vice-versa.

The formula strings may contain operators, function calls, symbols, and white space characters. The allowable white space characters are tab and space. The following are illustrative examples of formulas expressed in the syntax:

0.10 * k4^2 (vm * s1)/(km + s1)

The following table shows the precedence rules in this syntax. In the Class column, operand implies the construct is an operand, prefix implies the operation is applied to the following arguments, unary implies there is one argument, and binary implies there are two arguments. The values in the Precedence column show how the order of different types of operation are determined. For example, the expression a * b + c is evaluated as (a * b) + c because the * operator has higher precedence. The Associates column shows how the order of similar precedence operations is determined; for example, a - b + c is evaluated as (a - b) + c because the + and - operators are left-associative. The precedence and associativity rules are taken from the C programming language, except for the symbol ^, which is used in C for a different purpose. (Exponentiation can be invoked using either ^ or the function power.)

Token Operation Class Precedence Associates
namesymbol referenceoperand6n/a
(expression)expression groupingoperand6n/a
f(...)function callprefix6left
-negationunary5right
^powerbinary4left
*multiplicationbinary3left
/divisonbinary3left
+additionbinary2left
-subtractionbinary2left
,argument delimiterbinary1left
A table of the expression operators and their precedence in the text-string format for mathematical expressions used by SBML_parseFormula().

A program parsing a formula in an SBML model should assume that names appearing in the formula are the identifiers of Species, Parameter, Compartment, FunctionDefinition, Reaction (in SBML Levels 2 and 3), or SpeciesReference (in SBML Level 3 only) objects defined in a model. When a function call is involved, the syntax consists of a function identifier, followed by optional white space, followed by an opening parenthesis, followed by a sequence of zero or more arguments separated by commas (with each comma optionally preceded and/or followed by zero or more white space characters), followed by a closing parenthesis. There is an almost one-to-one mapping between the list of predefined functions available, and those defined in MathML. All of the MathML functions are recognized; this set is larger than the functions defined in SBML Level 1. In the subset of functions that overlap between MathML and SBML Level 1, there exist a few differences. The following table summarizes the differences between the predefined functions in SBML Level 1 and the MathML equivalents in SBML Levels 2 and  3:

Text string formula functions MathML equivalents in SBML Levels 2 and 3
acosarccos
asinarcsin
atanarctan
ceilceiling
logln
log10(x)log(10, x)
pow(x, y)power(x, y)
sqr(x)power(x, 2)
sqrt(x)root(2, x)
Table comparing the names of certain functions in the SBML text-string formula syntax and MathML. The left column shows the names of functions recognized by SBML_parseFormula(); the right column shows their equivalent function names in MathML 2.0, used in SBML Levels 2 and 3.
Warning
We urge developers to keep in mind that the text-string formula syntax is specific to SBML Level 1's C-like mathematical formula syntax. In particular, it is not a general-purpose mathematical expression syntax. LibSBML provides methods for parsing and transforming text-string math formulas back and forth from AST structures, but it is important to keep the system's limitations in mind.
See Also
SBML_parseL3Formula()
libsbmlcs.libsbml.parseFormula()

Public Member Functions

int addChild (ASTNode child)
 Adds the given node as a child of this ASTNode. More...
 
int addSemanticsAnnotation (XMLNode sAnnotation)
 Adds the given XMLNode as a semantic annotation of this ASTNode. More...
 
 ASTNode (int type)
 Creates and returns a new ASTNode. More...
 
 ASTNode ()
 Creates and returns a new ASTNode. More...
 
 ASTNode (ASTNode orig)
 Copy constructor; creates a deep copy of the given ASTNode. More...
 
bool canonicalize ()
 Converts this ASTNode to a canonical form and returns true if successful, false otherwise. More...
 
ASTNode deepCopy ()
 Creates a recursive copy of this node and all its children. More...
 
virtual void Dispose ()
 
override bool Equals (Object sb)
 
int freeName ()
 Frees the name of this ASTNode and sets it to null. More...
 
char getCharacter ()
 Get the value of this node as a single character. More...
 
ASTNode getChild (long n)
 Get a child of this node according to its index number. More...
 
string getClass ()
 Get the class of this ASTNode. More...
 
XMLAttributes getDefinitionURL ()
 Gets the MathML definitionURL attribute value. More...
 
int getDenominator ()
 Get the value of the denominator of this node. More...
 
int getExponent ()
 Get the exponent value of this ASTNode. More...
 
override int GetHashCode ()
 
string getId ()
 Get the id of this ASTNode. More...
 
int getInteger ()
 Get the value of this node as an integer. More...
 
ASTNode getLeftChild ()
 Get the left child of this node. More...
 
ASTNodeList getListOfNodes ()
 
double getMantissa ()
 Get the mantissa value of this node. More...
 
string getName ()
 Get the value of this node as a string. More...
 
long getNumChildren ()
 Get the number of children that this node has. More...
 
int getNumerator ()
 Get the value of the numerator of this node. More...
 
long getNumSemanticsAnnotations ()
 Get the number of semantic annotation elements inside this node. More...
 
string getOperatorName ()
 Get the value of this operator node as a string. More...
 
SBase getParentSBMLObject ()
 Returns the parent SBML object. More...
 
int getPrecedence ()
 Get the precedence of this node in the infix math syntax of SBML Level 1. More...
 
double getReal ()
 Get the real-numbered value of this node. More...
 
ASTNode getRightChild ()
 Get the right child of this node. More...
 
XMLNode getSemanticsAnnotation (long n)
 Get the nth semantic annotation of this node. More...
 
string getStyle ()
 Get the style of this ASTNode. More...
 
int getType ()
 Get the type of this ASTNode. More...
 
string getUnits ()
 Get the units of this ASTNode. More...
 
bool hasCorrectNumberArguments ()
 Predicate returning true or false depending on whether this ASTNode has the correct number of children for it's type. More...
 
bool hasUnits ()
 Predicate returning true (non-zero) if this node or any of its children nodes have the attribute sbml:units. More...
 
int insertChild (long n, ASTNode newChild)
 Insert the given ASTNode at point n in the list of children of this ASTNode. More...
 
bool isAvogadro ()
 Predicate returning true (non-zero) if this node is the special symbol avogadro. More...
 
bool isBoolean ()
 Predicate returning true (non-zero) if this node has a bool type (a logical operator, a relational operator, or the constants true or false). More...
 
bool isBvar ()
 Predicate returning true or false depending on whether this ASTNode has the correct number of children for it's type. More...
 
bool isConstant ()
 Predicate returning true (non-zero) if this node represents a MathML constant (e.g., true, Pi). More...
 
bool isFunction ()
 Predicate returning true (non-zero) if this node represents a MathML function (e.g., abs()), or an SBML Level 1 function, or a user-defined function. More...
 
bool isInfinity ()
 Predicate returning true (non-zero) if this node represents the special IEEE 754 value infinity, false (zero) otherwise. More...
 
bool isInteger ()
 Predicate returning true (non-zero) if this node contains an integer value, false (zero) otherwise. More...
 
bool isLambda ()
 Predicate returning true (non-zero) if this node is a MathML <lambda>, false (zero) otherwise. More...
 
bool isLog10 ()
 Predicate returning true (non-zero) if this node represents a log10 function, false (zero) otherwise. More...
 
bool isLogical ()
 Predicate returning true (non-zero) if this node is a MathML logical operator (i.e., and, or, not, xor). More...
 
bool isName ()
 Predicate returning true (non-zero) if this node is a user-defined variable name in SBML L1, L2 (MathML), or the special symbols delay or time. More...
 
bool isNaN ()
 Predicate returning true (non-zero) if this node represents the special IEEE 754 value 'not a number' (NaN), false (zero) otherwise. More...
 
bool isNegInfinity ()
 Predicate returning true (non-zero) if this node represents the special IEEE 754 value 'negative infinity', false (zero) otherwise. More...
 
bool isNumber ()
 Predicate returning true (non-zero) if this node contains a number, false (zero) otherwise. More...
 
bool isOperator ()
 Predicate returning true (non-zero) if this node is a mathematical operator, meaning, +, -, *, / or ^ (power). More...
 
bool isPiecewise ()
 Predicate returning true (non-zero) if this node is the MathML <piecewise> construct, false (zero) otherwise. More...
 
bool isRational ()
 Predicate returning true (non-zero) if this node represents a rational number, false (zero) otherwise. More...
 
bool isReal ()
 Predicate returning true (non-zero) if this node can represent a real number, false (zero) otherwise. More...
 
bool isRelational ()
 Predicate returning true (non-zero) if this node is a MathML relational operator, meaning ==, >=, >, <, and !=. More...
 
bool isSetClass ()
 Predicate returning true (non-zero) if this node has the mathml attribute class. More...
 
bool isSetId ()
 Predicate returning true (non-zero) if this node has the mathml attribute id. More...
 
bool isSetStyle ()
 Predicate returning true (non-zero) if this node has the mathml attribute style. More...
 
bool isSetUnits ()
 Predicate returning true (non-zero) if this node has the attribute sbml:units. More...
 
bool isSqrt ()
 Predicate returning true (non-zero) if this node represents a square root function, false (zero) otherwise. More...
 
bool isUMinus ()
 Predicate returning true (non-zero) if this node is a unary minus operator, false (zero) otherwise. More...
 
bool isUnknown ()
 Predicate returning true (non-zero) if this node has an unknown type. More...
 
bool isUPlus ()
 Predicate returning true (non-zero) if this node is a unary plus operator, false (zero) otherwise. More...
 
bool isWellFormedASTNode ()
 Predicate returning true or false depending on whether this ASTNode is well-formed. More...
 
void multiplyTimeBy (ASTNode function)
 Replaces any 'AST_NAME_TIME' nodes with a node that multiplies time by the given function. More...
 
int prependChild (ASTNode child)
 Adds the given node as a child of this ASTNode. More...
 
void reduceToBinary ()
 Reduces this ASTNode to a binary tree. More...
 
int removeChild (long n)
 Removes the nth child of this ASTNode object. More...
 
void renameSIdRefs (string oldid, string newid)
 Renames all the SIdRef attributes on this node and any child node. More...
 
void renameUnitSIdRefs (string oldid, string newid)
 Renames all the UnitSIdRef attributes on this node and any child node. More...
 
void replaceArgument (string bvar, ASTNode arg)
 Replaces occurences of a given name within this ASTNode with the name/value/formula represented by arg. More...
 
int replaceChild (long n, ASTNode newChild)
 Replaces the nth child of this ASTNode with the given ASTNode. More...
 
void replaceIDWithFunction (string id, ASTNode function)
 Replace any nodes of type AST_NAME with the name 'id' from the child 'math' object with the provided ASTNode. More...
 
bool returnsBoolean (Model model)
 Predicate returning true (non-zero) if this node returns a bool type or false (zero) otherwise. More...
 
bool returnsBoolean ()
 Predicate returning true (non-zero) if this node returns a bool type or false (zero) otherwise. More...
 
void setBvar ()
 Predicate returning true or false depending on whether this ASTNode has the correct number of children for it's type. More...
 
int setCharacter (char value)
 Sets the value of this ASTNode to the given character. More...
 
int setClass (string className)
 Sets the mathml class of this ASTNode to className. More...
 
int setId (string id)
 Sets the mathml id of this ASTNode to id. More...
 
int setName (string name)
 Sets the value of this ASTNode to the given name. More...
 
int setStyle (string style)
 Sets the mathml style of this ASTNode to style. More...
 
int setType (int type)
 Sets the type of this ASTNode to the given type code. More...
 
int setUnits (string units)
 Sets the units of this ASTNode to units. More...
 
int setValue (int value)
 Sets the value of this ASTNode to the given (long) integer and sets the node type to AST_INTEGER. More...
 
int setValue (int numerator, int denominator)
 Sets the value of this ASTNode to the given rational in two parts: the numerator and denominator. More...
 
int setValue (double value)
 Sets the value of this ASTNode to the given real (double) and sets the node type to AST_REAL. More...
 
int setValue (double mantissa, int exponent)
 Sets the value of this ASTNode to the given real (double) in two parts: the mantissa and the exponent. More...
 
int swapChildren (ASTNode that)
 Swap the children of this ASTNode object with the children of the given ASTNode object. More...
 
int unsetClass ()
 Unsets the mathml class of this ASTNode. More...
 
int unsetId ()
 Unsets the mathml id of this ASTNode. More...
 
int unsetStyle ()
 Unsets the mathml style of this ASTNode. More...
 
int unsetUnits ()
 Unsets the units of this ASTNode. More...
 

Static Public Member Functions

static bool operator!= (ASTNode lhs, ASTNode rhs)
 
static bool operator== (ASTNode lhs, ASTNode rhs)
 

Protected Attributes

bool swigCMemOwn
 

Constructor & Destructor Documentation

libsbmlcs.ASTNode.ASTNode ( int  type)

Creates and returns a new ASTNode.

Unless the argument type is given, the returned node will by default have a type of AST_UNKNOWN. If the type isn't supplied when caling this constructor, the caller should set the node type to something else as soon as possible using ASTNode::setType(int).

Parameters
typean optional type code indicating the type of node to create.
libsbmlcs.ASTNode.ASTNode ( )

Creates and returns a new ASTNode.

Unless the argument type is given, the returned node will by default have a type of AST_UNKNOWN. If the type isn't supplied when caling this constructor, the caller should set the node type to something else as soon as possible using ASTNode::setType(int).

Parameters
typean optional type code indicating the type of node to create.
libsbmlcs.ASTNode.ASTNode ( ASTNode  orig)

Copy constructor; creates a deep copy of the given ASTNode.

Parameters
origthe ASTNode to be copied.

Member Function Documentation

int libsbmlcs.ASTNode.addChild ( ASTNode  child)

Adds the given node as a child of this ASTNode.

Child nodes are added in-order, from left to right.

Parameters
childthe ASTNode instance to add
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
Note
Adding a child to an ASTNode may change the structure of the mathematical formula being represented by the tree structure, and may render the representation invalid. Callers need to be careful to use this method in the context of other operations to create complete and correct formulas. The method ASTNode::isWellFormedASTNode() may also be useful for checking the results of node modifications.
See Also
prependChild(ASTNode child)
replaceChild(long n, ASTNode child)
insertChild(long n, ASTNode child)
removeChild(long n)
isWellFormedASTNode()
int libsbmlcs.ASTNode.addSemanticsAnnotation ( XMLNode  sAnnotation)

Adds the given XMLNode as a semantic annotation of this ASTNode.

The <semantics> element is a MathML 2.0 construct that can be used to associate additional information with a MathML construct. The construct can be used to decorate a MathML expressions with a sequence of one or more <annotation> or <annotation-xml> elements. Each such element contains a pair of items; the first is a symbol that acts as an attribute or key, and the second is the value associated with the attribute or key. Please refer to the MathML 2.0 documentation, particularly the Section 5.2, Semantic Annotations for more information about these constructs.
Parameters
sAnnotationthe annotation to add.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
Note
Although SBML permits the semantic annotation construct in MathML expressions, the truth is that this construct has so far (at this time of this writing, which is early 2011) seen very little use in SBML software. The full implications of using semantic annotations are still poorly understood. If you wish to use this construct, we urge you to discuss possible uses and applications on the SBML discussion lists, particularly sbml-discuss&#64;caltech.edu and/or sbml-interoperability&#64;caltech.edu.
bool libsbmlcs.ASTNode.canonicalize ( )

Converts this ASTNode to a canonical form and returns true if successful, false otherwise.

The rules determining the canonical form conversion are as follows:

  • If the node type is AST_NAME and the node name matches 'ExponentialE', 'Pi', 'True' or 'False' the node type is converted to the corresponding AST_CONSTANT_X type.

  • If the node type is an AST_FUNCTION and the node name matches an SBML (MathML) function name, logical operator name, or relational operator name, the node is converted to the corresponding AST_FUNCTION_X or AST_LOGICAL_X type.

SBML Level 1 function names are searched first; thus, for example, canonicalizing log will result in a node type of AST_FUNCTION_LN. (See the SBML Level 1 Version 2 Specification, Appendix C.)

Sometimes, canonicalization of a node results in a structural conversion of the node as a result of adding a child. For example, a node with the SBML Level 1 function name sqr and a single child node (the argument) will be transformed to a node of type AST_FUNCTION_POWER with two children. The first child will remain unchanged, but the second child will be an ASTNode of type AST_INTEGER and a value of 2. The function names that result in structural changes are: log10, sqr, and sqrt.

ASTNode libsbmlcs.ASTNode.deepCopy ( )

Creates a recursive copy of this node and all its children.

Returns
a copy of this ASTNode and all its children. The caller owns the returned ASTNode and is reponsible for deleting it.
virtual void libsbmlcs.ASTNode.Dispose ( )
virtual
override bool libsbmlcs.ASTNode.Equals ( Object  sb)
int libsbmlcs.ASTNode.freeName ( )

Frees the name of this ASTNode and sets it to null.

This operation is only applicable to ASTNode objects corresponding to operators, numbers, or AST_UNKNOWN. This method has no effect on other types of nodes.

Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
char libsbmlcs.ASTNode.getCharacter ( )

Get the value of this node as a single character.

This function should be called only when ASTNode::getType() returns AST_PLUS, AST_MINUS, AST_TIMES, AST_DIVIDE or AST_POWER.

Returns
the value of this ASTNode as a single character
ASTNode libsbmlcs.ASTNode.getChild ( long  n)

Get a child of this node according to its index number.

Parameters
nthe index of the child to get
Returns
the nth child of this ASTNode or null if this node has no nth child (n > ASTNode::getNumChildren() - 1).
string libsbmlcs.ASTNode.getClass ( )

Get the class of this ASTNode.

Returns
the mathml class of this ASTNode.
XMLAttributes libsbmlcs.ASTNode.getDefinitionURL ( )

Gets the MathML definitionURL attribute value.

Returns
the value of the definitionURL attribute, in the form of a libSBML XMLAttributes object.
int libsbmlcs.ASTNode.getDenominator ( )

Get the value of the denominator of this node.

This function should be called only when ASTNode::getType() == AST_RATIONAL.

Returns
the value of the denominator of this ASTNode.
int libsbmlcs.ASTNode.getExponent ( )

Get the exponent value of this ASTNode.

This function should be called only when ASTNode::getType() returns AST_REAL_E or AST_REAL.

Returns
the value of the exponent of this ASTNode.
override int libsbmlcs.ASTNode.GetHashCode ( )
string libsbmlcs.ASTNode.getId ( )

Get the id of this ASTNode.

Returns
the mathml id of this ASTNode.
int libsbmlcs.ASTNode.getInteger ( )

Get the value of this node as an integer.

This function should be called only when ASTNode::getType() == AST_INTEGER.

Returns
the value of this ASTNode as a (long) integer.
ASTNode libsbmlcs.ASTNode.getLeftChild ( )

Get the left child of this node.

Returns
the left child of this ASTNode. This is equivalent to calling ASTNode::getChild(long) with an argument of 0.
ASTNodeList libsbmlcs.ASTNode.getListOfNodes ( )
double libsbmlcs.ASTNode.getMantissa ( )

Get the mantissa value of this node.

This function should be called only when ASTNode::getType() returns AST_REAL_E or AST_REAL. If ASTNode::getType() returns AST_REAL, this method is identical to ASTNode::getReal().

Returns
the value of the mantissa of this ASTNode.
string libsbmlcs.ASTNode.getName ( )

Get the value of this node as a string.

This function may be called on nodes that (1) are not operators, i.e., nodes for which ASTNode::isOperator() returns false, and (2) are not numbers, i.e., ASTNode::isNumber() returns false.

Returns
the value of this ASTNode as a string.
long libsbmlcs.ASTNode.getNumChildren ( )

Get the number of children that this node has.

Returns
the number of children of this ASTNode, or 0 is this node has no children.
int libsbmlcs.ASTNode.getNumerator ( )

Get the value of the numerator of this node.

This function should be called only when ASTNode::getType() == AST_RATIONAL.

Returns
the value of the numerator of this ASTNode.
long libsbmlcs.ASTNode.getNumSemanticsAnnotations ( )

Get the number of semantic annotation elements inside this node.

The <semantics> element is a MathML 2.0 construct that can be used to associate additional information with a MathML construct. The construct can be used to decorate a MathML expressions with a sequence of one or more <annotation> or <annotation-xml> elements. Each such element contains a pair of items; the first is a symbol that acts as an attribute or key, and the second is the value associated with the attribute or key. Please refer to the MathML 2.0 documentation, particularly the Section 5.2, Semantic Annotations for more information about these constructs.
Returns
the number of annotations of this ASTNode.
See Also
ASTNode::addSemanticsAnnotation(XMLNode sAnnotation)
string libsbmlcs.ASTNode.getOperatorName ( )

Get the value of this operator node as a string.

This function may be called on nodes that are operators, i.e., nodes for which ASTNode::isOperator() returns true.

Returns
the name of this operator ASTNode as a string (or null if not an operator).
SBase libsbmlcs.ASTNode.getParentSBMLObject ( )

Returns the parent SBML object.

Returns
the parent SBML object of this ASTNode.
int libsbmlcs.ASTNode.getPrecedence ( )

Get the precedence of this node in the infix math syntax of SBML Level 1.

For more information about the infix syntax, see the discussion about text string formulas at the top of the documentation for ASTNode.

Returns
an integer indicating the precedence of this ASTNode
double libsbmlcs.ASTNode.getReal ( )

Get the real-numbered value of this node.

This function should be called only when ASTNode::isReal() == true.

This function performs the necessary arithmetic if the node type is AST_REAL_E (mantissa * 10 exponent) or AST_RATIONAL (numerator / denominator).

Returns
the value of this ASTNode as a real (double).
ASTNode libsbmlcs.ASTNode.getRightChild ( )

Get the right child of this node.

Returns
the right child of this ASTNode, or null if this node has no right child. If ASTNode::getNumChildren() > 1, then this is equivalent to:
XMLNode libsbmlcs.ASTNode.getSemanticsAnnotation ( long  n)

Get the nth semantic annotation of this node.

The <semantics> element is a MathML 2.0 construct that can be used to associate additional information with a MathML construct. The construct can be used to decorate a MathML expressions with a sequence of one or more <annotation> or <annotation-xml> elements. Each such element contains a pair of items; the first is a symbol that acts as an attribute or key, and the second is the value associated with the attribute or key. Please refer to the MathML 2.0 documentation, particularly the Section 5.2, Semantic Annotations for more information about these constructs.
Returns
the nth annotation of this ASTNode, or null if this node has no nth annotation (n > ASTNode::getNumChildren() - 1).
See Also
ASTNode::addSemanticsAnnotation(XMLNode sAnnotation)
string libsbmlcs.ASTNode.getStyle ( )

Get the style of this ASTNode.

Returns
the mathml style of this ASTNode.
int libsbmlcs.ASTNode.getType ( )

Get the type of this ASTNode.

The value returned is one of the enumeration values such as AST_LAMBDA, AST_PLUS, etc.

Returns
the type of this ASTNode.
string libsbmlcs.ASTNode.getUnits ( )

Get the units of this ASTNode.

SBML Level 3 Version 1 introduced the ability to include an attribute sbml:units on MathML cn elements appearing in SBML mathematical formulas. The value of this attribute can be used to indicate the unit of measurement to be associated with the number in the content of the cn element. The value of this attribute must be the identifier of a unit of measurement defined by SBML or the enclosing Model. Here, the sbml portion is an XML namespace prefix that must be associated with the SBML namespace for SBML Level 3. The following example illustrates how this attribute can be used to define a number with value 10 and unit of measurement second:
<math xmlns="http://www.w3.org/1998/Math/MathML"
      xmlns:sbml="http://www.sbml.org/sbml/level3/version1/core">
        <cn type="integer" sbml:units="second"> 10 </cn>
</math>
Returns
the units of this ASTNode.
Note
The sbml:units attribute is only available in SBML Level 3. It may not be used in Levels 1–2 of SBML.
See Also
SBML_parseL3Formula()
bool libsbmlcs.ASTNode.hasCorrectNumberArguments ( )

Predicate returning true or false depending on whether this ASTNode has the correct number of children for it's type.

For example, an ASTNode with type AST_PLUS expects 2 child nodes.

Note
This function performs a check on the toplevel node only. Child nodes are not checked.
Returns
true if this ASTNode is has appropriate number of children for it's type, false otherwise.
See Also
isWellFormedASTNode()
bool libsbmlcs.ASTNode.hasUnits ( )

Predicate returning true (non-zero) if this node or any of its children nodes have the attribute sbml:units.

SBML Level 3 Version 1 introduced the ability to include an attribute sbml:units on MathML cn elements appearing in SBML mathematical formulas. The value of this attribute can be used to indicate the unit of measurement to be associated with the number in the content of the cn element. The value of this attribute must be the identifier of a unit of measurement defined by SBML or the enclosing Model. Here, the sbml portion is an XML namespace prefix that must be associated with the SBML namespace for SBML Level 3. The following example illustrates how this attribute can be used to define a number with value 10 and unit of measurement second:
<math xmlns="http://www.w3.org/1998/Math/MathML"
      xmlns:sbml="http://www.sbml.org/sbml/level3/version1/core">
        <cn type="integer" sbml:units="second"> 10 </cn>
</math>
Returns
true if this ASTNode or its children has units associated with it, false otherwise.
Note
The sbml:units attribute is only available in SBML Level 3. It may not be used in Levels 1–2 of SBML.
int libsbmlcs.ASTNode.insertChild ( long  n,
ASTNode  newChild 
)

Insert the given ASTNode at point n in the list of children of this ASTNode.

Parameters
nlong the index of the ASTNode being added
newChildASTNode to insert as the nth child
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
Note
Inserting a child into an ASTNode may change the structure of the mathematical formula being represented by the tree structure, and may render the representation invalid.
See Also
addChild(ASTNode child)
prependChild(ASTNode child)
replaceChild(long n, ASTNode child)
removeChild(long n)
bool libsbmlcs.ASTNode.isAvogadro ( )

Predicate returning true (non-zero) if this node is the special symbol avogadro.

The predicate returns false (zero) otherwise.

Returns
true if this ASTNode is the special symbol avogadro.
See Also
SBML_parseL3Formula()
bool libsbmlcs.ASTNode.isBoolean ( )

Predicate returning true (non-zero) if this node has a bool type (a logical operator, a relational operator, or the constants true or false).

Returns
true if this ASTNode is a bool, false otherwise.
bool libsbmlcs.ASTNode.isBvar ( )

Predicate returning true or false depending on whether this ASTNode has the correct number of children for it's type.

For example, an ASTNode with type AST_PLUS expects 2 child nodes.

Note
This function performs a check on the toplevel node only. Child nodes are not checked.
Returns
true if this ASTNode is has appropriate number of children for it's type, false otherwise.
See Also
isWellFormedASTNode()
bool libsbmlcs.ASTNode.isConstant ( )

Predicate returning true (non-zero) if this node represents a MathML constant (e.g., true, Pi).

Returns
true if this ASTNode is a MathML constant, false otherwise.
Note
this function will also return true for AST_NAME_AVOGADRO in SBML Level 3.
bool libsbmlcs.ASTNode.isFunction ( )

Predicate returning true (non-zero) if this node represents a MathML function (e.g., abs()), or an SBML Level 1 function, or a user-defined function.

Returns
true if this ASTNode is a function, false otherwise.
bool libsbmlcs.ASTNode.isInfinity ( )

Predicate returning true (non-zero) if this node represents the special IEEE 754 value infinity, false (zero) otherwise.

Returns
true if this ASTNode is the special IEEE 754 value infinity, false otherwise.
bool libsbmlcs.ASTNode.isInteger ( )

Predicate returning true (non-zero) if this node contains an integer value, false (zero) otherwise.

Returns
true if this ASTNode is of type AST_INTEGER, false otherwise.
bool libsbmlcs.ASTNode.isLambda ( )

Predicate returning true (non-zero) if this node is a MathML <lambda>, false (zero) otherwise.

Returns
true if this ASTNode is of type AST_LAMBDA, false otherwise.
bool libsbmlcs.ASTNode.isLog10 ( )

Predicate returning true (non-zero) if this node represents a log10 function, false (zero) otherwise.

More precisely, this predicate returns true if the node type is AST_FUNCTION_LOG with two children, the first of which is an AST_INTEGER equal to 10.

Returns
true if the given ASTNode represents a log10() function, false otherwise.
See Also
SBML_parseL3Formula()
bool libsbmlcs.ASTNode.isLogical ( )

Predicate returning true (non-zero) if this node is a MathML logical operator (i.e., and, or, not, xor).

Returns
true if this ASTNode is a MathML logical operator
bool libsbmlcs.ASTNode.isName ( )

Predicate returning true (non-zero) if this node is a user-defined variable name in SBML L1, L2 (MathML), or the special symbols delay or time.

The predicate returns false (zero) otherwise.

Returns
true if this ASTNode is a user-defined variable name in SBML L1, L2 (MathML) or the special symbols delay or time.
bool libsbmlcs.ASTNode.isNaN ( )

Predicate returning true (non-zero) if this node represents the special IEEE 754 value 'not a number' (NaN), false (zero) otherwise.

Returns
true if this ASTNode is the special IEEE 754 NaN.
bool libsbmlcs.ASTNode.isNegInfinity ( )

Predicate returning true (non-zero) if this node represents the special IEEE 754 value 'negative infinity', false (zero) otherwise.

Returns
true if this ASTNode is the special IEEE 754 value negative infinity, false otherwise.
bool libsbmlcs.ASTNode.isNumber ( )

Predicate returning true (non-zero) if this node contains a number, false (zero) otherwise.

This is functionally equivalent to the following code:

Returns
true if this ASTNode is a number, false otherwise.
bool libsbmlcs.ASTNode.isOperator ( )

Predicate returning true (non-zero) if this node is a mathematical operator, meaning, +, -, *, / or ^ (power).

Returns
true if this ASTNode is an operator.
bool libsbmlcs.ASTNode.isPiecewise ( )

Predicate returning true (non-zero) if this node is the MathML <piecewise> construct, false (zero) otherwise.

Returns
true if this ASTNode is a MathML piecewise function
bool libsbmlcs.ASTNode.isRational ( )

Predicate returning true (non-zero) if this node represents a rational number, false (zero) otherwise.

Returns
true if this ASTNode is of type AST_RATIONAL.
bool libsbmlcs.ASTNode.isReal ( )

Predicate returning true (non-zero) if this node can represent a real number, false (zero) otherwise.

More precisely, this node must be of one of the following types: AST_REAL, AST_REAL_E or AST_RATIONAL.

Returns
true if the value of this ASTNode can represented as a real number, false otherwise.
bool libsbmlcs.ASTNode.isRelational ( )

Predicate returning true (non-zero) if this node is a MathML relational operator, meaning ==, >=, >, <, and !=.

Returns
true if this ASTNode is a MathML relational operator, false otherwise
bool libsbmlcs.ASTNode.isSetClass ( )

Predicate returning true (non-zero) if this node has the mathml attribute class.

Returns
true if this ASTNode has an attribute class, false otherwise.
bool libsbmlcs.ASTNode.isSetId ( )

Predicate returning true (non-zero) if this node has the mathml attribute id.

Returns
true if this ASTNode has an attribute id, false otherwise.
bool libsbmlcs.ASTNode.isSetStyle ( )

Predicate returning true (non-zero) if this node has the mathml attribute style.

Returns
true if this ASTNode has an attribute style, false otherwise.
bool libsbmlcs.ASTNode.isSetUnits ( )

Predicate returning true (non-zero) if this node has the attribute sbml:units.

SBML Level 3 Version 1 introduced the ability to include an attribute sbml:units on MathML cn elements appearing in SBML mathematical formulas. The value of this attribute can be used to indicate the unit of measurement to be associated with the number in the content of the cn element. The value of this attribute must be the identifier of a unit of measurement defined by SBML or the enclosing Model. Here, the sbml portion is an XML namespace prefix that must be associated with the SBML namespace for SBML Level 3. The following example illustrates how this attribute can be used to define a number with value 10 and unit of measurement second:
<math xmlns="http://www.w3.org/1998/Math/MathML"
      xmlns:sbml="http://www.sbml.org/sbml/level3/version1/core">
        <cn type="integer" sbml:units="second"> 10 </cn>
</math>
Returns
true if this ASTNode has units associated with it, false otherwise.
Note
The sbml:units attribute is only available in SBML Level 3. It may not be used in Levels 1–2 of SBML.
bool libsbmlcs.ASTNode.isSqrt ( )

Predicate returning true (non-zero) if this node represents a square root function, false (zero) otherwise.

More precisely, the node type must be AST_FUNCTION_ROOT with two children, the first of which is an AST_INTEGER node having value equal to 2.

Returns
true if the given ASTNode represents a sqrt() function, false otherwise.
bool libsbmlcs.ASTNode.isUMinus ( )

Predicate returning true (non-zero) if this node is a unary minus operator, false (zero) otherwise.

A node is defined as a unary minus node if it is of type AST_MINUS and has exactly one child.

For numbers, unary minus nodes can be 'collapsed' by negating the number. In fact, libsbmlcs.libsbml.parseFormula() does this during its parsing process, and SBML_parseL3Formula() has a configuration option that allows this behavior to be turned on or off. However, unary minus nodes for symbols (AST_NAME) cannot be 'collapsed', so this predicate function is necessary.

Returns
true if this ASTNode is a unary minus, false otherwise.
See Also
SBML_parseL3Formula()
bool libsbmlcs.ASTNode.isUnknown ( )

Predicate returning true (non-zero) if this node has an unknown type.

'Unknown' nodes have the type AST_UNKNOWN. Nodes with unknown types will not appear in an ASTNode tree returned by libSBML based upon valid SBML input; the only situation in which a node with type AST_UNKNOWN may appear is immediately after having create a new, untyped node using the ASTNode constructor. Callers creating nodes should endeavor to set the type to a valid node type as soon as possible after creating new nodes.

Returns
true if this ASTNode is of type AST_UNKNOWN, false otherwise.
bool libsbmlcs.ASTNode.isUPlus ( )

Predicate returning true (non-zero) if this node is a unary plus operator, false (zero) otherwise.

A node is defined as a unary minus node if it is of type AST_MINUS and has exactly one child.

Returns
true if this ASTNode is a unary plus, false otherwise.
bool libsbmlcs.ASTNode.isWellFormedASTNode ( )

Predicate returning true or false depending on whether this ASTNode is well-formed.

Note
An ASTNode may be well-formed, with each node and its children having the appropriate number of children for the given type, but may still be invalid in the context of its use within an SBML model.
Returns
true if this ASTNode is well-formed, false otherwise.
See Also
hasCorrectNumberArguments()
void libsbmlcs.ASTNode.multiplyTimeBy ( ASTNode  function)

Replaces any 'AST_NAME_TIME' nodes with a node that multiplies time by the given function.

static bool libsbmlcs.ASTNode.operator!= ( ASTNode  lhs,
ASTNode  rhs 
)
static
static bool libsbmlcs.ASTNode.operator== ( ASTNode  lhs,
ASTNode  rhs 
)
static
int libsbmlcs.ASTNode.prependChild ( ASTNode  child)

Adds the given node as a child of this ASTNode.

This method adds child nodes from right to left.

Parameters
childthe ASTNode instance to add
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
Note
Prepending a child to an ASTNode may change the structure of the mathematical formula being represented by the tree structure, and may render the representation invalid.
See Also
addChild(ASTNode child)
replaceChild(long n, ASTNode child)
insertChild(long n, ASTNode child)
removeChild(long n)
void libsbmlcs.ASTNode.reduceToBinary ( )

Reduces this ASTNode to a binary tree.

Example: if this ASTNode is and(x, y, z), then the formula of the reduced node is and(and(x, y), z). The operation replaces the formula stored in the current ASTNode object.

int libsbmlcs.ASTNode.removeChild ( long  n)

Removes the nth child of this ASTNode object.

Parameters
nlong the index of the child to remove
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
Note
Removing a child from an ASTNode may change the structure of the mathematical formula being represented by the tree structure, and may render the representation invalid.
See Also
addChild(ASTNode child)
prependChild(ASTNode child)
replaceChild(long n, ASTNode child)
insertChild(long n, ASTNode child)
void libsbmlcs.ASTNode.renameSIdRefs ( string  oldid,
string  newid 
)

Renames all the SIdRef attributes on this node and any child node.

void libsbmlcs.ASTNode.renameUnitSIdRefs ( string  oldid,
string  newid 
)

Renames all the UnitSIdRef attributes on this node and any child node.

(The only place UnitSIDRefs appear in MathML <cn> elements.)

void libsbmlcs.ASTNode.replaceArgument ( string  bvar,
ASTNode  arg 
)

Replaces occurences of a given name within this ASTNode with the name/value/formula represented by arg.

For example, if the formula in this ASTNode is x + y, then the <bvar> is x and arg is an ASTNode representing the real value 3. This method substitutes 3 for x within this ASTNode object.

Parameters
bvara string representing the variable name to be substituted
argan ASTNode representing the name/value/formula to substitute
int libsbmlcs.ASTNode.replaceChild ( long  n,
ASTNode  newChild 
)

Replaces the nth child of this ASTNode with the given ASTNode.

Parameters
nlong the index of the child to replace
newChildASTNode to replace the nth child
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
Note
Replacing a child from an ASTNode may change the structure of the mathematical formula being represented by the tree structure, and may render the representation invalid.
See Also
addChild(ASTNode child)
prependChild(ASTNode child)
insertChild(long n, ASTNode child)
removeChild(long n)
void libsbmlcs.ASTNode.replaceIDWithFunction ( string  id,
ASTNode  function 
)

Replace any nodes of type AST_NAME with the name 'id' from the child 'math' object with the provided ASTNode.

bool libsbmlcs.ASTNode.returnsBoolean ( Model  model)

Predicate returning true (non-zero) if this node returns a bool type or false (zero) otherwise.

This function looks at the whole ASTNode rather than just the top level of the ASTNode. Thus it will consider return values from piecewise statements. In addition, if this ASTNode uses a function call, the return value of the functionDefinition will be determined. Note that this is only possible where the ASTNode can trace its parent Model, that is, the ASTNode must represent the math element of some SBML object that has already been added to an instance of an SBMLDocument.

See Also
isBoolean()
Returns
true if this ASTNode returns a bool, false otherwise.
bool libsbmlcs.ASTNode.returnsBoolean ( )

Predicate returning true (non-zero) if this node returns a bool type or false (zero) otherwise.

This function looks at the whole ASTNode rather than just the top level of the ASTNode. Thus it will consider return values from piecewise statements. In addition, if this ASTNode uses a function call, the return value of the functionDefinition will be determined. Note that this is only possible where the ASTNode can trace its parent Model, that is, the ASTNode must represent the math element of some SBML object that has already been added to an instance of an SBMLDocument.

See Also
isBoolean()
Returns
true if this ASTNode returns a bool, false otherwise.
void libsbmlcs.ASTNode.setBvar ( )

Predicate returning true or false depending on whether this ASTNode has the correct number of children for it's type.

For example, an ASTNode with type AST_PLUS expects 2 child nodes.

Note
This function performs a check on the toplevel node only. Child nodes are not checked.
Returns
true if this ASTNode is has appropriate number of children for it's type, false otherwise.
See Also
isWellFormedASTNode()
int libsbmlcs.ASTNode.setCharacter ( char  value)

Sets the value of this ASTNode to the given character.

If character is one of +, -, *, / or ^, the node type will be set accordingly. For all other characters, the node type will be set to AST_UNKNOWN.

Parameters
valuethe character value to which the node's value should be set.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.ASTNode.setClass ( string  className)

Sets the mathml class of this ASTNode to className.

Parameters
classNamestring representing the mathml class for this node.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.ASTNode.setId ( string  id)

Sets the mathml id of this ASTNode to id.

Parameters
idstring representing the identifier.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.ASTNode.setName ( string  name)

Sets the value of this ASTNode to the given name.

As a side-effect, this ASTNode object's type will be reset to AST_NAME if (and only if) the ASTNode was previously an operator ( ASTNode::isOperator() == true), number ( ASTNode::isNumber() == true), or unknown. This allows names to be set for AST_FUNCTION nodes and the like.

Parameters
namethe string containing the name to which this node's value should be set
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.ASTNode.setStyle ( string  style)

Sets the mathml style of this ASTNode to style.

Parameters
stylestring representing the identifier.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.ASTNode.setType ( int  type)

Sets the type of this ASTNode to the given type code.

A side-effect of doing this is that any numerical values previously stored in this node are reset to zero.

Parameters
typethe type to which this node should be set
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.ASTNode.setUnits ( string  units)

Sets the units of this ASTNode to units.

The units will be set only if this ASTNode object represents a MathML <cn> element, i.e., represents a number. Callers may use ASTNode::isNumber() to inquire whether the node is of that type.

SBML Level 3 Version 1 introduced the ability to include an attribute sbml:units on MathML cn elements appearing in SBML mathematical formulas. The value of this attribute can be used to indicate the unit of measurement to be associated with the number in the content of the cn element. The value of this attribute must be the identifier of a unit of measurement defined by SBML or the enclosing Model. Here, the sbml portion is an XML namespace prefix that must be associated with the SBML namespace for SBML Level 3. The following example illustrates how this attribute can be used to define a number with value 10 and unit of measurement second:
<math xmlns="http://www.w3.org/1998/Math/MathML"
      xmlns:sbml="http://www.sbml.org/sbml/level3/version1/core">
        <cn type="integer" sbml:units="second"> 10 </cn>
</math>
Parameters
unitsstring representing the unit identifier.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
Note
The sbml:units attribute is only available in SBML Level 3. It may not be used in Levels 1–2 of SBML.
int libsbmlcs.ASTNode.setValue ( int  value)

Sets the value of this ASTNode to the given (long) integer and sets the node type to AST_INTEGER.

Parameters
valuethe integer to which this node's value should be set
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.ASTNode.setValue ( int  numerator,
int  denominator 
)

Sets the value of this ASTNode to the given rational in two parts: the numerator and denominator.

The node type is set to AST_RATIONAL.

Parameters
numeratorthe numerator value of the rational
denominatorthe denominator value of the rational
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.ASTNode.setValue ( double  value)

Sets the value of this ASTNode to the given real (double) and sets the node type to AST_REAL.

This is functionally equivalent to:

setValue(value, 0);
Parameters
valuethe double format number to which this node's value should be set
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.ASTNode.setValue ( double  mantissa,
int  exponent 
)

Sets the value of this ASTNode to the given real (double) in two parts: the mantissa and the exponent.

The node type is set to AST_REAL_E.

Parameters
mantissathe mantissa of this node's real-numbered value
exponentthe exponent of this node's real-numbered value
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.ASTNode.swapChildren ( ASTNode  that)

Swap the children of this ASTNode object with the children of the given ASTNode object.

Parameters
thatthe other node whose children should be used to replace this node's children
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.ASTNode.unsetClass ( )

Unsets the mathml class of this ASTNode.

Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.ASTNode.unsetId ( )

Unsets the mathml id of this ASTNode.

Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.ASTNode.unsetStyle ( )

Unsets the mathml style of this ASTNode.

Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.ASTNode.unsetUnits ( )

Unsets the units of this ASTNode.

Returns
integer value indicating success/failure of the function. The possible values returned by this function are:

Member Data Documentation

bool libsbmlcs.ASTNode.swigCMemOwn
protected