OutwardBindingSite.h File Reference

: Implementation of the OutwardBindingSite_t class More...

Include dependency graph for OutwardBindingSite.h:

This graph shows which files directly or indirectly include this file:

Enumerations
enum	BindingStatus_t {   MULTI_BINDING_STATUS_BOUND,   MULTI_BINDING_STATUS_UNBOUND,   MULTI_BINDING_STATUS_EITHER,   MULTI_BINDING_STATUS_UNKNOWN }
	Enumeration of possible binding status of a OutwardBindingSite_t in the libSBML "multi" package implementation. More...

Detailed Description

: Implementation of the OutwardBindingSite_t class

Author

: SBMLTeam

Enumeration Type Documentation

enum BindingStatus_t

Enumeration of possible binding status of a OutwardBindingSite_t in the libSBML "multi" package implementation.

LibSBML attaches an identifying code to every kind of SBML object. These are integer constants known as SBML type codes. The names of all the codes begin with the characters SBML_. The set of possible type codes for core elements is defined in the enumeration SBMLTypeCode_t, and in addition, libSBML plug-ins for SBML Level 3 packages define their own extra enumerations of type codes (e.g., SBMLLayoutTypeCode_t for the Level 3 Layout_t package). Note that different Level 3 package plug-ins may use overlapping type codes; to identify the package to which a given object belongs, call the SBase_getPackageName() method on the object.

The exception to this is lists: all SBML-style list elements have the type SBML_LIST_OF, regardless of what package they are from.

Here follow some additional general information about libSBML type codes:

• The codes are the possible return values (integers) for the following functions:
  • SBase_t::getTypeCode()
  • ListOf_t::getItemTypeCode()
  (Compatibility note: in libSBML 5, the type of return values of these functions changed from an enumeration to an integer for extensibility in the face of different programming languages.)

• Each package extension must define similar sets of values for each SBase_t subclass (e.g. SBMLLayoutTypeCode_t for the SBML Level 3 Layout extension, SBMLFbcTypeCode_t for the SBML Level 3 Flux Balance Constraints extension, etc.).

• The value of each package-specific type code can be duplicated between those of different packages. (This is necessary because the development of libSBML extensions for different SBML packages may be undertaken by different developers at different times; requiring the developers to coordinate their use of type codes would be nettlesome and probably doomed to failure.)

• To distinguish between the type codes of different packages, both the return value of SBase_t::getTypeCode() and SBase_t::getPackageName() must be checked. This is particularly important for functions that take an SBML type code as an argument, such as SBase_t::getAncestorOfType(), which by default assumes you are handing it a core type, and will return NULL if the value you give it is actually from a package.

The following example code illustrates the combined use of SBase_t::getPackageName() and SBase_t::getTypeCode():

Enumerator
MULTI_BINDING_STATUS_BOUND	The status of the OutwardBindingSite_t is 'bound'.
MULTI_BINDING_STATUS_UNBOUND	The status of the OutwardBindingSite_t is 'unbound'.
MULTI_BINDING_STATUS_EITHER	The status of the OutwardBindingSite_t is either 'bound' or 'unbound'.
MULTI_BINDING_STATUS_UNKNOWN	The status of the OutwardBindingSite_t is unknown. This value is not permitted for valid SBML models.