IntraSpeciesReaction_t Class Reference

Detailed Description

multi A subclass of Reaction_t for changes of an internal species bond.

An IntraSpeciesReaction_t is derived from Reaction_t for the reactions happening within a Species_t. A particular Reaction_t may happen within a Species_t as an IntraSpeciesReaction_t if the following conditions are fulfilled:

• The Reaction_t is either an association reaction or a dissociation reaction.

• If it is an association reaction, each of the two reactant Species_t has at least one OutwardBindingSite_t free ("unbound").

• If it is a dissociation reaction, each of the two product Species_t has at least one OutwardBindingSite_t free ("unbound").

Note: Technically, transformations are also reactions happening with one Species_t, but they do not have the ambiguity of association and dissociation reactions. Therefore, a transformation reaction does not have to be defined as an IntraSpeciesReaction_t.

Public Member Functions
IntraSpeciesReaction_t *	IntraSpeciesReaction_clone (IntraSpeciesReaction_t *isr)
	Creates a deep copy of the given IntraSpeciesReaction_t structure. More...
IntraSpeciesReaction_t *	IntraSpeciesReaction_create (unsigned int level, unsigned int version, unsigned int pkgVersion)
	Creates a new IntraSpeciesReaction_t structure using the given SBML level and version, and the pkgVersion package version. More...
void	IntraSpeciesReaction_free (IntraSpeciesReaction_t *isr)
	Frees the given IntraSpeciesReaction_t structure. More...
int	IntraSpeciesReaction_hasRequiredAttributes (const IntraSpeciesReaction_t *isr)
	Predicate returning 1 (true) or 0 (false) depending on whether all the required attributes of the given IntraSpeciesReaction_t structure have been set. More...

Member Function Documentation

IntraSpeciesReaction_t * IntraSpeciesReaction_clone

(

IntraSpeciesReaction_t *

isr

)

Creates a deep copy of the given IntraSpeciesReaction_t structure.

Parameters

isr	the IntraSpeciesReaction_t structure to be copied.

Returns

a (deep) copy of the given IntraSpeciesReaction_t structure, or a null pointer if a failure occurred.

IntraSpeciesReaction_t * IntraSpeciesReaction_create	(	unsigned int	level,
		unsigned int	version,
		unsigned int	pkgVersion
	)

Creates a new IntraSpeciesReaction_t structure using the given SBML level and version, and the pkgVersion package version.

Parameters

level	an unsigned int, the SBML level to assign to this IntraSpeciesReaction_t structure.
version	an unsigned int, the SBML version to assign to this IntraSpeciesReaction_t structure.
pkgVersion	an unsigned int, the version of the package to assign to this IntraSpeciesReaction_t structure.

Returns

the newly-created IntraSpeciesReaction_t structure, or a null pointer if an error occurred during construction.

Note

Attempting to add an object to an SBMLDocument_t having a different combination of SBML Level, Version and XML namespaces than the object itself will result in an error at the time a caller attempts to make the addition. A parent object must have compatible Level, Version and XML namespaces. (Strictly speaking, a parent may also have more XML namespaces than a child, but the reverse is not permitted.) The restriction is necessary to ensure that an SBML model has a consistent overall structure. This requires callers to manage their objects carefully, but the benefit is increased flexibility in how models can be created by permitting callers to create objects bottom-up if desired. In situations where objects are not yet attached to parents (e.g., SBMLDocument_t), knowledge of the intented SBML Level and Version help libSBML determine such things as whether it is valid to assign a particular value to an attribute.

void IntraSpeciesReaction_free

(

IntraSpeciesReaction_t *

isr

)

Frees the given IntraSpeciesReaction_t structure.

Parameters

isr	the IntraSpeciesReaction_t structure to be freed.

int IntraSpeciesReaction_hasRequiredAttributes

(

const IntraSpeciesReaction_t *

isr

)

Predicate returning 1 (true) or 0 (false) depending on whether all the required attributes of the given IntraSpeciesReaction_t structure have been set.

Parameters

isr	the IntraSpeciesReaction_t structure to check.

Returns

1 (true) if all the required attributes for this structure have been defined, 0 (false) otherwise.