libSBML C API  libSBML 5.20.4 C API
Loading...
Searching...
No Matches
SpeciesReferenceRole.h File Reference

Definition of SpeciesReferenceRole enum for SBML Layout_t. More...

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

Enumerations

enum  SpeciesReferenceRole_t {
  SPECIES_ROLE_UNDEFINED ,
  SPECIES_ROLE_SUBSTRATE ,
  SPECIES_ROLE_PRODUCT ,
  SPECIES_ROLE_SIDESUBSTRATE ,
  SPECIES_ROLE_SIDEPRODUCT ,
  SPECIES_ROLE_MODIFIER ,
  SPECIES_ROLE_ACTIVATOR ,
  SPECIES_ROLE_INHIBITOR ,
  SPECIES_ROLE_INVALID
}
 @_tenum_t _tSpeciesReferenceRole_t_t @_tbrief_t _tSpeciesReferenceRole_t_t _tis_t _tthe_t _tenumeration_t _tof_t _tpossible_t _tvalues_t _tfor_t _tthe_t '_trole_t' _tattribute_t _tof_t _ta_t _tSpeciesReferenceGlyph_t. More...
 

Detailed Description

Definition of SpeciesReferenceRole enum for SBML Layout_t.

Author
Ralph Gauges

Enumeration Type Documentation

◆ SpeciesReferenceRole_t

@_tenum_t _tSpeciesReferenceRole_t_t @_tbrief_t _tSpeciesReferenceRole_t_t _tis_t _tthe_t _tenumeration_t _tof_t _tpossible_t _tvalues_t _tfor_t _tthe_t '_trole_t' _tattribute_t _tof_t _ta_t _tSpeciesReferenceGlyph_t.

_tThe_t _trole_t _tattribute_t _tis_t _tof_t _ttype_t _tSpeciesReferenceRole_t _tand_t _tis_t _tused_t _tto_t _tspecify_t _thow_t _tthe_t _tspecies_t _treference_t _tshould_t _tbe_t _tdisplayed_t. _tAllowed_t _tvalues_t _tare_t '_tsubstrate_t', '_tproduct_t', '_tsidesubstrate_t', '_tsideproduct_t', '_tmodifier_t', '_tactivator_t', '_tinhibitor_t' _tand_t '_tundefined_t'.

_tThis_t _tattribute_t _tis_t _toptional_t _tand_t _tshould_t _tonly_t _tbe_t _tnecessary_t _tif_t _tthe_t _toptional_t _tspeciesReference_t _tattribute_t _tis_t _tnot_t _tgiven_t _tor_t _tif_t _tthe_t _trespective_t _tinformation_t _tfrom_t _tthe_t _tmodel_t _tneeds_t _tto_t _tbe_t _toverridden_t.

Enumerator
SPECIES_ROLE_UNDEFINED 

'undefined': The role of the referenced Species is undefined.

SPECIES_ROLE_SUBSTRATE 

'substrate': The referenced Species is a principle substrate of the reaction.

SPECIES_ROLE_PRODUCT 

'product': The referenced Species is a principle product of the reaction.

SPECIES_ROLE_SIDESUBSTRATE 

'sidesubstrate': The referenced Species is a side substrate of the reaction. Used for simple chemicals such as ATP, NAD+, etc.

SPECIES_ROLE_SIDEPRODUCT 

'sideproduct': The referenced Species is a side product of the reaction. Used for simple chemicals such as ATP, NAD+, etc.

SPECIES_ROLE_MODIFIER 

'modifier': The referenced Species influences the reaction in some way, but is not produced or consumed by it.

SPECIES_ROLE_ACTIVATOR 

The referenced Species acts as an activator of the reaction.

SPECIES_ROLE_INHIBITOR 

The referenced Species acts as an inhibitor of the reaction.

SPECIES_ROLE_INVALID 

Used by libSBML to note that the role is not set, or is invalid and will not be written out.