libSBML C API  libSBML 5.20.2 C API
Loading...
Searching...
No Matches
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
}
 @_tenum_t _tSBMLTypeCode_t_t @_tbrief_t _tThe_t _tenumeration_t _tof_t _tpossible_t _tSBML_t _tcore_t _tobject_t _ttypes_t. More...
 

Functions

const char * SBMLTypeCode_toString (int tc, const char *pkgName)
 _tThis_t _tmethod_t _ttakes_t _tan_t _tSBML_t _ttype_t _tcode_t _tand_t _treturns_t _ta_t _tstring_t _trepresenting_t _tthe_t _tcode_t.
 

Detailed Description

Enumeration to identify SBML objects at runtime.

Author
Ben Bornstein

Enumeration Type Documentation

◆ SBMLTypeCode_t

@_tenum_t _tSBMLTypeCode_t_t @_tbrief_t _tThe_t _tenumeration_t _tof_t _tpossible_t _tSBML_t _tcore_t _tobject_t _ttypes_t.

@_tcopydetails_t _tdoc_what_are_typecodes_t

@_tcopydetails_t _tdoc_additional_typecode_details_t

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 
)

_tThis_t _tmethod_t _ttakes_t _tan_t _tSBML_t _ttype_t _tcode_t _tand_t _treturns_t _ta_t _tstring_t _trepresenting_t _tthe_t _tcode_t.

@_tif_t _tclike_t _tLibSBML_t _tattaches_t _tan_t _tidentifying_t _tcode_t _tto_t _tevery_t _tkind_t _tof_t _tSBML_t _tobject_t. _tThese_t _tare_t _tknown_t _tas_t <_tem_t>_tSBML_t _ttype_t _tcodes_t</_tem_t>. _tThe_t _tset_t _tof_t _tpossible_t _ttype_t _tcodes_t _tis_t _tdefined_t _tin_t _tthe_t _tenumeration_t #_tSBMLTypeCode_t_t. _tThe_t _tnames_t _tof_t _tthe_t _ttype_t _tcodes_t _tall_t _tbegin_t _twith_t _tthe_t _tcharacters_t @_tc_t _tSBML__t. @_tendif_t@_tif_t _tjava_t _tLibSBML_t _tattaches_t _tan_t _tidentifying_t _tcode_t _tto_t _tevery_t _tkind_t _tof_t _tSBML_t _tobject_t. _tThese_t _tare_t _tknown_t _tas_t <_tem_t>_tSBML_t _ttype_t _tcodes_t</_tem_t>. _tIn_t _tother_t _tlanguages_t, _tthe_t _tset_t _tof_t _ttype_t _tcodes_t _tis_t _tstored_t _tin_t _tan_t _tenumeration_t; _tin_t _tthe_t _tJava_t _tlanguage_t _tinterface_t _tfor_t _tlibSBML_t, _tthe_t _ttype_t _tcodes_t _tare_t _tdefined_t _tas_t _tstatic_t _tinteger_t _tconstants_t _tin_t _tthe_t _tinterface_t _tclass_t {@_tlink_t _tlibsbmlConstants_t}. _tThe_t _tnames_t _tof_t _tthe_t _ttype_t _tcodes_t _tall_t _tbegin_t _twith_t _tthe_t _tcharacters_t @_tc_t _tSBML__t. @_tendif_t@_tif_t _tpython_t _tLibSBML_t _tattaches_t _tan_t _tidentifying_t _tcode_t _tto_t _tevery_t _tkind_t _tof_t _tSBML_t _tobject_t. _tThese_t _tare_t _tknown_t _tas_t <_tem_t>_tSBML_t _ttype_t _tcodes_t</_tem_t>. _tIn_t _tthe_t _tPython_t _tlanguage_t _tinterface_t _tfor_t _tlibSBML_t, _tthe_t _ttype_t _tcodes_t _tare_t _tdefined_t _tas_t _tstatic_t _tinteger_t _tconstants_t _tin_t _tthe_t _tinterface_t _tclass_t @_tlink_t _tlibsbml_t@_tendlink_t. _tThe_t _tnames_t _tof_t _tthe_t _ttype_t _tcodes_t _tall_t _tbegin_t _twith_t _tthe_t _tcharacters_t @_tc_t _tSBML__t. @_tendif_t@_tif_t _tcsharp_t _tLibSBML_t _tattaches_t _tan_t _tidentifying_t _tcode_t _tto_t _tevery_t _tkind_t _tof_t _tSBML_t _tobject_t. _tThese_t _tare_t _tknown_t _tas_t <_tem_t>_tSBML_t _ttype_t _tcodes_t</_tem_t>. _tIn_t _tthe_t _tC_t# _tlanguage_t _tinterface_t _tfor_t _tlibSBML_t, _tthe_t _ttype_t _tcodes_t _tare_t _tdefined_t _tas_t _tstatic_t _tinteger_t _tconstants_t _tin_t _tthe_t _tinterface_t _tclass_t @_tlink_t _tlibsbml_t@_tendlink_t. _tThe_t _tnames_t _tof_t _tthe_t _ttype_t _tcodes_t _tall_t _tbegin_t _twith_t _tthe_t _tcharacters_t @_tc_t _tSBML__t. @_tendif_t

@_treturn_t _ta_t _thuman_t _treadable_t _tname_t _tfor_t _tthe_t _tgiven_t @_tif_t _tclike_t #_tSBMLTypeCode_t_t _tvalue_t@_telse_t _tSBML_t _ttype_t _tcode_t@_tendif_t.

@_tnote_t _tThe_t _tcaller_t _tdoes_t _tnot_t _town_t _tthe_t _treturned_t _tstring_t _tand_t _tis_t _ttherefore_t _tnot_t _tallowed_t _tto_t _tmodify_t _tit_t.