libSBML Perl API  libSBML 5.17.2 Perl API
SBMLTypeCodes.h File Reference

Enumeration to identify SBML objects at runtime. More...

Include dependency graph for SBMLTypeCodes.h:
This graph shows which files directly or indirectly include this file:

Enumerations

enum  SBMLTypeCode_t {
  SBML_UNKNOWN = 0,
  SBML_COMPARTMENT = 1,
  SBML_COMPARTMENT_TYPE = 2,
  SBML_CONSTRAINT = 3,
  SBML_DOCUMENT = 4,
  SBML_EVENT = 5,
  SBML_EVENT_ASSIGNMENT = 6,
  SBML_FUNCTION_DEFINITION = 7,
  SBML_INITIAL_ASSIGNMENT = 8,
  SBML_KINETIC_LAW = 9,
  SBML_LIST_OF = 10,
  SBML_MODEL = 11,
  SBML_PARAMETER = 12,
  SBML_REACTION = 13,
  SBML_RULE = 14,
  SBML_SPECIES = 15,
  SBML_SPECIES_REFERENCE = 16,
  SBML_SPECIES_TYPE = 17,
  SBML_MODIFIER_SPECIES_REFERENCE = 18,
  SBML_UNIT_DEFINITION = 19,
  SBML_UNIT = 20,
  SBML_ALGEBRAIC_RULE = 21,
  SBML_ASSIGNMENT_RULE = 22,
  SBML_RATE_RULE = 23,
  SBML_SPECIES_CONCENTRATION_RULE = 24,
  SBML_COMPARTMENT_VOLUME_RULE = 25,
  SBML_PARAMETER_RULE = 26,
  SBML_TRIGGER = 27,
  SBML_DELAY = 28,
  SBML_STOICHIOMETRY_MATH = 29,
  SBML_LOCAL_PARAMETER = 30,
  SBML_PRIORITY = 31,
  SBML_GENERIC_SBASE = 32
}
 The enumeration of possible SBML core object types. More...
 

Functions

const char * SBMLTypeCode_toString (int tc, const char *pkgName)
 This method takes an SBML type code and returns a string representing the code. More...
 

Detailed Description

Enumeration to identify SBML objects at runtime.

Author
Ben Bornstein

Enumeration Type Documentation

◆ SBMLTypeCode_t

The enumeration of possible SBML core object types.

Enumerator
SBML_UNKNOWN 

An unknown SBase type. The default, but will not be returned for any SBML core object, nor any fully-implemented package object.

SBML_COMPARTMENT 

Compartment

SBML_COMPARTMENT_TYPE 

CompartmentType (Note: L2 only)

SBML_CONSTRAINT 

Constraint

SBML_DOCUMENT 

SBMLDocument

SBML_EVENT 

Event

SBML_EVENT_ASSIGNMENT 

EventAssignment

SBML_FUNCTION_DEFINITION 

FunctionDefinition

SBML_INITIAL_ASSIGNMENT 

InitialAssignment

SBML_KINETIC_LAW 

KineticLaw

SBML_LIST_OF 

ListOf

SBML_MODEL 

Model

SBML_PARAMETER 

Parameter

SBML_REACTION 

Reaction

SBML_RULE 

Rule (Note: will not be returned from any getType function on any SBML core object, as it is an abstract base class only.)

SBML_SPECIES 

Species

SBML_SPECIES_REFERENCE 

SpeciesReference

SBML_SPECIES_TYPE 

SpeciesType (Note: L2 only)

SBML_MODIFIER_SPECIES_REFERENCE 

ModifierSpeciesReference

SBML_UNIT_DEFINITION 

UnitDefinition

SBML_UNIT 

Unit

SBML_ALGEBRAIC_RULE 

AlgebraicRule

SBML_ASSIGNMENT_RULE 

AssignmentRule

SBML_RATE_RULE 

RateRule

SBML_SPECIES_CONCENTRATION_RULE 

A Rule of the L1 type SpeciesConcentrationRule

SBML_COMPARTMENT_VOLUME_RULE 

A Rule of the L1 type CompartmentVolumeRule

SBML_PARAMETER_RULE 

A Rule of the L1 type ParameterRule

SBML_TRIGGER 

Trigger

SBML_DELAY 

Delay

SBML_STOICHIOMETRY_MATH 

StoichiometryMath (Note: L2 only)

SBML_LOCAL_PARAMETER 

LocalParameter

SBML_PRIORITY 

Priority

SBML_GENERIC_SBASE 

Any SBase-derived class. Not returned by any getType function, but used internally for packages that extend the SBase class itself, in the PKGNAMEExtension classes (such as CompExtension).

Function Documentation

◆ SBMLTypeCode_toString()

const char* SBMLTypeCode_toString ( int  tc,
const char *  pkgName 
)

This method takes an SBML type code and returns a string representing the code.

Returns
a human readable name for the given SBML type code.
Note
The caller does not own the returned string and is therefore not allowed to modify it.