SpeciesReferenceRole.h File Reference

Definition of SpeciesReferenceRole enum for SBML Layout. 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 }
	SpeciesReferenceRole_t is the enumeration of possible values for the 'role' attribute of a SpeciesReferenceGlyph. More...

Detailed Description

Definition of SpeciesReferenceRole enum for SBML Layout.

Author

Ralph Gauges

Enumeration Type Documentation

enum SpeciesReferenceRole_t

SpeciesReferenceRole_t is the enumeration of possible values for the 'role' attribute of a SpeciesReferenceGlyph.

The role attribute is of type SpeciesReferenceRole and is used to specify how the species reference should be displayed. Allowed values are 'substrate', 'product', 'sidesubstrate', 'sideproduct', 'modifier', 'activator', 'inhibitor' and 'undefined'.

This attribute is optional and should only be necessary if the optional speciesReference attribute is not given or if the respective information from the model needs to be overridden.

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.