libSBML C API  libSBML 5.8.0 C API
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Rule.h File Reference

Detailed Description

Definitions of Rule and ListOfRules.

Author
Ben Bornstein
Include dependency graph for Rule.h:
This graph shows which files directly or indirectly include this file:

Enumerations

enum  RuleType_t {
  RULE_TYPE_RATE,
  RULE_TYPE_SCALAR,
  RULE_TYPE_INVALID
}
 

Functions

Rule_t * ListOfRules_getById (ListOf_t *lo, const char *sid)
 
Rule_t * ListOfRules_removeById (ListOf_t *lo, const char *sid)
 
Rule_t * Rule_clone (const Rule_t *r)
 
int Rule_containsUndeclaredUnits (Rule_t *ia)
 
Rule_t * Rule_createAlgebraic (unsigned int level, unsigned int version)
 
Rule_t * Rule_createAlgebraicWithNS (SBMLNamespaces_t *sbmlns)
 
Rule_t * Rule_createAssignment (unsigned int level, unsigned int version)
 
Rule_t * Rule_createAssignmentWithNS (SBMLNamespaces_t *sbmlns)
 
Rule_t * Rule_createRate (unsigned int level, unsigned int version)
 
Rule_t * Rule_createRateWithNS (SBMLNamespaces_t *sbmlns)
 
void Rule_free (Rule_t *r)
 
UnitDefinition_t * Rule_getDerivedUnitDefinition (Rule_t *ia)
 
const char * Rule_getFormula (const Rule_t *r)
 
int Rule_getL1TypeCode (const Rule_t *r)
 
const ASTNode_t * Rule_getMath (const Rule_t *r)
 
const XMLNamespaces_t * Rule_getNamespaces (Rule_t *r)
 
RuleType_t Rule_getType (const Rule_t *r)
 
int Rule_getTypeCode (const Rule_t *r)
 
const char * Rule_getUnits (const Rule_t *r)
 
const char * Rule_getVariable (const Rule_t *r)
 
int Rule_isAlgebraic (const Rule_t *r)
 
int Rule_isAssignment (const Rule_t *r)
 
int Rule_isCompartmentVolume (const Rule_t *r)
 
int Rule_isParameter (const Rule_t *r)
 
int Rule_isRate (const Rule_t *r)
 
int Rule_isScalar (const Rule_t *r)
 
int Rule_isSetFormula (const Rule_t *r)
 
int Rule_isSetMath (const Rule_t *r)
 
int Rule_isSetUnits (const Rule_t *r)
 
int Rule_isSetVariable (const Rule_t *r)
 
int Rule_isSpeciesConcentration (const Rule_t *r)
 
int Rule_setFormula (Rule_t *r, const char *formula)
 
int Rule_setL1TypeCode (Rule_t *r, int L1Type)
 
int Rule_setMath (Rule_t *r, const ASTNode_t *math)
 
int Rule_setUnits (Rule_t *r, const char *sname)
 
int Rule_setVariable (Rule_t *r, const char *sid)
 
int Rule_unsetUnits (Rule_t *r)
 

Enumeration Type Documentation

enum RuleType_t
Enumerator
RULE_TYPE_RATE 
RULE_TYPE_SCALAR 
RULE_TYPE_INVALID 

Function Documentation

Rule_t* ListOfRules_getById ( ListOf_t *  lo,
const char *  sid 
)
Rule_t* ListOfRules_removeById ( ListOf_t *  lo,
const char *  sid 
)
Rule_t* Rule_clone ( const Rule_t *  r)
int Rule_containsUndeclaredUnits ( Rule_t *  ia)
Rule_t* Rule_createAlgebraic ( unsigned int  level,
unsigned int  version 
)
Rule_t* Rule_createAlgebraicWithNS ( SBMLNamespaces_t *  sbmlns)
Rule_t* Rule_createAssignment ( unsigned int  level,
unsigned int  version 
)
Rule_t* Rule_createAssignmentWithNS ( SBMLNamespaces_t *  sbmlns)
Rule_t* Rule_createRate ( unsigned int  level,
unsigned int  version 
)
Rule_t* Rule_createRateWithNS ( SBMLNamespaces_t *  sbmlns)
void Rule_free ( Rule_t *  r)
UnitDefinition_t* Rule_getDerivedUnitDefinition ( Rule_t *  ia)
const char* Rule_getFormula ( const Rule_t *  r)
int Rule_getL1TypeCode ( const Rule_t *  r)
const ASTNode_t* Rule_getMath ( const Rule_t *  r)
const XMLNamespaces_t* Rule_getNamespaces ( Rule_t *  r)
RuleType_t Rule_getType ( const Rule_t *  r)
int Rule_getTypeCode ( const Rule_t *  r)
const char* Rule_getUnits ( const Rule_t *  r)
const char* Rule_getVariable ( const Rule_t *  r)
int Rule_isAlgebraic ( const Rule_t *  r)
int Rule_isAssignment ( const Rule_t *  r)
int Rule_isCompartmentVolume ( const Rule_t *  r)
int Rule_isParameter ( const Rule_t *  r)
int Rule_isRate ( const Rule_t *  r)
int Rule_isScalar ( const Rule_t *  r)
int Rule_isSetFormula ( const Rule_t *  r)
int Rule_isSetMath ( const Rule_t *  r)
int Rule_isSetUnits ( const Rule_t *  r)
int Rule_isSetVariable ( const Rule_t *  r)
int Rule_isSpeciesConcentration ( const Rule_t *  r)
int Rule_setFormula ( Rule_t *  r,
const char *  formula 
)
int Rule_setL1TypeCode ( Rule_t *  r,
int  L1Type 
)
int Rule_setMath ( Rule_t *  r,
const ASTNode_t *  math 
)
int Rule_setUnits ( Rule_t *  r,
const char *  sname 
)
int Rule_setVariable ( Rule_t *  r,
const char *  sid 
)
int Rule_unsetUnits ( Rule_t *  r)