libSBML C API  libSBML 5.20.4 C API
Loading...
Searching...
No Matches
ASTNode.cpp File Reference

Abstract Syntax Tree (AST) for representing formula trees. More...

Include dependency graph for ASTNode.cpp:

Macros

#define ASTNodeType_isAvogadro(t)    (t == AST_NAME_AVOGADRO)
 @_tendcond_t
 
#define ASTNodeType_isConstant(t)    (((t >= AST_CONSTANT_E) && (t <= AST_CONSTANT_TRUE)) || t == AST_NAME_AVOGADRO)
 _tASTNodeType_t _tpredicate_t
 
#define ASTNodeType_isConstantNumber(t)    (t == AST_CONSTANT_E || t == AST_CONSTANT_PI || t == AST_NAME_AVOGADRO)
 _tASTNodeType_t _tpredicate_t
 
#define ASTNodeType_isFunction(t)    (((t >= AST_FUNCTION) && (t <= AST_FUNCTION_TANH)) || t == AST_CSYMBOL_FUNCTION)
 _tASTNodeType_t _tpredicate_t
 
#define ASTNodeType_isInteger(t)    (t == AST_INTEGER)
 _tASTNodeType_t _tpredicate_t
 
#define ASTNodeType_isLambda(t)    (t == AST_LAMBDA)
 _tASTNodeType_t _tpredicate_t
 
#define ASTNodeType_isLogical(t)    (((t >= AST_LOGICAL_AND) && (t <= AST_LOGICAL_XOR)))
 _tASTNodeType_t _tpredicate_t
 
#define ASTNodeType_isName(t)    ((t >= AST_NAME) && (t <= AST_NAME_TIME))
 _tASTNodeType_t _tpredicate_t
 
#define ASTNodeType_isNumber(t)    (ASTNodeType_isInteger(t) || ASTNodeType_isReal(t))
 _tASTNodeType_t _tpredicate_t
 
#define ASTNodeType_isOperator(t)
 _tASTNodeType_t _tpredicate_t
 
#define ASTNodeType_isRational(t)    (t == AST_RATIONAL)
 _tASTNodeType_t _tpredicate_t
 
#define ASTNodeType_isReal(t)    ((t >= AST_REAL) && (t <= AST_RATIONAL))
 _tASTNodeType_t _tpredicate_t
 
#define ASTNodeType_isRelational(t)    ((t >= AST_RELATIONAL_EQ) && (t <= AST_RELATIONAL_NEQ))
 _tASTNodeType_t _tpredicate_t
 
#define ASTNodeType_isUnknown(t)    (t == AST_UNKNOWN)
 _tASTNodeType_t _tpredicate_t
 

Functions

int ASTNode_addChild (ASTNode_t *node, ASTNode_t *child)
 _tAdds_t _ta_t _tnode_t _tas_t _ta_t _tchild_t _tof_t _tanother_t _tnode_t.
 
int ASTNode_addSemanticsAnnotation (ASTNode_t *node, XMLNode_t *annotation)
 @_tendcond_t
 
int ASTNode_canonicalize (ASTNode_t *node)
 _tConverts_t _ta_t _tgiven_t _tnode_t _tto_t _ta_t _tcanonical_t _tform_t _tand_t _treturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tsuccessful_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.
 
ASTNode_tASTNode_create (void)
 @_tcond_t _tdoxygenIgnored_t
 
ASTNode_tASTNode_createFromToken (Token_t *token)
 _tCreates_t _ta_t _tnew_t _tASTNode_t_t _tstructure_t _tfrom_t _tthe_t _tgiven_t _tToken_t_t _tdata_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
ASTNode_tASTNode_createWithType (ASTNodeType_t type)
 _tCreates_t _ta_t _tnew_t _tASTNode_t_t _tstructure_t _tand_t _tsets_t _tits_t _ttype_t.
 
ASTNode_tASTNode_deepCopy (const ASTNode_t *node)
 _tCreates_t _ta_t _trecursive_t _tcopy_t _tof_t _ta_t _tnode_t _tand_t _tall_t _tits_t _tchildren_t.
 
void ASTNode_fillListOfNodes (const ASTNode_t *node, ASTNodePredicate predicate, List_t *lst)
 _tReturns_t _ta_t _tlist_t _tof_t _tnodes_t _trooted_t _tat_t _ta_t _tgiven_t _tnode_t _tand_t _tsatisfying_t _ta_t _tgiven_t _tpredicate_t.
 
void ASTNode_free (ASTNode_t *node)
 _tFrees_t _tthe_t _tgiven_t _tASTNode_t_t _tstructure_t, _tincluding_t _tany_t _tchild_t _tnodes_t.
 
int ASTNode_freeName (ASTNode_t *node)
 _tFrees_t _tthe_t _tname_t _tfield_t _tof_t _ta_t _tgiven_t _tnode_t _tand_t _tsets_t _tit_t _tto_t _tnull_t.
 
char ASTNode_getCharacter (const ASTNode_t *node)
 _tReturns_t _tthe_t _tvalue_t _tof_t _ta_t _tnode_t _tas_t _ta_t _tsingle_t _tcharacter_t.
 
ASTNode_tASTNode_getChild (const ASTNode_t *node, unsigned int n)
 _tReturns_t _ta_t _tchild_t _tof_t _ta_t _tnode_t _taccording_t _tto_t _tits_t _tindex_t _tnumber_t.
 
char * ASTNode_getClass (const ASTNode_t *node)
 _tReturns_t _tthe_t _tMathML_t @_tc_t _tclass_t _tattribute_t _tof_t _ta_t _tgiven_t _tnode_t.
 
XMLAttributes_tASTNode_getDefinitionURL (ASTNode_t *node)
 _tReturns_t _tthe_t _tMathML_t @_tc_t _tdefinitionURL_t _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tnode_t.
 
char * ASTNode_getDefinitionURLString (ASTNode_t *node)
 _tReturns_t _tthe_t _tMathML_t @_tc_t _tdefinitionURL_t _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tnode_t _tas_t _ta_t _tstring_t.
 
long ASTNode_getDenominator (const ASTNode_t *node)
 _tReturns_t _tthe_t _tnumerator_t _tvalue_t _tof_t _ta_t _tnode_t _trepresenting_t _ta_t _trational_t _tnumber_t.
 
long ASTNode_getExponent (const ASTNode_t *node)
 _tGet_t _tthe_t _texponent_t _tvalue_t _tof_t _ta_t _tnode_t.
 
char * ASTNode_getId (const ASTNode_t *node)
 _tReturns_t _tthe_t _tMathML_t @_tc_t _tid_t _tattribute_t _tof_t _ta_t _tgiven_t _tnode_t.
 
long ASTNode_getInteger (const ASTNode_t *node)
 _tReturns_t _tthe_t _tvalue_t _tof_t _ta_t _tnode_t _tas_t _tan_t _tinteger_t.
 
ASTNode_tASTNode_getLeftChild (const ASTNode_t *node)
 _tReturns_t _tthe_t _tleft_t-_tmost_t _tchild_t _tof_t _ta_t _tgiven_t _tnode_t.
 
List_tASTNode_getListOfNodes (const ASTNode_t *node, ASTNodePredicate predicate)
 _tReturns_t _ta_t _tlist_t _tof_t _tnodes_t _trooted_t _tat_t _ta_t _tgiven_t _tnode_t _tand_t _tsatisfying_t _ta_t _tgiven_t _tpredicate_t.
 
double ASTNode_getMantissa (const ASTNode_t *node)
 _tGet_t _tthe_t _tmantissa_t _tvalue_t _tof_t _ta_t _tnode_t.
 
const char * ASTNode_getName (const ASTNode_t *node)
 _tReturns_t _tthe_t _tvalue_t _tof_t _ta_t _tnode_t _tas_t _ta_t _tstring_t.
 
unsigned int ASTNode_getNumChildren (const ASTNode_t *node)
 _tReturns_t _tthe_t _tnumber_t _tof_t _tchildren_t _tof_t _ta_t _tgiven_t _tnode_t.
 
long ASTNode_getNumerator (const ASTNode_t *node)
 _tReturns_t _tthe_t _tnumerator_t _tvalue_t _tof_t _ta_t _tnode_t _trepresenting_t _ta_t _trational_t _tnumber_t.
 
unsigned int ASTNode_getNumSemanticsAnnotations (ASTNode_t *node)
 _tReturns_t _tthe_t _tnumber_t _tof_t _tMathML_t _tsemantic_t _tannotations_t _tinside_t _tthe_t _tgiven_t _tnode_t.
 
SBase_tASTNode_getParentSBMLObject (ASTNode_t *node)
 _tReturns_t _tthe_t _tparent_t _tSBase_t_t _tstructure_t _tcontaining_t _tthe_t _tgiven_t _tnode_t.
 
int ASTNode_getPrecedence (const ASTNode_t *node)
 _tReturns_t _tthe_t _tprecedence_t _tof_t _ta_t _tnode_t _tin_t _tthe_t _tinfix_t _tmath_t _tsyntax_t _tof_t _tSBML_t _tLevel_t&_tnbsp_t;_t1_t.
 
double ASTNode_getReal (const ASTNode_t *node)
 _tGet_t _tthe_t _treal_t-_tnumbered_t _tvalue_t _tof_t _ta_t _tnode_t.
 
ASTNode_tASTNode_getRightChild (const ASTNode_t *node)
 _tReturns_t _tthe_t _tright_t-_tmost_t _tchild_t _tof_t _ta_t _tgiven_t _tnode_t.
 
XMLNode_tASTNode_getSemanticsAnnotation (ASTNode_t *node, unsigned int n)
 _tReturns_t _tthe_t _tnth_t _tMathML_t _tsemantic_t _tannotation_t _tattached_t _tto_t _tthe_t _tgiven_t _tnode_t.
 
char * ASTNode_getStyle (const ASTNode_t *node)
 _tReturns_t _tthe_t _tMathML_t @_tc_t _tstyle_t _tattribute_t _tof_t _ta_t _tgiven_t _tnode_t.
 
ASTNodeType_t ASTNode_getType (const ASTNode_t *node)
 _tReturns_t _tthe_t _ttype_t _tof_t _tthe_t _tgiven_t _tnode_t.
 
char * ASTNode_getUnits (const ASTNode_t *node)
 _tReturns_t _tthe_t _tSBML_t "_tunits_t" _tattribute_t _tof_t _ta_t _tgiven_t _tnode_t.
 
void * ASTNode_getUserData (const ASTNode_t *node)
 _tReturns_t _tthe_t _tuser_t _tdata_t _tassociated_t _twith_t _tthis_t _tnode_t.
 
double ASTNode_getValue (const ASTNode_t *node)
 _tReturns_t _tthe_t _tnumerical_t _tvalue_t _tof_t _tthis_t _tASTNode_t_t.
 
int ASTNode_hasCorrectNumberArguments (ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _thas_t _tthe_t _tcorrect_t _tnumber_t _tof_t _tchildren_t _tfor_t _tits_t _ttype_t.
 
int ASTNode_hasTypeAndNumChildren (const ASTNode_t *node, ASTNodeType_t type, unsigned int numchildren)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tis_t _tof_t _ta_t _tspecific_t _ttype_t _tand_t _thas_t _ta_t _tspecific_t _tnumber_t _tof_t _tchildren_t.
 
int ASTNode_hasUnits (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tor_t _tany_t _tof_t _tits_t _tchildren_t _thave_t _tthe_t _tSBML_t "_tunits_t" _tattribute_t _tset_t.
 
int ASTNode_insertChild (ASTNode_t *node, unsigned int n, ASTNode_t *newChild)
 _tInsert_t _ta_t _tnew_t _tchild_t _tnode_t _tat_t _ta_t _tgiven_t _tpoint_t _tin_t _tthe_t _tlist_t _tof_t _tchildren_t _tof_t _ta_t _tnode_t.
 
int ASTNode_isAvogadro (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _trepresents_t _tthe_t _tspecial_t _tsymbol_t @_tc_t _tavogadro_t.
 
int ASTNode_isBoolean (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tnode_t _tis_t _tsome_t _ttype_t _tof_t _tBoolean_t _tvalue_t _tor_t _toperator_t.
 
int ASTNode_isConstant (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _trepresents_t _ta_t _tMathML_t _tconstant_t.
 
int ASTNode_isConstantNumber (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _trepresents_t _ta_t _tMathML_t _tconstant_t.
 
int ASTNode_isFunction (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _trepresents_t _ta_t _tfunction_t.
 
int ASTNode_isInfinity (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tstands_t _tfor_t _tinfinity_t.
 
int ASTNode_isInteger (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tcontains_t _tan_t _tinteger_t _tvalue_t.
 
int ASTNode_isLambda (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tis_t _ta_t _tMathML_t _tlambda_t _tfunction_t.
 
int ASTNode_isLog10 (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _trepresents_t _tthe_t _tlog_t _tbase_t-_t10_t _tfunction_t.
 
int ASTNode_isLogical (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tis_t _ta_t _tlogical_t _toperator_t.
 
int ASTNode_isName (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tis_t _ta_t _tnamed_t _tentity_t.
 
int ASTNode_isNaN (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _trepresents_t _tnot_t-_ta_t-_tnumber_t.
 
int ASTNode_isNegInfinity (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _trepresents_t _tnegative_t _tinfinity_t.
 
int ASTNode_isNumber (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tcontains_t _ta_t _tnumber_t.
 
int ASTNode_isOperator (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tis_t _ta_t _tmathematical_t _toperator_t.
 
int ASTNode_isPiecewise (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _trepresents_t _tthe_t _tMathML_t <_tcode_t>&_tlt_t;_tpiecewise_t&_tgt_t;</_tcode_t> _toperator_t.
 
int ASTNode_isRational (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _trepresents_t _ta_t _trational_t _tnumber_t.
 
int ASTNode_isReal (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _trepresents_t _ta_t _treal_t _tnumber_t.
 
int ASTNode_isRelational (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _trepresents_t _ta_t _tMathML_t _trelational_t _toperator_t.
 
int ASTNode_isSetClass (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t'_ts_t _tMathML_t @_tc_t _tclass_t _tattribute_t _tis_t _tset_t.
 
int ASTNode_isSetId (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t'_ts_t _tMathML_t @_tc_t _tid_t _tattribute_t _tis_t _tset_t.
 
int ASTNode_isSetParentSBMLObject (ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t'_ts_t _tparent_t _tSBML_t _tobject_t _tis_t _tset_t.
 
int ASTNode_isSetStyle (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t'_ts_t _tMathML_t @_tc_t _tstyle_t _tattribute_t _tis_t _tset_t.
 
int ASTNode_isSetUnits (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tnode_t'_ts_t _tSBML_t "_tunits_t" _tattribute_t _tis_t _tset_t.
 
int ASTNode_isSetUserData (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t'_ts_t _tuser_t _tdata_t _tobject_t _tis_t _tset_t.
 
int ASTNode_isSqrt (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tis_t _tthe_t _tMathML_t _tsquare_t-_troot_t _toperator_t.
 
int ASTNode_isUMinus (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _trepresents_t _ta_t _tunary_t _tminus_t.
 
int ASTNode_isUnknown (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _ttype_t _tof_t _tthe_t _tnode_t _tis_t _tunknown_t.
 
int ASTNode_isUPlus (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tis_t _ta_t _tunary_t _tplus_t.
 
int ASTNode_isWellFormedASTNode (ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tis_t _twell_t-_tformed_t.
 
int ASTNode_prependChild (ASTNode_t *node, ASTNode_t *child)
 _tAdds_t _ta_t _tnode_t _tas_t _ta_t _tchild_t _tof_t _tanother_t _tnode_t.
 
void ASTNode_reduceToBinary (ASTNode_t *node)
 _tReduces_t _tthe_t _tgiven_t _tnode_t _tto_t _ta_t _tbinary_t _ttrue_t.
 
int ASTNode_removeChild (ASTNode_t *node, unsigned int n)
 _tRemoves_t _tthe_t _tnth_t _tchild_t _tof_t _ta_t _tgiven_t _tnode_t.
 
int ASTNode_replaceAndDeleteChild (ASTNode_t *node, unsigned int n, ASTNode_t *newChild)
 _tReplaces_t _tand_t _tdeletes_t _tthe_t _tnth_t _tchild_t _tof_t _ta_t _tgiven_t _tnode_t.
 
void ASTNode_replaceArgument (ASTNode_t *node, const char *bvar, ASTNode_t *arg)
 _tReplaces_t _toccurrences_t _tof_t _ta_t _tgiven_t _tname_t _twith_t _ta_t _tnew_t _tASTNode_t_t _tstructure_t.
 
int ASTNode_replaceChild (ASTNode_t *node, unsigned int n, ASTNode_t *newChild)
 _tReplaces_t _tbut_t _tdoes_t _tnot_t _tdelete_t _tthe_t _tnth_t _tchild_t _tof_t _ta_t _tgiven_t _tnode_t.
 
int ASTNode_returnsBoolean (const ASTNode_t *node)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tis_t _tsomething_t _tthat_t _treturns_t _ta_t _tBoolean_t _tvalue_t.
 
int ASTNode_returnsBooleanForModel (const ASTNode_t *node, const Model_t *model)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tis_t _tsomething_t _tthat_t _treturns_t _ta_t _tBoolean_t _tvalue_t.
 
int ASTNode_setCharacter (ASTNode_t *node, char value)
 _tSets_t _tthe_t _tvalue_t _tof_t _ta_t _tgiven_t _tnode_t _tto_t _ta_t _tcharacter_t.
 
int ASTNode_setClass (ASTNode_t *node, const char *className)
 _tSets_t _tthe_t _tMathML_t @_tc_t _tclass_t _tof_t _tthe_t _tgiven_t _tnode_t.
 
int ASTNode_setDefinitionURL (ASTNode_t *node, XMLAttributes_t defnURL)
 
int ASTNode_setDefinitionURLString (ASTNode_t *node, const char *defnURL)
 _tSets_t _tthe_t _tMathML_t @_tc_t _tdefinitionURL_t _tattribute_t _tof_t _tthe_t _tgiven_t _tnode_t.
 
int ASTNode_setId (ASTNode_t *node, const char *id)
 _tSets_t _tthe_t _tMathML_t @_tc_t _tid_t _tattribute_t _tof_t _tthe_t _tgiven_t _tnode_t.
 
int ASTNode_setInteger (ASTNode_t *node, long value)
 _tSets_t _tthe_t _tgiven_t _tnode_t _tto_t _ta_t _tinteger_t _tand_t _tsets_t _tit_t _ttype_t _tto_t @_tsbmlconstant_t{_tAST_INTEGER_t, _tASTNodeType_t_t}.
 
int ASTNode_setName (ASTNode_t *node, const char *name)
 _tSets_t _tthe_t _tnode_t _tto_t _trepresent_t _ta_t _tnamed_t _tentity_t.
 
void ASTNode_setParentSBMLObject (ASTNode_t *node, SBase_t *sb)
 @_tcond_t _tdoxygenLibsbmlInternal_t
 
int ASTNode_setRational (ASTNode_t *node, long numerator, long denominator)
 _tSets_t _tthe_t _tvalue_t _tof_t _ta_t _tgiven_t _tnode_t _tto_t _ta_t _trational_t _tnumber_t _tand_t _tsets_t _tits_t _ttype_t _tto_t @_tsbmlconstant_t{_tAST_RATIONAL_t, _tASTNodeType_t_t}.
 
int ASTNode_setReal (ASTNode_t *node, double value)
 _tSets_t _tthe_t _tvalue_t _tof_t _ta_t _tgiven_t _tnode_t _tto_t _ta_t _treal_t (@_tc_t _tdouble_t) _tand_t _tsets_t _tits_t _ttype_t _tto_t @_tsbmlconstant_t{_tAST_REAL_t, _tASTNodeType_t_t}.
 
int ASTNode_setRealWithExponent (ASTNode_t *node, double mantissa, long exponent)
 _tSets_t _tthe_t _tvalue_t _tof_t _ta_t _tgiven_t _tnode_t _tto_t _ta_t _treal_t (@_tc_t _tdouble_t) _tin_t _ttwo_t _tparts_t, _ta_t _tmantissa_t _tand_t _tan_t _texponent_t.
 
int ASTNode_setStyle (ASTNode_t *node, const char *style)
 _tSets_t _tthe_t _tMathML_t @_tc_t _tstyle_t _tof_t _tthe_t _tgiven_t _tnode_t.
 
int ASTNode_setType (ASTNode_t *node, ASTNodeType_t type)
 _tExplicitly_t _tsets_t _tthe_t _ttype_t _tof_t _tthe_t _tgiven_t _tASTNode_t_t _tstructure_t.
 
int ASTNode_setUnits (ASTNode_t *node, const char *units)
 _tSets_t _tthe_t _tunits_t _tof_t _tthe_t _tgiven_t _tnode_t.
 
int ASTNode_setUserData (ASTNode_t *node, void *userData)
 _tSets_t _tthe_t _tuser_t _tdata_t _tof_t _tthe_t _tgiven_t _tnode_t.
 
int ASTNode_swapChildren (ASTNode_t *node, ASTNode_t *that)
 _tSwaps_t _tthe_t _tchildren_t _tof_t _ttwo_t _tnodes_t.
 
int ASTNode_true (const ASTNode *node)
 @_tcond_t _tdoxygenLibsbmlInternal_t
 
int ASTNode_unsetClass (ASTNode_t *node)
 _tUnsets_t _tthe_t _tMathML_t @_tc_t _tclass_t _tattribute_t _tof_t _tthe_t _tgiven_t _tnode_t.
 
int ASTNode_unsetId (ASTNode_t *node)
 _tUnsets_t _tthe_t _tMathML_t @_tc_t _tid_t _tattribute_t _tof_t _tthe_t _tgiven_t _tnode_t.
 
int ASTNode_unsetParentSBMLObject (ASTNode_t *node)
 _tUnsets_t _tthe_t _tparent_t _tSBase_t_t _tstructure_t.
 
int ASTNode_unsetStyle (ASTNode_t *node)
 _tUnsets_t _tthe_t _tMathML_t @_tc_t _tstyle_t _tattribute_t _tof_t _tthe_t _tgiven_t _tnode_t.
 
int ASTNode_unsetUnits (ASTNode_t *node)
 _tUnsets_t _tthe_t _tunits_t _tassociated_t _twith_t _tthe_t _tgiven_t _tnode_t.
 
int ASTNode_unsetUserData (ASTNode_t *node)
 _tUnsets_t _tthe_t _tuser_t _tdata_t _tof_t _tthe_t _tgiven_t _tnode_t.
 

Variables

static const char * AST_CONSTANT_STRINGS []
 
static const char * AST_FUNCTION_STRINGS []
 
static const char * AST_LAMBDA_STRING = "lambda"
 _tString_t _tConstants_t
 
static const char * AST_LOGICAL_STRINGS []
 
static const char * AST_OPERATOR_STRINGS []
 
static const char * AST_RELATIONAL_STRINGS []
 

Detailed Description

Abstract Syntax Tree (AST) for representing formula trees.

Author
Ben Bornstein

Macro Definition Documentation

◆ ASTNodeType_isAvogadro

#define ASTNodeType_isAvogadro (   t)     (t == AST_NAME_AVOGADRO)

@_tendcond_t

_tASTNodeType_t _tpredicate_t

◆ ASTNodeType_isConstant

#define ASTNodeType_isConstant (   t)     (((t >= AST_CONSTANT_E) && (t <= AST_CONSTANT_TRUE)) || t == AST_NAME_AVOGADRO)

_tASTNodeType_t _tpredicate_t

◆ ASTNodeType_isConstantNumber

#define ASTNodeType_isConstantNumber (   t)     (t == AST_CONSTANT_E || t == AST_CONSTANT_PI || t == AST_NAME_AVOGADRO)

_tASTNodeType_t _tpredicate_t

◆ ASTNodeType_isFunction

#define ASTNodeType_isFunction (   t)     (((t >= AST_FUNCTION) && (t <= AST_FUNCTION_TANH)) || t == AST_CSYMBOL_FUNCTION)

_tASTNodeType_t _tpredicate_t

◆ ASTNodeType_isInteger

#define ASTNodeType_isInteger (   t)     (t == AST_INTEGER)

_tASTNodeType_t _tpredicate_t

◆ ASTNodeType_isLambda

#define ASTNodeType_isLambda (   t)     (t == AST_LAMBDA)

_tASTNodeType_t _tpredicate_t

◆ ASTNodeType_isLogical

#define ASTNodeType_isLogical (   t)     (((t >= AST_LOGICAL_AND) && (t <= AST_LOGICAL_XOR)))

_tASTNodeType_t _tpredicate_t

◆ ASTNodeType_isName

#define ASTNodeType_isName (   t)     ((t >= AST_NAME) && (t <= AST_NAME_TIME))

_tASTNodeType_t _tpredicate_t

◆ ASTNodeType_isNumber

#define ASTNodeType_isNumber (   t)     (ASTNodeType_isInteger(t) || ASTNodeType_isReal(t))

_tASTNodeType_t _tpredicate_t

◆ ASTNodeType_isOperator

#define ASTNodeType_isOperator (   t)
Value:
( ( t == AST_PLUS ) || \
( t == AST_MINUS ) || \
( t == AST_TIMES ) || \
( t == AST_DIVIDE ) || \
( t == AST_POWER ) )
@ AST_MINUS
Definition ASTNodeType.h:85
@ AST_DIVIDE
Definition ASTNodeType.h:87
@ AST_TIMES
Definition ASTNodeType.h:86
@ AST_POWER
Definition ASTNodeType.h:88
@ AST_PLUS
Definition ASTNodeType.h:84

_tASTNodeType_t _tpredicate_t

◆ ASTNodeType_isRational

#define ASTNodeType_isRational (   t)     (t == AST_RATIONAL)

_tASTNodeType_t _tpredicate_t

◆ ASTNodeType_isReal

#define ASTNodeType_isReal (   t)     ((t >= AST_REAL) && (t <= AST_RATIONAL))

_tASTNodeType_t _tpredicate_t

◆ ASTNodeType_isRelational

#define ASTNodeType_isRelational (   t)     ((t >= AST_RELATIONAL_EQ) && (t <= AST_RELATIONAL_NEQ))

_tASTNodeType_t _tpredicate_t

◆ ASTNodeType_isUnknown

#define ASTNodeType_isUnknown (   t)     (t == AST_UNKNOWN)

_tASTNodeType_t _tpredicate_t

Function Documentation

◆ ASTNode_addChild()

int ASTNode_addChild ( ASTNode_t node,
ASTNode_t disownedChild 
)

_tAdds_t _ta_t _tnode_t _tas_t _ta_t _tchild_t _tof_t _tanother_t _tnode_t.

_tChild_t _tnodes_t _tare_t _tadded_t _tin_t _torder_t _tfrom_t "_tleft_t-_tto_t-_tright_t".

@_tparam_t _tnode_t _tthe_t _tnode_t _twhich_t _twill_t _tget_t _tthe_t _tnew_t _tchild_t _tnode_t. @_tparam_t _tdisownedChild_t _tthe_t _tASTNode_t_t _tinstance_t _tto_t _tadd_t. _tWill_t _tbecome_t _ta_t _tchild_t _tof_t _tthe_t _tparent_t _tnode_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tcopydetails_t _tdoc_warning_modifying_structure_t

@_tsee_t _tASTNode_prependChild_t() @_tsee_t _tASTNode_replaceChild_t() @_tsee_t _tASTNode_insertChild_t() @_tsee_t _tASTNode_removeChild_t() @_tsee_t _tASTNode_isWellFormedASTNode_t()

@_tmemberof_t _tASTNode_t_t

Examples
createExampleSBML.c.

◆ ASTNode_addSemanticsAnnotation()

int ASTNode_addSemanticsAnnotation ( ASTNode_t node,
XMLNode_t disownedAnnotation 
)

@_tendcond_t

_tAdds_t _ta_t _tgiven_t _tXML_t _tnode_t _tstructure_t _tas_t _ta_t _tMathML_t <_tcode_t>&_tlt_t;_tsemantics_t&_tgt_t;</_tcode_t> _telement_t _tof_t _ta_t _tgiven_t _tASTNode_t_t _tstructure_t.

@_thtmlinclude_t _tabout_t-_tsemantic_t-_tannotations._thtml_t

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tmodify_t. @_tparam_t _tdisownedAnnotation_t _tthe_t _tannotation_t _tto_t _tadd_t. _tWill_t _tbecome_t _ta_t _tchild_t _tof_t _tthe_t _tparent_t _tnode_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tcopydetails_t _tdoc_note_mathml_semantic_annotations_uncommon_t

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_canonicalize()

int ASTNode_canonicalize ( ASTNode_t node)

_tConverts_t _ta_t _tgiven_t _tnode_t _tto_t _ta_t _tcanonical_t _tform_t _tand_t _treturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tsuccessful_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

_tThe_t _trules_t _tdetermining_t _tthe_t _tcanonical_t _tform_t _tconversion_t _tare_t _tas_t _tfollows_t:

@_tli_t _tIf_t _tthe_t _tnode_t _ttype_t _tis_t @_tsbmlconstant_t{_tAST_NAME_t, _tASTNodeType_t_t} _tand_t _tthe_t _tnode_t _tname_t _tmatches_t @_tc_t "_tExponentialE_t", @_tc_t "_tPi_t", @_tc_t "_tTrue_t" _tor_t @_tc_t "_tFalse_t" _tthe_t _tnode_t _ttype_t _tis_t _tconverted_t _tto_t _tthe_t _tcorresponding_t <_tcode_t>_tAST_CONSTANT__t</_tcode_t><_tem_t><_tspan_t _tclass_t="_tplaceholder_t">_tX_t</_tspan_t></_tem_t> _ttype_t. @_tli_t _tIf_t _tthe_t _tnode_t _ttype_t _tis_t _tan_t @_tsbmlconstant_t{_tAST_FUNCTION_t, _tASTNodeType_t_t} _tand_t _tthe_t _tnode_t _tname_t _tmatches_t _tan_t _tSBML_t (_tMathML_t) _tfunction_t _tname_t, _tlogical_t _toperator_t _tname_t, _tor_t _trelational_t _toperator_t _tname_t, _tthe_t _tnode_t _tis_t _tconverted_t _tto_t _tthe_t _tcorresponding_t <_tcode_t>_tAST_FUNCTION__t</_tcode_t><_tem_t><_tspan_t _tclass_t="_tplaceholder_t">_tX_t</_tspan_t></_tem_t> _tor_t <_tcode_t>_tAST_LOGICAL__t</_tcode_t><_tem_t><_tspan_t _tclass_t="_tplaceholder_t">_tX_t</_tspan_t></_tem_t> _ttype_t.

_tSBML_t _tLevel_t&_tnbsp_t;_t1_t _tfunction_t _tnames_t _tare_t _tsearched_t _tfirst_t; _tthus_t, _tfor_t _texample_t, _tcanonicalizing_t @_tc_t _tlog_t _twill_t _tresult_t _tin_t _ta_t _tnode_t _ttype_t _tof_t @_tsbmlconstant_t{_tAST_FUNCTION_LN_t, _tASTNodeType_t_t}. (_tSee_t _tthe_t _tSBML_t _tLevel_t&_tnbsp_t;_t1_t _tVersion_t&_tnbsp_t;_t2_t _tSpecification_t, _tAppendix_t _tC_t.)

_tSometimes_t, _tcanonicalization_t _tof_t _ta_t _tnode_t _tresults_t _tin_t _ta_t _tstructural_t _tconversion_t _tof_t _tthe_t _tnode_t _tas_t _ta_t _tresult_t _tof_t _tadding_t _ta_t _tchild_t. _tFor_t _texample_t, _ta_t _tnode_t _twith_t _tthe_t _tSBML_t _tLevel_t&_tnbsp_t;_t1_t _tfunction_t _tname_t @_tc_t _tsqr_t _tand_t _ta_t _tsingle_t _tchild_t _tnode_t (_tthe_t _targument_t) _twill_t _tbe_t _ttransformed_t _tto_t _ta_t _tnode_t _tof_t _ttype_t @_tsbmlconstant_t{_tAST_FUNCTION_POWER_t, _tASTNodeType_t_t} _twith_t _ttwo_t _tchildren_t. _tThe_t _tfirst_t _tchild_t _twill_t _tremain_t _tunchanged_t, _tbut_t _tthe_t _tsecond_t _tchild_t _twill_t _tbe_t _tan_t _tASTNode_t_t _tof_t _ttype_t @_tsbmlconstant_t{_tAST_INTEGER_t, _tASTNodeType_t_t} _tand_t _ta_t _tvalue_t _tof_t _t2_t. _tThe_t _tfunction_t _tnames_t _tthat_t _tresult_t _tin_t _tstructural_t _tchanges_t _tare_t: @_tc_t _tlog10_t, @_tc_t _tsqr_t, _tand_t @_tc_t _tsqrt_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tbe_t _tconverted_t.

@_treturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tsuccessful_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_create()

ASTNode_t * ASTNode_create ( void  )

@_tcond_t _tdoxygenIgnored_t

_tCreates_t _ta_t _tnew_t _tASTNode_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

◆ ASTNode_createFromToken()

ASTNode_t * ASTNode_createFromToken ( Token_t token)

_tCreates_t _ta_t _tnew_t _tASTNode_t_t _tstructure_t _tfrom_t _tthe_t _tgiven_t _tToken_t_t _tdata_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

_tThe_t _treturned_t _tASTNode_t_t _tstructure_t _twill_t _tcontain_t _tthe_t _tsame_t _tdata_t _tas_t _tthe_t _tToken_t_t _tstructure_t. _tThe_t _tToken_t_t _tstructure_t _tis_t _tused_t _tto_t _tstore_t _ta_t _ttoken_t _treturned_t _tby_t _tFormulaTokenizer_nextToken_t(). _tIt_t _tcontains_t _ta_t _tunion_t _twhose_t _tmembers_t _tcan_t _tstore_t _tdifferent_t _ttypes_t _tof_t _ttokens_t, _tsuch_t _tas_t _tnumbers_t _tand_t _tsymbols_t.

@_tparam_t _ttoken_t _tthe_t _tToken_t_t _tstructure_t _tto_t _tuse_t.

@_treturns_t _ta_t _tpointer_t _tto_t _tthe_t _tnew_t _tASTNode_t_t _tstructure_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_createWithType()

ASTNode_t * ASTNode_createWithType ( ASTNodeType_t  type)

_tCreates_t _ta_t _tnew_t _tASTNode_t_t _tstructure_t _tand_t _tsets_t _tits_t _ttype_t.

@_tparam_t _ttype_t _tthe_t _ttype_t _tof_t _tnode_t _tto_t _tcreate_t.

@_treturns_t _ta_t _tpointer_t _tto_t _tthe_t _tfresh_t _tASTNode_t_t _tstructure_t.

@_tsee_t _tASTNode_create_t()

@_tmemberof_t _tASTNode_t_t

Examples
createExampleSBML.c.

◆ ASTNode_deepCopy()

ASTNode_t * ASTNode_deepCopy ( const ASTNode_t node)

_tCreates_t _ta_t _trecursive_t _tcopy_t _tof_t _ta_t _tnode_t _tand_t _tall_t _tits_t _tchildren_t.

@_tparam_t _tnode_t _tthe_t _tASTNode_t_t _tstructure_t _tto_t _tcopy_t.

@_treturn_t _ta_t _tcopy_t _tof_t _tthis_t _tASTNode_t_t _tstructure_t _tand_t _tall_t _tits_t _tchildren_t. _tThe_t _tcaller_t _towns_t _tthe_t _treturned_t _tstructure_t _tand_t _tis_t _treponsible_t _tfor_t _tdeleting_t _tit_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_fillListOfNodes()

void ASTNode_fillListOfNodes ( const ASTNode_t node,
ASTNodePredicate  predicate,
List_t lst 
)

_tReturns_t _ta_t _tlist_t _tof_t _tnodes_t _trooted_t _tat_t _ta_t _tgiven_t _tnode_t _tand_t _tsatisfying_t _ta_t _tgiven_t _tpredicate_t.

_tThis_t _tmethod_t _tis_t _tidentical_t _tto_t _tASTNode_getListOfNodes_t(), _texcept_t _tthat_t _tinstead_t _tof_t _tcreating_t _ta_t _tnew_t _tList_t_t _tstructure_t, _tit_t _tuses_t _tthe_t _tone_t _tpassed_t _tin_t _tas_t _targument_t @_tp_t _tlst_t. _tThis_t _tfunction_t _tperforms_t _ta_t _tdepth_t-_tfirst_t _tsearch_t _tof_t _tthe_t _ttree_t _trooted_t _tat_t _tthe_t _tgiven_t _tASTNode_t_t _tstructure_t, _tand_t _tadds_t _tto_t @_tp_t _tlst_t _tthe_t _tnodes_t _tfor_t _twhich_t _tthe_t _tgiven_t _tfunction_t <_tcode_t>_tpredicate_t(_tnode_t)</_tcode_t> _treturns_t _ttrue_t (_ti_t._te_t., _tnonzero_t).

_tThe_t _tpredicate_t _tis_t _tpassed_t _tin_t _tas_t _ta_t _tpointer_t _tto_t _ta_t _tfunction_t. _tThe_t _tfunction_t _tdefinition_t _tmust_t _thave_t _tthe_t _ttype_t @_tlink_t _tASTNode._th_t::_tASTNodePredicate_t _tASTNodePredicate_t @_tendlink_t, _twhich_t _tis_t _tdefined_t _tas_t @_tverbatim_t _tint_t (*_tASTNodePredicate_t) (_tconst_t _tASTNode_t_t *_tnode_t); @_tendverbatim_t _twhere_t _ta_t _treturn_t _tvalue_t _tof_t @_tc_t _tnonzero_t _trepresents_t _ttrue_t _tand_t @_tc_t _tzero_t _trepresents_t _tfalse_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tat_t _twhich_t _tthe_t _tsearch_t _tis_t _tto_t _tbe_t _tstarted_t. @_tparam_t _tpredicate_t _tthe_t _tpredicate_t _tto_t _tuse_t. @_tparam_t _tlst_t _tthe_t _tlist_t _tto_t _tuse_t.

@_tsee_t _tASTNode_getListOfNodes_t()

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_free()

void ASTNode_free ( ASTNode_t node)

_tFrees_t _tthe_t _tgiven_t _tASTNode_t_t _tstructure_t, _tincluding_t _tany_t _tchild_t _tnodes_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tbe_t _tfreed_t.

@_tmemberof_t _tASTNode_t_t

Examples
createExampleSBML.c, translateL3Math.c, and translateMath.c.

◆ ASTNode_freeName()

int ASTNode_freeName ( ASTNode_t node)

_tFrees_t _tthe_t _tname_t _tfield_t _tof_t _ta_t _tgiven_t _tnode_t _tand_t _tsets_t _tit_t _tto_t _tnull_t.

_tThis_t _toperation_t _tis_t _tonly_t _tapplicable_t _tto_t _tASTNode_t_t _tstructures_t _tcorresponding_t _tto_t _toperators_t, _tnumbers_t, _tor_t @_tsbmlconstant_t{_tAST_UNKNOWN_t, _tASTNodeType_t_t}. _tThis_t _tmethod_t _twill_t _thave_t _tno_t _teffect_t _ton_t _tother_t _ttypes_t _tof_t _tnodes_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _twhose_t _tname_t _tfield_t _tshould_t _tbe_t _tfreed_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_UNEXPECTED_ATTRIBUTE_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_getCharacter()

char ASTNode_getCharacter ( const ASTNode_t node)

_tReturns_t _tthe_t _tvalue_t _tof_t _ta_t _tnode_t _tas_t _ta_t _tsingle_t _tcharacter_t.

_tThis_t _tfunction_t _tshould_t _tbe_t _tcalled_t _tonly_t _twhen_t _tASTNode_getType_t() _treturns_t @_tsbmlconstant_t{_tAST_PLUS_t, _tASTNodeType_t_t}, @_tsbmlconstant_t{_tAST_MINUS_t, _tASTNodeType_t_t}, @_tsbmlconstant_t{_tAST_TIMES_t, _tASTNodeType_t_t}, @_tsbmlconstant_t{_tAST_DIVIDE_t, _tASTNodeType_t_t} _tor_t @_tsbmlconstant_t{_tAST_POWER_t, _tASTNodeType_t_t} _tfor_t _tthe_t _tgiven_t @_tp_t _tnode_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _twhose_t _tvalue_t _tis_t _tto_t _tbe_t _treturned_t.

@_treturn_t _tthe_t _tvalue_t _tof_t @_tp_t _tnode_t _tas_t _ta_t _tsingle_t _tcharacter_t, _tor_t _tthe_t _tvalue_t @_tc_t _tCHAR_MAX_t _tif_t @_tp_t _tnode_t _tis_t @_tc_t _tNULL_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_getChild()

ASTNode_t * ASTNode_getChild ( const ASTNode_t node,
unsigned int  n 
)

_tReturns_t _ta_t _tchild_t _tof_t _ta_t _tnode_t _taccording_t _tto_t _tits_t _tindex_t _tnumber_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _twhose_t _tchild_t _tshould_t _tbe_t _tobtained_t. @_tparam_t _tn_t _tthe_t _tindex_t _tof_t _tthe_t _tdesired_t _tchild_t _tnode_t.

@_treturn_t _tthe_t _tnth_t _tchild_t _tof_t _tthis_t _tASTNode_t_t _tor_t _ta_t _tnull_t _tpointer_t _tif_t _tthis_t _tnode_t _thas_t _tno_t _tnth_t _tchild_t (<_tcode_t>_tn_t &_tgt_t; </_tcode_t> _tASTNode_getNumChildre_t() <_tcode_t>- _t1_t</_tcode_t>).

@_tsee_t _tASTNode_getNumChildren_t() @_tsee_t _tASTNode_getLeftChild_t() @_tsee_t _tASTNode_getRightChild_t()

@_tmemberof_t _tASTNode_t_t

Examples
printMath.c.

◆ ASTNode_getClass()

char * ASTNode_getClass ( const ASTNode_t node)

_tReturns_t _tthe_t _tMathML_t @_tc_t _tclass_t _tattribute_t _tof_t _ta_t _tgiven_t _tnode_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _twhose_t _tclass_t _tshould_t _tbe_t _treturned_t.

@_treturns_t _tthe_t _tclass_t _tidentifier_t, _tor_t @_tc_t _tNULL_t _tif_t @_tp_t _tnode_t _tis_t _ta_t _tnull_t _tpointer_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_getDefinitionURL()

XMLAttributes_t * ASTNode_getDefinitionURL ( ASTNode_t node)

_tReturns_t _tthe_t _tMathML_t @_tc_t _tdefinitionURL_t _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tnode_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t @_tc_t _tdefinitionURL_t _tattribute_t _tin_t _tthe_t _tform_t _tof_t _ta_t _tlibSBML_t _tXMLAttributes_t_t _tstructure_t, _tor_t _ta_t _tnull_t _tpointer_t _tif_t @_tp_t _tnode_t _tdoes_t _tnot_t _thave_t _ta_t _tvalue_t _tfor_t _tthe_t _tattribute_t.

@_tsee_t _tASTNode_getDefinitionURLString_t()

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_getDefinitionURLString()

char * ASTNode_getDefinitionURLString ( ASTNode_t node)

_tReturns_t _tthe_t _tMathML_t @_tc_t _tdefinitionURL_t _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tnode_t _tas_t _ta_t _tstring_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t @_tc_t _tdefinitionURL_t _tattribute_t _tin_t _tthe_t _tform_t _tof_t _ta_t _tstring_t, _tor_t _ta_t _tnull_t _tpointer_t _tif_t @_tp_t _tnode_t _tdoes_t _tnot_t _thave_t _ta_t _tvalue_t _tfor_t _tthe_t _tattribute_t.

@_tsee_t _tASTNode_getDefinitionURL_t()

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_getDenominator()

long ASTNode_getDenominator ( const ASTNode_t node)

_tReturns_t _tthe_t _tnumerator_t _tvalue_t _tof_t _ta_t _tnode_t _trepresenting_t _ta_t _trational_t _tnumber_t.

_tThis_t _tfunction_t _tshould_t _tbe_t _tcalled_t _tonly_t _twhen_t _tASTNode_getType_t() _treturns_t @_tsbmlconstant_t{_tAST_RATIONAL_t, _tASTNodeType_t_t} _tfor_t _tthe_t _tgiven_t @_tp_t _tnode_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _twhose_t _tvalue_t _tis_t _tto_t _tbe_t _treturned_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t _tdenominator_t _tof_t @_tp_t _tnode_t, _tor_t _tthe_t _tvalue_t @_tc_t _tLONG_MAX_t _tif_t @_tp_t _tnode_t _tis_t @_tc_t _tNULL_t.

@_tsee_t _tASTNode_getNumerator_t()

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_getExponent()

long ASTNode_getExponent ( const ASTNode_t node)

_tGet_t _tthe_t _texponent_t _tvalue_t _tof_t _ta_t _tnode_t.

_tThis_t _tfunction_t _tshould_t _tbe_t _tcalled_t _tonly_t _twhen_t _tASTNode_getType_t() _treturns_t @_tsbmlconstant_t{_tAST_REAL_E_t, _tASTNodeType_t_t} _tor_t @_tsbmlconstant_t{_tAST_REAL_t, _tASTNodeType_t_t} _tfor_t _tthe_t _tgiven_t @_tp_t _tnode_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _twhose_t _tvalue_t _tis_t _tto_t _tbe_t _treturned_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t _texponent_t _tfield_t _tin_t _tthe_t _tgiven_t @_tp_t _tnode_t _tASTNode_t_t _tstructure_t, _tor_t _tNaN_t _tif_t @_tp_t _tnode_t _tis_t @_tc_t _tNULL_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_getId()

char * ASTNode_getId ( const ASTNode_t node)

_tReturns_t _tthe_t _tMathML_t @_tc_t _tid_t _tattribute_t _tof_t _ta_t _tgiven_t _tnode_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _twhose_t _tidentifier_t _tshould_t _tbe_t _treturned_t.

@_treturns_t _tthe_t _tidentifier_t _tof_t _tthe_t _tnode_t, _tor_t @_tc_t _tNULL_t _tif_t @_tp_t _tnode_t _tis_t _ta_t _tnull_t _tpointer_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_getInteger()

long ASTNode_getInteger ( const ASTNode_t node)

_tReturns_t _tthe_t _tvalue_t _tof_t _ta_t _tnode_t _tas_t _tan_t _tinteger_t.

_tThis_t _tfunction_t _tshould_t _tbe_t _tcalled_t _tonly_t _twhen_t _tASTNode_getType_t() _treturns_t @_tsbmlconstant_t{_tAST_INTEGER_t, _tASTNodeType_t_t} _tfor_t _tthe_t _tgiven_t @_tp_t _tnode_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _twhose_t _tvalue_t _tis_t _tto_t _tbe_t _treturned_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t _tgiven_t _tASTNode_t_t _tstructure_t _tas_t _ta_t (<_tcode_t>_tlong_t</_tcode_t>) _tinteger_t, _tor_t _tthe_t _tvalue_t @_tc_t _tLONG_MAX_t _tif_t @_tp_t _tnode_t _tis_t @_tc_t _tNULL_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_getLeftChild()

ASTNode_t * ASTNode_getLeftChild ( const ASTNode_t node)

_tReturns_t _tthe_t _tleft_t-_tmost_t _tchild_t _tof_t _ta_t _tgiven_t _tnode_t.

_tThis_t _tis_t _tequivalent_t _tto_t <_tcode_t>_tASTNode_getChild_t(_tnode_t, _t0_t)</_tcode_t>.

@_tparam_t _tnode_t _tthe_t _tnode_t _twhose_t _tchild_t _tis_t _tto_t _tbe_t _treturned_t.

@_treturn_t _tthe_t _tleft_t _tchild_t, _tor_t _ta_t _tnull_t _tpointer_t _tif_t _tthere_t _tare_t _tno_t _tchildren_t.

@_tsee_t _tASTNode_getNumChildren_t() @_tsee_t _tASTNode_getChild_t() @_tsee_t _tASTNode_getRightChild_t()

@_tmemberof_t _tASTNode_t_t

Examples
createExampleSBML.c, and printMath.c.

◆ ASTNode_getListOfNodes()

List_t * ASTNode_getListOfNodes ( const ASTNode_t node,
ASTNodePredicate  predicate 
)

_tReturns_t _ta_t _tlist_t _tof_t _tnodes_t _trooted_t _tat_t _ta_t _tgiven_t _tnode_t _tand_t _tsatisfying_t _ta_t _tgiven_t _tpredicate_t.

_tThis_t _tfunction_t _tperforms_t _ta_t _tdepth_t-_tfirst_t _tsearch_t _tof_t _tthe_t _ttree_t _trooted_t _tat_t _tthe_t _tgiven_t _tASTNode_t_t _tstructure_t, _tand_t _treturns_t _ta_t _tList_t_t _tstructure_t _tof_t _tnodes_t _tfor_t _twhich_t _tthe_t _tgiven_t _tfunction_t <_tcode_t>_tpredicate_t(_tnode_t)</_tcode_t> _treturns_t _ttrue_t (_ti_t._te_t., _tnonzero_t).

_tThe_t _tpredicate_t _tis_t _tpassed_t _tin_t _tas_t _ta_t _tpointer_t _tto_t _ta_t _tfunction_t. _tThe_t _tfunction_t _tdefinition_t _tmust_t _thave_t _tthe_t _ttype_t @_tlink_t _tASTNode._th_t::_tASTNodePredicate_t _tASTNodePredicate_t@_tendlink_t, _twhich_t _tis_t _tdefined_t _tas_t @_tverbatim_t _tint_t (*_tASTNodePredicate_t) (_tconst_t _tASTNode_t_t *_tnode_t); @_tendverbatim_t _twhere_t _ta_t _treturn_t _tvalue_t _tof_t @_tc_t _tnonzero_t _trepresents_t _ttrue_t _tand_t @_tc_t _tzero_t _trepresents_t _tfalse_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tat_t _twhich_t _tthe_t _tsearch_t _tis_t _tto_t _tbe_t _tstarted_t. @_tparam_t _tpredicate_t _tthe_t _tpredicate_t _tto_t _tuse_t.

@_treturn_t _tthe_t _tlist_t _tof_t _tnodes_t _tfor_t _twhich_t _tthe_t _tpredicate_t _treturned_t _ttrue_t (_ti_t._te_t., _tnonzero_t). _tThe_t _tList_t_t _tstructure_t _treturned_t _tis_t _towned_t _tby_t _tthe_t _tcaller_t _tand_t _tshould_t _tbe_t _tdeleted_t _tafter_t _tthe_t _tcaller_t _tis_t _tdone_t _tusing_t _tit_t. _tThe_t _tASTNode_t_t _tstructures_t _tin_t _tthe_t _tlist_t, _thowever_t, _tare_t @_tem_t _tnot_t _towned_t _tby_t _tthe_t _tcaller_t (_tas_t _tthey_t _tstill_t _tbelong_t _tto_t _tthe_t _ttree_t _titself_t), _tand_t _ttherefore_t _tshould_t @_tem_t _tnot_t _tbe_t _tdeleted_t.

@_tsee_t _tASTNode_fillListOfNodes_t()

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_getMantissa()

double ASTNode_getMantissa ( const ASTNode_t node)

_tGet_t _tthe_t _tmantissa_t _tvalue_t _tof_t _ta_t _tnode_t.

_tThis_t _tfunction_t _tshould_t _tbe_t _tcalled_t _tonly_t _twhen_t _tASTNode_getType_t() _treturns_t @_tsbmlconstant_t{_tAST_REAL_E_t, _tASTNodeType_t_t} _tor_t @_tsbmlconstant_t{_tAST_REAL_t, _tASTNodeType_t_t} _tfor_t _tthe_t _tgiven_t @_tp_t _tnode_t. _tIf_t _tASTNode_getType_t() _treturns_t @_tsbmlconstant_t{_tAST_REAL_t, _tASTNodeType_t_t} _tfor_t @_tp_t _tnode_t, _tthis_t _tmethod_t _tbehaves_t _tidentically_t _tto_t _tASTNode_getReal_t().

@_tparam_t _tnode_t _tthe_t _tnode_t _twhose_t _tvalue_t _tis_t _tto_t _tbe_t _treturned_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t _tmantissa_t _tof_t @_tp_t _tnode_t, _tor_t _tNaN_t _tif_t @_tp_t _tnode_t _tis_t @_tc_t _tNULL_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_getName()

const char * ASTNode_getName ( const ASTNode_t node)

_tReturns_t _tthe_t _tvalue_t _tof_t _ta_t _tnode_t _tas_t _ta_t _tstring_t.

_tThis_t _tfunction_t _tmay_t _tbe_t _tcalled_t _ton_t _tnodes_t _tthat_t (_t1_t) _tare_t _tnot_t _toperators_t, _ti_t._te_t., _tnodes_t _tfor_t _twhich_t _tASTNode_isOperator_t() _treturns_t _tfalse_t (@_tc_t _t0_t), _tand_t (_t2_t) _tare_t _tnot_t _tnumbers_t, _ti_t._te_t., _tfor_t _twhich_t _tASTNode_isNumber_t() _talso_t _treturns_t _tfalse_t (@_tc_t _t0_t).

@_tparam_t _tnode_t _tthe_t _tnode_t _twhose_t _tvalue_t _tis_t _tto_t _tbe_t _treturned_t.

@_treturn_t _tthe_t _tvalue_t _tof_t @_tp_t _tnode_t _tas_t _ta_t _tstring_t, _tor_t _ta_t _tnull_t _tpointer_t _tif_t @_tp_t _tnode_t _tis_t @_tc_t _tNULL_t.

@_tmemberof_t _tASTNode_t_t

Examples
printMath.c.

◆ ASTNode_getNumChildren()

unsigned int ASTNode_getNumChildren ( const ASTNode_t node)

_tReturns_t _tthe_t _tnumber_t _tof_t _tchildren_t _tof_t _ta_t _tgiven_t _tnode_t.

@_tparam_t _tnode_t _tthe_t _tASTNode_t_t _tstructure_t _twhose_t _tchildren_t _tare_t _tto_t _tbe_t _tcounted_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tchildren_t _tof_t @_tp_t _tnode_t, _tor_t @_tc_t _t0_t _tis_t _tit_t _thas_t _tno_t _tchildren_t.

@_tmemberof_t _tASTNode_t_t

Examples
printMath.c.

◆ ASTNode_getNumerator()

long ASTNode_getNumerator ( const ASTNode_t node)

_tReturns_t _tthe_t _tnumerator_t _tvalue_t _tof_t _ta_t _tnode_t _trepresenting_t _ta_t _trational_t _tnumber_t.

_tThis_t _tfunction_t _tshould_t _tbe_t _tcalled_t _tonly_t _twhen_t _tASTNode_getType_t() _treturns_t @_tsbmlconstant_t{_tAST_RATIONAL_t, _tASTNodeType_t_t} _tfor_t _tthe_t _tgiven_t @_tp_t _tnode_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _twhose_t _tvalue_t _tis_t _tto_t _tbe_t _treturned_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t _tnumerator_t _tof_t @_tp_t _tnode_t, _tor_t _tthe_t _tvalue_t @_tc_t _tLONG_MAX_t _tif_t @_tp_t _tis_t @_tc_t _tNULL_t.

@_tsee_t _tASTNode_getDenominator_t()

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_getNumSemanticsAnnotations()

unsigned int ASTNode_getNumSemanticsAnnotations ( ASTNode_t node)

_tReturns_t _tthe_t _tnumber_t _tof_t _tMathML_t _tsemantic_t _tannotations_t _tinside_t _tthe_t _tgiven_t _tnode_t.

@_thtmlinclude_t _tabout_t-_tsemantic_t-_tannotations._thtml_t

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t _ta_t _tcount_t _tof_t _tthe_t _tsemantic_t _tannotations_t.

@_tsee_t _tASTNode_addSemanticsAnnotation_t()

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_getParentSBMLObject()

SBase_t * ASTNode_getParentSBMLObject ( ASTNode_t node)

_tReturns_t _tthe_t _tparent_t _tSBase_t_t _tstructure_t _tcontaining_t _tthe_t _tgiven_t _tnode_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tstructure_t _tcontaining_t _tthe_t _tgiven_t _tnode_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_getPrecedence()

int ASTNode_getPrecedence ( const ASTNode_t node)

_tReturns_t _tthe_t _tprecedence_t _tof_t _ta_t _tnode_t _tin_t _tthe_t _tinfix_t _tmath_t _tsyntax_t _tof_t _tSBML_t _tLevel_t&_tnbsp_t;_t1_t.

@_tcopydetails_t _tdoc_summary_of_string_math_t

@_tparam_t _tnode_t _tthe_t _tnode_t _twhose_t _tprecedence_t _tis_t _tto_t _tbe_t _tcalculated_t.

@_treturn_t _tthe_t _tprecedence_t _tof_t @_tp_t _tnode_t (_tas_t _tdefined_t _tin_t _tthe_t _tSBML_t _tLevel_t&_tnbsp_t;_t1_t _tspecification_t).

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_getReal()

double ASTNode_getReal ( const ASTNode_t node)

_tGet_t _tthe_t _treal_t-_tnumbered_t _tvalue_t _tof_t _ta_t _tnode_t.

_tThis_t _tfunction_t _tshould_t _tbe_t _tcalled_t _tonly_t _twhen_t _tASTNode_isReal_t() _treturns_t _tnonzero_t _tfor_t @_tp_t _tnode_t. _tThis_t _tfunction_t _tperforms_t _tthe_t _tnecessary_t _tarithmetic_t _tif_t _tthe_t _tnode_t _ttype_t _tis_t @_tsbmlconstant_t{_tAST_REAL_E_t, _tASTNodeType_t_t} (<_tem_t>_tmantissa_t * _t10_t<_tsup_t>_texponent_t</_tsup_t></_tem_t>) _tor_t @_tsbmlconstant_t{_tAST_RATIONAL_t, _tASTNodeType_t_t} (<_tem_t>_tnumerator_t / _tdenominator_t</_tem_t>).

@_tparam_t _tnode_t _tthe_t _tnode_t _twhose_t _tvalue_t _tis_t _tto_t _tbe_t _treturned_t.

@_treturn_t _tthe_t _tvalue_t _tof_t @_tp_t _tnode_t _tas_t _ta_t _treal_t (_tdouble_t), _tor_t _tNaN_t _tif_t @_tp_t _tnode_t _tis_t @_tc_t _tNULL_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_getRightChild()

ASTNode_t * ASTNode_getRightChild ( const ASTNode_t node)

_tReturns_t _tthe_t _tright_t-_tmost_t _tchild_t _tof_t _ta_t _tgiven_t _tnode_t.

_tIf_t <_tcode_t>_tASTNode_getNumChildren_t(_tnode_t) > _t1_t</_tcode_t>, _tthen_t _tthis_t _tis_t _tequivalent_t _tto_t: @_tverbatim_t _tASTNode_getChild_t(_tnode_t, _tASTNode_getNumChildren_t(_tnode_t) - _t1_t); @_tendverbatim_t

@_tparam_t _tnode_t _tthe_t _tnode_t _twhose_t _tchild_t _tnode_t _tis_t _tto_t _tbe_t _tobtained_t.

@_treturn_t _tthe_t _tright_t _tchild_t _tof_t @_tp_t _tnode_t, _tor_t _ta_t _tnull_t _tpointer_t _tif_t @_tp_t _tnode_t _thas_t _tno_t _tright_t _tchild_t.

@_tsee_t _tASTNode_getNumChildren_t() @_tsee_t _tASTNode_getLeftChild_t() @_tsee_t _tASTNode_getChild_t()

@_tmemberof_t _tASTNode_t_t

Examples
createExampleSBML.c.

◆ ASTNode_getSemanticsAnnotation()

XMLNode_t * ASTNode_getSemanticsAnnotation ( ASTNode_t node,
unsigned int  n 
)

_tReturns_t _tthe_t _tnth_t _tMathML_t _tsemantic_t _tannotation_t _tattached_t _tto_t _tthe_t _tgiven_t _tnode_t.

@_thtmlinclude_t _tabout_t-_tsemantic_t-_tannotations._thtml_t

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t. @_tparam_t _tn_t _tthe_t _tindex_t _tof_t _tthe_t _tsemantic_t _tannotation_t _tto_t _tfetch_t.

@_treturn_t _tthe_t _tnth_t _tsemantic_t _tannotation_t _ton_t @_tp_t _tnode_t , _tor_t _ta_t _tnull_t _tpointer_t _tif_t _tthe_t _tnode_t _thas_t _tno_t _tnth_t _tannotation_t (_twhich_t _twould_t _tmean_t _tthat_t <_tcode_t>_tn_t &_tgt_t; _tASTNode_getNumSemanticsAnnotations_t(_tnode_t) - _t1_t</_tcode_t>).

@_tcopydetails_t _tdoc_note_mathml_semantic_annotations_uncommon_t

@_tsee_t _tASTNode_addSemanticsAnnotation_t()

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_getStyle()

char * ASTNode_getStyle ( const ASTNode_t node)

_tReturns_t _tthe_t _tMathML_t @_tc_t _tstyle_t _tattribute_t _tof_t _ta_t _tgiven_t _tnode_t.

@_tparam_t _tnode_t _tthe_t _tnode_t.

@_treturn_t _ta_t _tstring_t _trepresenting_t _tthe_t @_tc_t _tstyle_t _tvalue_t, _tor_t _ta_t _tnull_t _tvalue_t _tif_t @_tp_t _tnode_t _tis_t _ta_t _tnull_t _tpointer_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_getType()

ASTNodeType_t ASTNode_getType ( const ASTNode_t node)

_tReturns_t _tthe_t _ttype_t _tof_t _tthe_t _tgiven_t _tnode_t.

@_tparam_t _tnode_t _tthe_t _tnode_t.

@_treturn_t _tthe_t _ttype_t _tof_t _tthe_t _tgiven_t _tASTNode_t_t _tstructure_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_getUnits()

char * ASTNode_getUnits ( const ASTNode_t node)

_tReturns_t _tthe_t _tSBML_t "_tunits_t" _tattribute_t _tof_t _ta_t _tgiven_t _tnode_t.

@_thtmlinclude_t _tabout_t-_tsbml_t-_tunits_t-_tattrib._thtml_t

@_tparam_t _tnode_t _tthe_t _tnode_t _twhose_t _tunits_t _tare_t _tto_t _tbe_t _treturned_t.

@_treturn_t _tthe_t _tunits_t, _tas_t _ta_t _tstring_t, _tor_t _ta_t _tnull_t _tvalue_t _tif_t @_tp_t _tnode_t _tis_t _ta_t _tnull_t _tpointer_t.

@_tnote_t _tThe_t <_tcode_t>_tsbml_t:_tunits_t</_tcode_t> _tattribute_t _tfor_t _tMathML_t _texpressions_t _tis_t _tonly_t _tdefined_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t. _tIt_t _tmay_t _tnot_t _tbe_t _tused_t _tin_t _tLevels_t _t1_t&_tndash_t;_t2_t _tof_t _tSBML_t.

@_tsee_t _tSBML_parseL3Formula_t()

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_getUserData()

void * ASTNode_getUserData ( const ASTNode_t node)

_tReturns_t _tthe_t _tuser_t _tdata_t _tassociated_t _twith_t _tthis_t _tnode_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t _tthe_t _tuser_t _tdata_t _tof_t _tthis_t _tnode_t, _tor_t _ta_t _tnull_t _tpointer_t _tif_t _tno_t _tuser_t _tdata_t _thas_t _tbeen_t _tset_t.

@_tsee_t _tASTNode_setUserData_t()

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_getValue()

double ASTNode_getValue ( const ASTNode_t node)

_tReturns_t _tthe_t _tnumerical_t _tvalue_t _tof_t _tthis_t _tASTNode_t_t.

@_tparam_t _tnode_t _tthe_t _tASTNode_t_t _twhose_t _tvalue_t _tis_t _tto_t _tbe_t _treturned_t.

@_treturn_t _tthe_t _tnumerical_t _tvalue_t _tof_t _tthis_t _tASTNode_t_t, _tor_t @_tc_t _tNaN_t _tif_t _tthis_t _tis_t _tnot_t _ta_t _ttype_t _tof_t _tnode_t _tthat_t _thas_t _ta_t _tnumerical_t _tvalue_t.

@_tnote_t _tThis_t _tfunction_t _twill_t _treturn_t _ta_t _tnumerical_t _tvalue_t (_tas_t _ta_t _tdouble_t) _tfor_t _tany_t _tASTNode_t_t _tthat_t _trepresents_t _ta_t _tnumber_t, _ta_t _tconstant_t _tsuch_t _tas_t _tpi_t _tor_t _tavogadro_t _tor_t @_tc_t _t1_t _tfor_t _tnodes_t _tof_t _ttype_t @_tsbmlconstant_t{_tAST_CONSTANT_TRUE_t, _tASTNodeType_t_t} _tand_t @_tc_t _t0_t _tfor_t _tnodes_t _tof_t _ttype_t @_tsbmlconstant_t{_tAST_CONSTANT_FALSE_t, _tASTNodeType_t_t}. _tIt_t _tdoes_t _tnot_t _tevaluate_t _tthe_t _tnode_t _tin_t _tany_t _tway_t _tso_t, _tfor_t _texample_t, _tit_t _twill_t _tnot_t _treturn_t _tthe_t _tvalue_t _tof_t _ta_t _tnamed_t _tASTNode_t_t _tor_t _tattempt_t _tto_t _tevaluate_t _ta_t _tfunction_t. _tThis_t _tincludes_t _ta_t _tnode_t _trepresenting_t @_tc_t _ttime_t _ti_t._te_t. _tnodes_t _tof_t _ttype_t @_tsbmlconstant_t{_tAST_NAME_TIME_t, _tASTNodeType_t_t}.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_hasCorrectNumberArguments()

int ASTNode_hasCorrectNumberArguments ( ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _thas_t _tthe_t _tcorrect_t _tnumber_t _tof_t _tchildren_t _tfor_t _tits_t _ttype_t.

_tFor_t _texample_t, _tan_t _tASTNode_t_t _tstructure_t _twith_t _ttype_t @_tsbmlconstant_t{_tAST_MINUS_t, _tASTNodeType_t_t} _texpects_t _t1_t _tor_t _t2_t _tchild_t _tnodes_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _thas_t _tthe_t _tappropriate_t _tnumber_t _tof_t _tchildren_t _tfor_t _tits_t _ttype_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tnote_t _tThis_t _tfunction_t _tperforms_t _ta_t _tcheck_t _ton_t _tthe_t _ttop_t-_tlevel_t _tnode_t _tonly_t. _tChild_t _tnodes_t _tare_t _tnot_t _tchecked_t.

@_tsee_t _tASTNode_isWellFormedASTNode_t()

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_hasTypeAndNumChildren()

int ASTNode_hasTypeAndNumChildren ( const ASTNode_t node,
ASTNodeType_t  type,
unsigned int  numchildren 
)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tis_t _tof_t _ta_t _tspecific_t _ttype_t _tand_t _thas_t _ta_t _tspecific_t _tnumber_t _tof_t _tchildren_t.

_tThis_t _tfunction_t _tis_t _tdesigned_t _tfor_t _tuse_t _tin_t _tcases_t _tsuch_t _tas_t _twhen_t _tcallers_t _twant_t _tto_t _tdetermine_t _tif_t _tthe_t _tnode_t _tis_t _ta_t _tunary_t @_tc_t _tnot_t _tor_t _tunary_t @_tc_t _tminus_t, _tor_t _ta_t @_tc_t _ttimes_t _tnode_t _twith_t _tno_t _tchildren_t, _tetc_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t. @_tparam_t _ttype_t _tthe_t _ttype_t _tthat_t _tthe_t _tnode_t _tshould_t _thave_t. @_tparam_t _tnumchildren_t _tthe_t _tnumber_t _tof_t _tchildren_t _tthat_t _tthe_t _tnode_t _tshould_t _thave_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _tis_t _thas_t _tthe_t _tspecified_t _ttype_t _tand_t _tnumber_t _tof_t _tchildren_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_hasUnits()

int ASTNode_hasUnits ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tor_t _tany_t _tof_t _tits_t _tchildren_t _thave_t _tthe_t _tSBML_t "_tunits_t" _tattribute_t _tset_t.

@_thtmlinclude_t _tabout_t-_tsbml_t-_tunits_t-_tattrib._thtml_t

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tattribute_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tnote_t _tThe_t <_tcode_t>_tsbml_t:_tunits_t</_tcode_t> _tattribute_t _tis_t _tonly_t _tavailable_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t. _tIt_t _tmay_t _tnot_t _tbe_t _tused_t _tin_t _tLevels_t _t1_t&_tndash_t;_t2_t _tof_t _tSBML_t.

@_tsee_t _tASTNode_isSetUnits_t()

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_insertChild()

int ASTNode_insertChild ( ASTNode_t node,
unsigned int  n,
ASTNode_t disownedChild 
)

_tInsert_t _ta_t _tnew_t _tchild_t _tnode_t _tat_t _ta_t _tgiven_t _tpoint_t _tin_t _tthe_t _tlist_t _tof_t _tchildren_t _tof_t _ta_t _tnode_t.

@_tparam_t _tnode_t _tthe_t _tASTNode_t_t _tstructure_t _tto_t _tmodify_t. @_tparam_t _tn_t _tunsigned_t _tint_t _tthe_t _tindex_t _tof_t _tthe_t _tlocation_t _twhere_t _tthe_t @_tp_t _tdisownedChild_t _tis_t _tto_t _tbe_t _tadded_t. @_tparam_t _tdisownedChild_t _tASTNode_t_t _tstructure_t _tto_t _tinsert_t _tas_t _tthe_t _tnth_t _tchild_t. _tWill_t _tbecome_t _ta_t _tchild_t _tof_t _tthe_t _tparent_t _tnode_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INDEX_EXCEEDS_SIZE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t}

@_tcopydetails_t _tdoc_warning_modifying_structure_t

@_tsee_t _tASTNode_addChild_t() @_tsee_t _tASTNode_prependChild_t() @_tsee_t _tASTNode_replaceChild_t() @_tsee_t _tASTNode_removeChild_t()

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isAvogadro()

int ASTNode_isAvogadro ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _trepresents_t _tthe_t _tspecial_t _tsymbol_t @_tc_t _tavogadro_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tstands_t _tfor_t @_tc_t _tavogadro_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tsee_t _tSBML_parseL3Formula_t()

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isBoolean()

int ASTNode_isBoolean ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tnode_t _tis_t _tsome_t _ttype_t _tof_t _tBoolean_t _tvalue_t _tor_t _toperator_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tin_t _tquestion_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _tis_t _ta_t _tBoolean_t (_ta_t _tlogical_t _toperator_t, _ta_t _trelational_t _toperator_t, _tor_t _tthe_t _tconstants_t @_tc_t _ttrue_t _tor_t @_tc_t _tfalse_t), @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isConstant()

int ASTNode_isConstant ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _trepresents_t _ta_t _tMathML_t _tconstant_t.

_tExamples_t _tof_t _tconstants_t _tin_t _tthis_t _tcontext_t _tare_t @_tc_t _tPi_t, @_tc_t _ttrue_t, _tetc_t.

@_tparam_t _tnode_t _tthe_t _tnode_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _tis_t _ta_t _tMathML_t _tconstant_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isConstantNumber()

int ASTNode_isConstantNumber ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _trepresents_t _ta_t _tMathML_t _tconstant_t.

_tExamples_t _tof_t _tconstants_t _tin_t _tthis_t _tcontext_t _tare_t @_tc_t _tPi_t, @_tc_t _ttrue_t, _tetc_t.

@_tparam_t _tnode_t _tthe_t _tnode_t

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _tis_t _ta_t _tMathML_t _tconstant_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isFunction()

int ASTNode_isFunction ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _trepresents_t _ta_t _tfunction_t.

@_tparam_t _tnode_t _tthe_t _tnode_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _tis_t _ta_t _tfunction_t _tin_t _tSBML_t, _twhether_t _tpredefined_t (_tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t1_t), _tdefined_t _tby_t _tMathML_t (_tSBML_t _tLevels_t&_tnbsp_t;_t2_t&_tndash_t;_t3_t) _tor_t _tuser_t-_tdefined_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isInfinity()

int ASTNode_isInfinity ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tstands_t _tfor_t _tinfinity_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _tis_t _tthe_t _tspecial_t _tIEEE_t _t754_t _tvalue_t _tfor_t _tinfinity_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isInteger()

int ASTNode_isInteger ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tcontains_t _tan_t _tinteger_t _tvalue_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _tis_t _tof_t _ttype_t @_tsbmlconstant_t{_tAST_INTEGER_t, _tASTNodeType_t_t}, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isLambda()

int ASTNode_isLambda ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tis_t _ta_t _tMathML_t _tlambda_t _tfunction_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _tis_t _tof_t _ttype_t @_tsbmlconstant_t{_tAST_LAMBDA_t, _tASTNodeType_t_t}, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isLog10()

int ASTNode_isLog10 ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _trepresents_t _tthe_t _tlog_t _tbase_t-_t10_t _tfunction_t.

_tMore_t _tprecisely_t, _tthis_t _tfunction_t _ttests_t _tif_t _tthe_t _tgiven_t @_tp_t _tnode_t'_ts_t _ttype_t _tis_t @_tsbmlconstant_t{_tAST_FUNCTION_LOG_t, _tASTNodeType_t_t} _twith_t _ttwo_t _tchildren_t, _tthe_t _tfirst_t _tof_t _twhich_t _tis_t _tan_t @_tsbmlconstant_t{_tAST_INTEGER_t, _tASTNodeType_t_t} _tequal_t _tto_t @_tc_t _t10_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _trepresents_t _ta_t @_tc_t _tlog10_t() _tfunction_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tsee_t _tSBML_parseL3Formula_t()

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isLogical()

int ASTNode_isLogical ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tis_t _ta_t _tlogical_t _toperator_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _tis_t _ta_t _tMathML_t _tlogical_t _toperator_t (@_tc_t _tand_t, @_tc_t _tor_t, @_tc_t _tnot_t, @_tc_t _txor_t), @_tc_t _t0_t _totherwise_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isName()

int ASTNode_isName ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tis_t _ta_t _tnamed_t _tentity_t.

_tMore_t _tprecisely_t, _tthis_t _treturns_t _ta_t _ttrue_t _tvalue_t _tif_t @_tp_t _tnode_t _tis_t _ta_t _tuser_t-_tdefined_t _tvariable_t _tname_t _tor_t _tthe_t _tspecial_t _tsymbols_t @_tc_t _ttime_t _tor_t @_tc_t _tavogadro_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _tis_t _ta_t _tnamed_t _tvariable_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isNaN()

int ASTNode_isNaN ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _trepresents_t _tnot_t-_ta_t-_tnumber_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _tis_t _tthe_t _tspecial_t _tIEEE_t _t754_t _tvalue_t _tNaN_t ("_tnot_t _ta_t _tnumber_t"), @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isNegInfinity()

int ASTNode_isNegInfinity ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _trepresents_t _tnegative_t _tinfinity_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _tis_t _tthe_t _tspecial_t _tIEEE_t _t754_t _tvalue_t _tnegative_t _tinfinity_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tsee_t _tASTNode_isInfinity_t()

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isNumber()

int ASTNode_isNumber ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tcontains_t _ta_t _tnumber_t.

_tThis_t _tis_t _tfunctionally_t _tequivalent_t _tto_t: @_tverbatim_t _tASTNode_isInteger_t(_tnode_t) || _tASTNode_isReal_t(_tnode_t). @_tendverbatim_t

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _tis_t _ta_t _tnumber_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isOperator()

int ASTNode_isOperator ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tis_t _ta_t _tmathematical_t _toperator_t.

_tThe_t _tpossible_t _tmathematical_t _toperators_t _tare_t <_tcode_t>+</_tcode_t>, <_tcode_t>-</_tcode_t>, <_tcode_t>*</_tcode_t>, <_tcode_t>/</_tcode_t> _tand_t <_tcode_t>^</_tcode_t> (_tpower_t).

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _tis_t _tan_t _toperator_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isPiecewise()

int ASTNode_isPiecewise ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _trepresents_t _tthe_t _tMathML_t <_tcode_t>&_tlt_t;_tpiecewise_t&_tgt_t;</_tcode_t> _toperator_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _tis_t _tthe_t _tMathML_t _tpiecewise_t _tfunction_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isRational()

int ASTNode_isRational ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _trepresents_t _ta_t _trational_t _tnumber_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _tis_t _tof_t _ttype_t @_tsbmlconstant_t{_tAST_RATIONAL_t, _tASTNodeType_t_t}, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isReal()

int ASTNode_isReal ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _trepresents_t _ta_t _treal_t _tnumber_t.

_tMore_t _tprecisely_t, _tthis_t _tnode_t _tmust_t _tbe_t _tof_t _tone_t _tof_t _tthe_t _tfollowing_t _ttypes_t: @_tsbmlconstant_t{_tAST_REAL_t, _tASTNodeType_t_t}, @_tsbmlconstant_t{_tAST_REAL_E_t, _tASTNodeType_t_t} _tor_t @_tsbmlconstant_t{_tAST_RATIONAL_t, _tASTNodeType_t_t}.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tvalue_t _tof_t @_tp_t _tnode_t _tcan_t _trepresent_t _ta_t _treal_t _tnumber_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isRelational()

int ASTNode_isRelational ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _trepresents_t _ta_t _tMathML_t _trelational_t _toperator_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _tis_t _ta_t _tMathML_t _trelational_t _toperator_t, _tmeaning_t <_tcode_t>==</_tcode_t>, <_tcode_t>&_tgt_t;=</_tcode_t>, <_tcode_t>&_tlt_t;=</_tcode_t>, <_tcode_t>&_tgt_t;</_tcode_t>, <_tcode_t>&_tlt_t;</_tcode_t>, _tand_t <_tcode_t>!=</_tcode_t>.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isSetClass()

int ASTNode_isSetClass ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t'_ts_t _tMathML_t @_tc_t _tclass_t _tattribute_t _tis_t _tset_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tattribute_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isSetId()

int ASTNode_isSetId ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t'_ts_t _tMathML_t @_tc_t _tid_t _tattribute_t _tis_t _tset_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tit_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isSetParentSBMLObject()

int ASTNode_isSetParentSBMLObject ( ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t'_ts_t _tparent_t _tSBML_t _tobject_t _tis_t _tset_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tparent_t _tSBML_t _tobject_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isSetStyle()

int ASTNode_isSetStyle ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t'_ts_t _tMathML_t @_tc_t _tstyle_t _tattribute_t _tis_t _tset_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tattribute_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isSetUnits()

int ASTNode_isSetUnits ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tnode_t'_ts_t _tSBML_t "_tunits_t" _tattribute_t _tis_t _tset_t.

@_thtmlinclude_t _tabout_t-_tsbml_t-_tunits_t-_tattrib._thtml_t

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tattribute_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tnote_t _tThe_t <_tcode_t>_tsbml_t:_tunits_t</_tcode_t> _tattribute_t _tis_t _tonly_t _tavailable_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t. _tIt_t _tmay_t _tnot_t _tbe_t _tused_t _tin_t _tLevels_t _t1_t&_tndash_t;_t2_t _tof_t _tSBML_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isSetUserData()

int ASTNode_isSetUserData ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t'_ts_t _tuser_t _tdata_t _tobject_t _tis_t _tset_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tuser_t _tdata_t _tobject_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tsee_t _tASTNode_setUserData_t()

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isSqrt()

int ASTNode_isSqrt ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tis_t _tthe_t _tMathML_t _tsquare_t-_troot_t _toperator_t.

_tMore_t _tprecisely_t, _tthe_t _tnode_t _ttype_t _tmust_t _tbe_t @_tsbmlconstant_t{_tAST_FUNCTION_ROOT_t, _tASTNodeType_t_t} _twith_t _ttwo_t _tchildren_t, _tthe_t _tfirst_t _tof_t _twhich_t _tis_t _tan_t @_tsbmlconstant_t{_tAST_INTEGER_t, _tASTNodeType_t_t} _tnode_t _thaving_t _tvalue_t _tequal_t _tto_t _t2_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _trepresents_t _ta_t _tsqrt_t() _tfunction_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isUMinus()

int ASTNode_isUMinus ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _trepresents_t _ta_t _tunary_t _tminus_t.

_tA_t _tnode_t _tis_t _tdefined_t _tas_t _ta_t _tunary_t _tminus_t _tnode_t _tif_t _tit_t _tis_t _tof_t _ttype_t @_tsbmlconstant_t{_tAST_MINUS_t, _tASTNodeType_t_t} _tand_t _thas_t _texactly_t _tone_t _tchild_t.

_tFor_t _tnumbers_t, _tunary_t _tminus_t _tnodes_t _tcan_t _tbe_t "_tcollapsed_t" _tby_t _tnegating_t _tthe_t _tnumber_t. _tIn_t _tfact_t, _tSBML_parseFormula_t() _tdoes_t _tthis_t _tduring_t _tits_t _tparsing_t _tprocess_t, _tand_t _tSBML_parseL3Formula_t() _thas_t _ta_t _tconfiguration_t _toption_t _tthat_t _tallows_t _tthis_t _tbehavior_t _tto_t _tbe_t _tturned_t _ton_t _tor_t _toff_t. _tHowever_t, _tunary_t _tminus_t _tnodes_t _tfor_t _tsymbols_t (@_tsbmlconstant_t{_tAST_NAME_t, _tASTNodeType_t_t}) _tcannot_t _tbe_t "_tcollapsed_t", _tso_t _tthis_t _tpredicate_t _tfunction_t _tis_t _tstill_t _tnecessary_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _tis_t _ta_t _tunary_t _tminus_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tsee_t _tSBML_parseL3Formula_t()

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isUnknown()

int ASTNode_isUnknown ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _ttype_t _tof_t _tthe_t _tnode_t _tis_t _tunknown_t.

"_tUnknown_t" _tnodes_t _thave_t _tthe_t _ttype_t @_tsbmlconstant_t{_tAST_UNKNOWN_t, _tASTNodeType_t_t}. _tNodes_t _twith_t _tunknown_t _ttypes_t _twill_t _tnot_t _tappear_t _tin_t _tan_t _tASTNode_t_t _ttree_t _treturned_t _tby_t _tlibSBML_t _tbased_t _tupon_t _tvalid_t _tSBML_t _tinput_t; _tthe_t _tonly_t _tsituation_t _tin_t _twhich_t _ta_t _tnode_t _twith_t _ttype_t @_tsbmlconstant_t{_tAST_UNKNOWN_t, _tASTNodeType_t_t} _tmay_t _tappear_t _tis_t _timmediately_t _tafter_t _thaving_t _tcreate_t _ta_t _tnew_t, _tuntyped_t _tnode_t _tusing_t _tthe_t _tASTNode_t_t _tconstructor_t. _tCallers_t _tcreating_t _tnodes_t _tshould_t _tendeavor_t _tto_t _tset_t _tthe_t _ttype_t _tto_t _ta_t _tvalid_t _tnode_t _ttype_t _tas_t _tsoon_t _tas_t _tpossible_t _tafter_t _tcreating_t _tnew_t _tnodes_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _tis_t _tof_t _ttype_t @_tsbmlconstant_t{_tAST_UNKNOWN_t, _tASTNodeType_t_t}, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isUPlus()

int ASTNode_isUPlus ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tis_t _ta_t _tunary_t _tplus_t.

_tA_t _tnode_t _tis_t _tdefined_t _tas_t _ta_t _tunary_t _tminus_t _tnode_t _tif_t _tit_t _tis_t _tof_t _ttype_t @_tsbmlconstant_t{_tAST_PLUS_t, _tASTNodeType_t_t} _tand_t _thas_t _texactly_t _tone_t _tchild_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _tis_t _ta_t _tunary_t _tplus_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_isWellFormedASTNode()

int ASTNode_isWellFormedASTNode ( ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tis_t _twell_t-_tformed_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _tis_t _twell_t-_tformed_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tnote_t _tAn_t _tASTNode_t_t _tmay_t _tbe_t _twell_t-_tformed_t, _twith_t _teach_t _tnode_t _tand_t _tits_t _tchildren_t _thaving_t _tthe_t _tappropriate_t _tnumber_t _tof_t _tchildren_t _tfor_t _tthe_t _tgiven_t _ttype_t, _tbut_t _tmay_t _tstill_t _tbe_t _tinvalid_t _tin_t _tthe_t _tcontext_t _tof_t _tits_t _tuse_t _twithin_t _tan_t _tSBML_t _tmodel_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_prependChild()

int ASTNode_prependChild ( ASTNode_t node,
ASTNode_t disownedChild 
)

_tAdds_t _ta_t _tnode_t _tas_t _ta_t _tchild_t _tof_t _tanother_t _tnode_t.

_tThis_t _tmethod_t _tadds_t _tchild_t _tnodes_t _tfrom_t _tright_t _tto_t _tleft_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tthat_t _twill_t _treceive_t _tthe_t _tgiven_t _tchild_t _tnode_t. @_tparam_t _tdisownedChild_t _tthe_t _tASTNode_t_t _tinstance_t _tto_t _tadd_t. _tWill_t _tbecome_t _ta_t _tchild_t _tof_t _tthe_t _tparent_t _tnode_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tcopydetails_t _tdoc_warning_modifying_structure_t

@_tsee_t _tASTNode_addChild_t() @_tsee_t _tASTNode_replaceChild_t() @_tsee_t _tASTNode_insertChild_t() @_tsee_t _tASTNode_removeChild_t()

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_reduceToBinary()

void ASTNode_reduceToBinary ( ASTNode_t node)

_tReduces_t _tthe_t _tgiven_t _tnode_t _tto_t _ta_t _tbinary_t _ttrue_t.

_tExample_t: _tif_t @_tp_t _tnode_t _tis_t <_tcode_t>_tand_t(_tx_t, _ty_t, _tz_t)</_tcode_t>, _tthen_t _tthe_t _tformula_t _tof_t _tthe_t _treduced_t _tnode_t _tis_t <_tcode_t>_tand_t(_tand_t(_tx_t, _ty_t), _tz_t)</_tcode_t>. _tThe_t _toperation_t _treplaces_t _tthe_t _tformula_t _tstored_t _tin_t _tthe_t _tcurrent_t _tASTNode_t_t _tstructure_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tmodify_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_removeChild()

int ASTNode_removeChild ( ASTNode_t node,
unsigned int  n 
)

_tRemoves_t _tthe_t _tnth_t _tchild_t _tof_t _ta_t _tgiven_t _tnode_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _twhose_t _tchild_t _telement_t _tis_t _tto_t _tbe_t _tremoved_t. @_tparam_t _tn_t _tunsigned_t _tint_t _tthe_t _tindex_t _tof_t _tthe_t _tchild_t _tto_t _tremove_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INDEX_EXCEEDS_SIZE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t}

@_tcopydetails_t _tdoc_warning_modifying_structure_t

@_tsee_t _tASTNode_addChild_t() @_tsee_t _tASTNode_prependChild_t() @_tsee_t _tASTNode_replaceChild_t() @_tsee_t _tASTNode_insertChild_t()

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_replaceAndDeleteChild()

int ASTNode_replaceAndDeleteChild ( ASTNode_t node,
unsigned int  n,
ASTNode_t disownedChild 
)

_tReplaces_t _tand_t _tdeletes_t _tthe_t _tnth_t _tchild_t _tof_t _ta_t _tgiven_t _tnode_t.

@_tparam_t _tnode_t _tthe_t _tASTNode_t_t _tnode_t _tto_t _tmodify_t. @_tparam_t _tn_t _tunsigned_t _tint_t _tthe_t _tindex_t _tof_t _tthe_t _tchild_t _tto_t _treplace_t. @_tparam_t _tdisownedChild_t _tASTNode_t_t _tstructure_t _tto_t _treplace_t _tthe_t _tnth_t _tchild_t. _tWill_t _tbecome_t _ta_t _tchild_t _tof_t _tthe_t _tparent_t _tnode_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INDEX_EXCEEDS_SIZE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t}

@_tcopydetails_t _tdoc_warning_modifying_structure_t

@_tsee_t _tASTNode_addChild_t() @_tsee_t _tASTNode_prependChild_t() @_tsee_t _tASTNode_insertChild_t() @_tsee_t _tASTNode_removeChild_t() @_tsee_t _tASTNode_replaceChild_t()

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_replaceArgument()

void ASTNode_replaceArgument ( ASTNode_t node,
const char *  bvar,
ASTNode_t arg 
)

_tReplaces_t _toccurrences_t _tof_t _ta_t _tgiven_t _tname_t _twith_t _ta_t _tnew_t _tASTNode_t_t _tstructure_t.

_tFor_t _texample_t, _tif_t _tthe_t _tformula_t _tin_t @_tp_t _tnode_t _tis_t <_tcode_t>_tx_t + _ty_t</_tcode_t>, _tthen_t _tthe_t <_tcode_t>&_tlt_t;_tbvar_t&_tgt_t;</_tcode_t> _tis_t @_tc_t _tx_t _tand_t @_tc_t _targ_t _tis_t _tan_t _tASTNode_t_t _tstructure_t _trepresenting_t _tthe_t _treal_t _tvalue_t @_tc_t _t3_t. _tThis_t _tfunction_t _tsubstitutes_t @_tc_t _t3_t _tfor_t @_tc_t _tx_t _twithin_t _tthe_t @_tp_t _tnode_t _tASTNode_t_t _tstructure_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tmodify_t. @_tparam_t _tbvar_t _tthe_t _tMathML_t <_tcode_t>&_tlt_t;_tbvar_t&_tgt_t;</_tcode_t> _tto_t _tuse_t. @_tparam_t _targ_t _tthe_t _treplacement_t _tnode_t _tor_t _tstructure_t.

@_tmemberof_t _tASTNode_t_t

@_tsee_t _tASTNode_replaceAndDeleteArgument_t()

◆ ASTNode_replaceChild()

int ASTNode_replaceChild ( ASTNode_t node,
unsigned int  n,
ASTNode_t disownedChild 
)

_tReplaces_t _tbut_t _tdoes_t _tnot_t _tdelete_t _tthe_t _tnth_t _tchild_t _tof_t _ta_t _tgiven_t _tnode_t.

@_tparam_t _tnode_t _tthe_t _tASTNode_t_t _tnode_t _tto_t _tmodify_t. @_tparam_t _tn_t _tunsigned_t _tint_t _tthe_t _tindex_t _tof_t _tthe_t _tchild_t _tto_t _treplace_t. @_tparam_t _tdisownedChild_t _tASTNode_t_t _tstructure_t _tto_t _treplace_t _tthe_t _tnth_t _tchild_t. _tWill_t _tbecome_t _ta_t _tchild_t _tof_t _tthe_t _tparent_t _tnode_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INDEX_EXCEEDS_SIZE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t}

@_tcopydetails_t _tdoc_warning_modifying_structure_t

@_tsee_t _tASTNode_addChild_t() @_tsee_t _tASTNode_prependChild_t() @_tsee_t _tASTNode_insertChild_t() @_tsee_t _tASTNode_removeChild_t() @_tsee_t _tASTNode_replaceAndDeleteChild_t()

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_returnsBoolean()

int ASTNode_returnsBoolean ( const ASTNode_t node)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tis_t _tsomething_t _tthat_t _treturns_t _ta_t _tBoolean_t _tvalue_t.

_tThis_t _tfunction_t _tlooks_t _tat_t _tthe_t _twhole_t _tASTNode_t_t _tstructure_t _trather_t _tthan_t _tjust_t _tthe_t _ttop_t _tlevel_t _tof_t @_tp_t _tnode_t. _tThus_t, _tit_t _twill_t _tconsider_t _treturn_t _tvalues_t _tfrom_t _tMathML_t @_tc_t _tpiecewise_t _tstatements_t. _tIn_t _taddition_t, _tif_t _tthe_t _tASTNode_t_t _tstructure_t _tin_t @_tp_t _tnode_t _tuses_t _ta_t _tfunction_t _tcall_t, _tthis_t _tfunction_t _twill_t _texamine_t _tthe_t _treturn_t _tvalue_t _tof_t _tthe_t _tfunction_t. _tNote_t _tthat_t _tthis_t _tis_t _tonly_t _tpossible_t _tin_t _tcases_t _tthe_t _tASTNode_t_t _tstructure_t _tcan_t _ttrace_t _tits_t _tparent_t _tModel_t_t _tstructure_t; _tthat_t _tis_t, _tthe_t _tASTNode_t_t _tstructure_t _tmust_t _trepresent_t _tthe_t <_tcode_t>&_tlt_t;_tmath_t&_tgt_t;</_tcode_t> _telement_t _tof_t _tsome_t _tSBML_t _tobject_t _tthat_t _thas_t _talready_t _tbeen_t _tadded_t _tto_t _tan_t _tinstance_t _tof_t _tan_t _tSBMLDocument_t_t _tstructure_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _treturns_t _ta_t _tBoolean_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tsee_t _tASTNode_isBoolean_t() @_tsee_t _tASTNode_returnsBooleanForModel_t()

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_returnsBooleanForModel()

int ASTNode_returnsBooleanForModel ( const ASTNode_t node,
const Model_t model 
)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tnode_t _tis_t _tsomething_t _tthat_t _treturns_t _ta_t _tBoolean_t _tvalue_t.

_tThis_t _tfunction_t _tlooks_t _tat_t _tthe_t _twhole_t _tASTNode_t_t _tstructure_t _trather_t _tthan_t _tjust_t _tthe_t _ttop_t _tlevel_t _tof_t @_tp_t _tnode_t. _tThus_t, _tit_t _twill_t _tconsider_t _treturn_t _tvalues_t _tfrom_t _tMathML_t @_tc_t _tpiecewise_t _tstatements_t. _tIn_t _taddition_t, _tif_t _tthe_t _tASTNode_t_t _tstructure_t _tin_t @_tp_t _tnode_t _tuses_t _ta_t _tfunction_t _tcall_t, _tthis_t _tfunction_t _twill_t _texamine_t _tthe_t _treturn_t _tvalue_t _tof_t _tthe_t _tfunction_t _tusing_t _tthe_t _tdefinition_t _tof_t _tthe_t _tfunction_t _tfound_t _tin_t _tthe_t _tgiven_t _tModel_t_t _tstructure_t _tgiven_t _tby_t @_tp_t _tmodel_t (_trather_t _tthan_t _tthe_t _tmodel_t _tthat_t _tmight_t _tbe_t _ttraced_t _tfrom_t @_tp_t _tnode_t _titself_t). _tThis_t _tfunction_t _tis_t _tsimilar_t _tto_t _tASTNode_returnsBoolean_t(), _tbut_t _tis_t _tuseful_t _tin_t _tsituations_t _twhere_t _tthe_t _tASTNode_t_t _tstructure_t _thas_t _tnot_t _tbeen_t _thooked_t _tinto_t _ta_t _tmodel_t _tyet_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tquery_t. @_tparam_t _tmodel_t _tthe_t _tmodel_t _tto_t _tuse_t _tas_t _tthe_t _tbasis_t _tfor_t _tfinding_t _tthe_t _tdefinition_t _tof_t _tthe_t _tfunction_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tnode_t _treturns_t _ta_t _tBoolean_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tsee_t _tASTNode_isBoolean_t() @_tsee_t _tASTNode_returnsBoolean_t()

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_setCharacter()

int ASTNode_setCharacter ( ASTNode_t node,
char  value 
)

_tSets_t _tthe_t _tvalue_t _tof_t _ta_t _tgiven_t _tnode_t _tto_t _ta_t _tcharacter_t.

_tIf_t _tcharacter_t _tis_t _tone_t _tof_t @_tc_t +, @_tc_t -, <_tcode_t>*</_tcode_t>, <_tcode_t>/</_tcode_t> _tor_t @_tc_t ^, _tthe_t _tnode_t _ttype_t _twill_t _tbe_t _tset_t _taccordingly_t. _tFor_t _tall_t _tother_t _tcharacters_t, _tthe_t _tnode_t _ttype_t _twill_t _tbe_t _tset_t _tto_t @_tsbmlconstant_t{_tAST_UNKNOWN_t, _tASTNodeType_t_t}.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tset_t. @_tparam_t _tvalue_t _tthe_t _tcharacter_t _tvalue_t _tfor_t _tthe_t _tnode_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_setClass()

int ASTNode_setClass ( ASTNode_t node,
const char *  className 
)

_tSets_t _tthe_t _tMathML_t @_tc_t _tclass_t _tof_t _tthe_t _tgiven_t _tnode_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tset_t. @_tparam_t _tclassName_t _tthe_t _tnew_t _tvalue_t _tfor_t _tthe_t @_tc_t _tclass_t _tattribute_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_setDefinitionURL()

int ASTNode_setDefinitionURL ( ASTNode_t node,
XMLAttributes_t  defnURL 
)

◆ ASTNode_setDefinitionURLString()

int ASTNode_setDefinitionURLString ( ASTNode_t node,
const char *  defnURL 
)

_tSets_t _tthe_t _tMathML_t @_tc_t _tdefinitionURL_t _tattribute_t _tof_t _tthe_t _tgiven_t _tnode_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tmodify_t. @_tparam_t _tdefnURL_t _ta_t _tstring_t _tto_t _twhich_t _tthe_t _tattribute_t _tshould_t _tbe_t _tset_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_setId()

int ASTNode_setId ( ASTNode_t node,
const char *  id 
)

_tSets_t _tthe_t _tMathML_t @_tc_t _tid_t _tattribute_t _tof_t _tthe_t _tgiven_t _tnode_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tset_t. @_tparam_t _tid_t _tthe_t _tidentifier_t _tto_t _tuse_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_setInteger()

int ASTNode_setInteger ( ASTNode_t node,
long  value 
)

_tSets_t _tthe_t _tgiven_t _tnode_t _tto_t _ta_t _tinteger_t _tand_t _tsets_t _tit_t _ttype_t _tto_t @_tsbmlconstant_t{_tAST_INTEGER_t, _tASTNodeType_t_t}.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tset_t. @_tparam_t _tvalue_t _tthe_t _tvalue_t _tto_t _tset_t _tit_t _tto_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_setName()

int ASTNode_setName ( ASTNode_t node,
const char *  name 
)

_tSets_t _tthe_t _tnode_t _tto_t _trepresent_t _ta_t _tnamed_t _tentity_t.

_tAs_t _ta_t _tside_t-_teffect_t, _tthis_t _tASTNode_t_t _tobject_t'_ts_t _ttype_t _twill_t _tbe_t _treset_t _tto_t @_tsbmlconstant_t{_tAST_NAME_t, _tASTNodeType_t_t} _tif_t (_tand_t <_tem_t>_tonly_t _tif_t</_tem_t>) _tthe_t @_tp_t _tnode_t _twas_t _tpreviously_t _tan_t _toperator_t (_ti_t._te_t., _tASTNode_isOperator_t() _treturns_t _ttrue_t), _tnumber_t (_ti_t._te_t., _tASTNode_isNumber_t() _treturns_t _ttrue_t), _tor_t _tunknown_t. _tThis_t _tallows_t _tnames_t _tto_t _tbe_t _tset_t _tfor_t @_tsbmlconstant_t{_tAST_FUNCTION_t, _tASTNodeType_t_t} _tnodes_t _tand_t _tthe_t _tlike_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tset_t. @_tparam_t _tname_t _tthe_t _tname_t _tvalue_t _tfor_t _tthe_t _tnode_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tASTNode_t_t

Examples
createExampleSBML.c.

◆ ASTNode_setParentSBMLObject()

void ASTNode_setParentSBMLObject ( ASTNode_t node,
SBase_t sb 
)

@_tcond_t _tdoxygenLibsbmlInternal_t

_tSets_t _tthe_t _tparent_t _tSBase_t_t _tstructure_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tmodify_t. @_tparam_t _tsb_t _tthe_t _tparent_t _tSBase_t_t _tstructure_t _tof_t _tthis_t _tASTNode_t_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_setRational()

int ASTNode_setRational ( ASTNode_t node,
long  numerator,
long  denominator 
)

_tSets_t _tthe_t _tvalue_t _tof_t _ta_t _tgiven_t _tnode_t _tto_t _ta_t _trational_t _tnumber_t _tand_t _tsets_t _tits_t _ttype_t _tto_t @_tsbmlconstant_t{_tAST_RATIONAL_t, _tASTNodeType_t_t}.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tset_t. @_tparam_t _tnumerator_t _tthe_t _tnumerator_t _tvalue_t _tto_t _tuse_t. @_tparam_t _tdenominator_t _tthe_t _tdenominator_t _tvalue_t _tto_t _tuse_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_setReal()

int ASTNode_setReal ( ASTNode_t node,
double  value 
)

_tSets_t _tthe_t _tvalue_t _tof_t _ta_t _tgiven_t _tnode_t _tto_t _ta_t _treal_t (@_tc_t _tdouble_t) _tand_t _tsets_t _tits_t _ttype_t _tto_t @_tsbmlconstant_t{_tAST_REAL_t, _tASTNodeType_t_t}.

_tThis_t _tis_t _tfunctionally_t _tequivalent_t _tto_t: @_tverbatim_t _tASTNode_setRealWithExponent_t(_tnode_t, _tvalue_t, _t0_t); @_tendverbatim_t

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tset_t. @_tparam_t _tvalue_t _tthe_t _tvalue_t _tto_t _tset_t _tthe_t _tnode_t _tto_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_setRealWithExponent()

int ASTNode_setRealWithExponent ( ASTNode_t node,
double  mantissa,
long  exponent 
)

_tSets_t _tthe_t _tvalue_t _tof_t _ta_t _tgiven_t _tnode_t _tto_t _ta_t _treal_t (@_tc_t _tdouble_t) _tin_t _ttwo_t _tparts_t, _ta_t _tmantissa_t _tand_t _tan_t _texponent_t.

_tAs_t _ta_t _tside_t-_teffect_t, _tthe_t @_tp_t _tnode_t'_ts_t _ttype_t _twill_t _tbe_t _tset_t _tto_t @_tsbmlconstant_t{_tAST_REAL_t, _tASTNodeType_t_t}.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tset_t. @_tparam_t _tmantissa_t _tthe_t _tmantissa_t _tof_t _tthis_t _tnode_t'_ts_t _treal_t-_tnumbered_t _tvalue_t. @_tparam_t _texponent_t _tthe_t _texponent_t _tof_t _tthis_t _tnode_t'_ts_t _treal_t-_tnumbered_t _tvalue_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_setStyle()

int ASTNode_setStyle ( ASTNode_t node,
const char *  style 
)

_tSets_t _tthe_t _tMathML_t @_tc_t _tstyle_t _tof_t _tthe_t _tgiven_t _tnode_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tset_t. @_tparam_t _tstyle_t _tthe_t _tnew_t _tvalue_t _tfor_t _tthe_t @_tc_t _tstyle_t _tattribute_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_setType()

int ASTNode_setType ( ASTNode_t node,
ASTNodeType_t  type 
)

_tExplicitly_t _tsets_t _tthe_t _ttype_t _tof_t _tthe_t _tgiven_t _tASTNode_t_t _tstructure_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tset_t. @_tparam_t _ttype_t _tthe_t _tnew_t _ttype_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t}

@_tnote_t _tA_t _tside_t-_teffect_t _tof_t _tdoing_t _tthis_t _tis_t _tthat_t _tany_t _tnumerical_t _tvalues_t _tpreviously_t _tstored_t _tin_t _tthis_t _tnode_t _tare_t _treset_t _tto_t _tzero_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_setUnits()

int ASTNode_setUnits ( ASTNode_t node,
const char *  units 
)

_tSets_t _tthe_t _tunits_t _tof_t _tthe_t _tgiven_t _tnode_t.

_tThe_t _tunits_t _twill_t _tbe_t _tset_t @_tem_t _tonly_t _tif_t _tthe_t _tASTNode_t_t _tstructure_t _tin_t @_tp_t _tnode_t _trepresents_t _ta_t _tMathML_t <_tcode_t>&_tlt_t;_tcn_t&_tgt_t;</_tcode_t> _telement_t, _ti_t._te_t., _trepresents_t _ta_t _tnumber_t. _tCallers_t _tmay_t _tuse_t _tASTNode_isNumber_t() _tto_t _tinquire_t _twhether_t _tthe_t _tnode_t _tis_t _tof_t _tthat_t _ttype_t.

@_thtmlinclude_t _tabout_t-_tsbml_t-_tunits_t-_tattrib._thtml_t

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tmodify_t. @_tparam_t _tunits_t _tthe_t _tunits_t _tto_t _tset_t _tit_t _tto_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t}

@_tnote_t _tThe_t <_tcode_t>_tsbml_t:_tunits_t</_tcode_t> _tattribute_t _tis_t _tonly_t _tavailable_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t. _tIt_t _tmay_t _tnot_t _tbe_t _tused_t _tin_t _tLevels_t _t1_t&_tndash_t;_t2_t _tof_t _tSBML_t.

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_setUserData()

int ASTNode_setUserData ( ASTNode_t node,
void *  userData 
)

_tSets_t _tthe_t _tuser_t _tdata_t _tof_t _tthe_t _tgiven_t _tnode_t.

_tThe_t _tuser_t _tdata_t _tcan_t _tbe_t _tused_t _tby_t _tthe_t _tapplication_t _tdeveloper_t _tto_t _tattach_t _tcustom_t _tinformation_t _tto_t _tthe_t _tnode_t. _tIn_t _tcase_t _tof_t _ta_t _tdeep_t _tcopy_t, _tthis_t _tattribute_t _twill_t _tpassed_t _tas_t _tit_t _tis_t. _tThe_t _tattribute_t _twill_t _tbe_t _tnever_t _tinterpreted_t _tby_t _tthis_t _tclass_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tmodify_t. @_tparam_t _tuserData_t _tthe_t _tnew_t _tuser_t _tdata_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tsee_t _tASTNode_getUserData_t()

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_swapChildren()

int ASTNode_swapChildren ( ASTNode_t node,
ASTNode_t that 
)

_tSwaps_t _tthe_t _tchildren_t _tof_t _ttwo_t _tnodes_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tmodify_t.

@_tparam_t _tthat_t _tthe_t _tother_t _tnode_t _twhose_t _tchildren_t _tshould_t _tbe_t _tused_t _tto_t _treplace_t _tthose_t _tof_t @_tp_t _tnode_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_true()

int ASTNode_true ( const ASTNode *  node)

@_tcond_t _tdoxygenLibsbmlInternal_t

◆ ASTNode_unsetClass()

int ASTNode_unsetClass ( ASTNode_t node)

_tUnsets_t _tthe_t _tMathML_t @_tc_t _tclass_t _tattribute_t _tof_t _tthe_t _tgiven_t _tnode_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tmodify_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_unsetId()

int ASTNode_unsetId ( ASTNode_t node)

_tUnsets_t _tthe_t _tMathML_t @_tc_t _tid_t _tattribute_t _tof_t _tthe_t _tgiven_t _tnode_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tmodify_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_unsetParentSBMLObject()

int ASTNode_unsetParentSBMLObject ( ASTNode_t node)

_tUnsets_t _tthe_t _tparent_t _tSBase_t_t _tstructure_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tmodify_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_unsetStyle()

int ASTNode_unsetStyle ( ASTNode_t node)

_tUnsets_t _tthe_t _tMathML_t @_tc_t _tstyle_t _tattribute_t _tof_t _tthe_t _tgiven_t _tnode_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tmodify_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_unsetUnits()

int ASTNode_unsetUnits ( ASTNode_t node)

_tUnsets_t _tthe_t _tunits_t _tassociated_t _twith_t _tthe_t _tgiven_t _tnode_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tmodify_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tASTNode_t_t

◆ ASTNode_unsetUserData()

int ASTNode_unsetUserData ( ASTNode_t node)

_tUnsets_t _tthe_t _tuser_t _tdata_t _tof_t _tthe_t _tgiven_t _tnode_t.

_tThe_t _tuser_t _tdata_t _tcan_t _tbe_t _tused_t _tby_t _tthe_t _tapplication_t _tdeveloper_t _tto_t _tattach_t _tcustom_t _tinformation_t _tto_t _tthe_t _tnode_t. _tIn_t _tcase_t _tof_t _ta_t _tdeep_t _tcopy_t, _tthis_t _tattribute_t _twill_t _tpassed_t _tas_t _tit_t _tis_t. _tThe_t _tattribute_t _twill_t _tbe_t _tnever_t _tinterpreted_t _tby_t _tthis_t _tclass_t.

@_tparam_t _tnode_t _tthe_t _tnode_t _tto_t _tmodify_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tsee_t _tASTNode_getUserData_t() @_tsee_t _tASTNode_setUserData_t()

@_tmemberof_t _tASTNode_t_t

Variable Documentation

◆ AST_CONSTANT_STRINGS

const char* AST_CONSTANT_STRINGS[]
static
Initial value:
=
{
"exponentiale"
, "false"
, "pi"
, "true"
, "avogadro"
}

◆ AST_FUNCTION_STRINGS

const char* AST_FUNCTION_STRINGS[]
static

◆ AST_LAMBDA_STRING

const char* AST_LAMBDA_STRING = "lambda"
static

_tString_t _tConstants_t

◆ AST_LOGICAL_STRINGS

const char* AST_LOGICAL_STRINGS[]
static
Initial value:
=
{
"and"
, "not"
, "or"
, "xor"
}

◆ AST_OPERATOR_STRINGS

const char* AST_OPERATOR_STRINGS[]
static
Initial value:
=
{
"divide"
, "minus"
, "plus"
, "times"
, "power"
}

◆ AST_RELATIONAL_STRINGS

const char* AST_RELATIONAL_STRINGS[]
static
Initial value:
=
{
"eq"
, "geq"
, "gt"
, "leq"
, "lt"
, "neq"
}