Detailed Description

fbc Extension of Reaction_t by the “fbc” package.

The FbcReactionPlugin_t class inherits from the SBasePlugin_t class, and codifies the extentions to the Reaction_t class defined in the Flux Balance Constraints package (“fbc”). This extention allows the modeler to define (in Version 2 of the “fbc” package) an upper and lower flux bound, with the 'upperFluxBound' and 'lowerFluxBound' attributes, as well as a way to reference any GeneProduct_t associated with this Reaction_t, through the GeneProductAssociation_t child.

Note: In Version 1 of “fbc”, the FluxBound_t element is used instead of the 'upperFluxBound' and 'lowerFluxBound' attributes. There is no equivalent of the GeneProductAssociation_t, which was added in Version 2.

Public Member Functions
GeneProductAssociation_t *	FbcReactionPlugin_getGeneProductAssociation (SBasePlugin_t *fbc)
	Takes a FbcReactionPlugin_t structure and returns its GeneProductAssociation_t. More...

char *	FbcReactionPlugin_getLowerFluxBound (SBasePlugin_t *fbc)
	Takes a FbcReactionPlugin_t structure and returns its "lowerFluxBound" attribute. More...

char *	FbcReactionPlugin_getUpperFluxBound (SBasePlugin_t *fbc)
	Takes a FbcReactionPlugin_t structure and returns its "upperFluxBound" attribute. More...

int	FbcReactionPlugin_isSetGeneProductAssociation (SBasePlugin_t *fbc)
	Predicate returning `1` (true) or `0` (false) depending on whether the given FbcReactionPlugin_t structure's GeneProductAssociation_t is set. More...

int	FbcReactionPlugin_isSetLowerFluxBound (SBasePlugin_t *fbc)
	Predicate returning `1` (true) or `0` (false) depending on whether the given FbcReactionPlugin_t structure's "lowerFluxBound" attribute is set. More...

int	FbcReactionPlugin_isSetUpperFluxBound (SBasePlugin_t *fbc)
	Predicate returning `1` (true) or `0` (false) depending on whether the given FbcReactionPlugin_t structure's "upperFluxBound" attribute is set. More...

int	FbcReactionPlugin_setGeneProductAssociation (SBasePlugin_t fbc, GeneProductAssociation_t gpa)
	Takes a FbcReactionPlugin_t structure and sets its GeneProductAssociation_t. More...

int	FbcReactionPlugin_setLowerFluxBound (SBasePlugin_t fbc, const char LowerFluxBound)
	Sets the "lowerFluxBound" attribute of the given FbcReactionPlugin_t to a copy of `LowerFluxBound`. More...

int	FbcReactionPlugin_setUpperFluxBound (SBasePlugin_t fbc, const char UpperFluxBound)
	Sets the "upperFluxBound" attribute of the given FbcReactionPlugin_t to a copy of `UpperFluxBound`. More...

int	FbcReactionPlugin_unsetUpperFluxBound (SBasePlugin_t *fbc)
	Unsets the "upperFluxBound" attribute of the given FbcReactionPlugin_t structure. More...

Member Function Documentation

GeneProductAssociation_t * FbcReactionPlugin_getGeneProductAssociation ( SBasePlugin_t * fbc )

Takes a FbcReactionPlugin_t structure and returns its GeneProductAssociation_t.

Parameters

fbc	the FbcReactionPlugin_t whose GeneProductAssociation_t is sought.

Returns: the a pointer to the GeneProductAssociation_t of the given FbcReactionPlugin_t.

char * FbcReactionPlugin_getLowerFluxBound ( SBasePlugin_t * fbc )

Takes a FbcReactionPlugin_t structure and returns its "lowerFluxBound" attribute.

Parameters

fbc	the FbcReactionPlugin_t whose "lowerFluxBound" attribute is sought.

Returns: the "lowerFluxBound" attribute of the given FbcReactionPlugin_t, as a pointer to a string.

char * FbcReactionPlugin_getUpperFluxBound ( SBasePlugin_t * fbc )

Takes a FbcReactionPlugin_t structure and returns its "upperFluxBound" attribute.

Parameters

fbc	the FbcReactionPlugin_t whose "upperFluxBound" attribute is sought.

Returns: the "upperFluxBound" attribute of the given FbcReactionPlugin_t, as a pointer to a string.

int FbcReactionPlugin_isSetGeneProductAssociation ( SBasePlugin_t * fbc )

Predicate returning 1 (true) or 0 (false) depending on whether the given FbcReactionPlugin_t structure's GeneProductAssociation_t is set.

Parameters

fbc	the FbcReactionPlugin_t structure to query.

Returns: 1 (true) if the "geneProductAssopciation" elemen of the given FbcReactionPlugin_t structure is set, 0 (false) otherwise.

int FbcReactionPlugin_isSetLowerFluxBound ( SBasePlugin_t * fbc )

Predicate returning 1 (true) or 0 (false) depending on whether the given FbcReactionPlugin_t structure's "lowerFluxBound" attribute is set.

Parameters

fbc	the FbcReactionPlugin_t structure to query.

Returns: 1 (true) if the "lowerFluxBound" attribute attribute of the given FbcReactionPlugin_t structure is set, 0 (false) otherwise.

int FbcReactionPlugin_isSetUpperFluxBound ( SBasePlugin_t * fbc )

Predicate returning 1 (true) or 0 (false) depending on whether the given FbcReactionPlugin_t structure's "upperFluxBound" attribute is set.

Parameters

fbc	the FbcReactionPlugin_t structure to query.

Returns: 1 (true) if the "upperFluxBound" attribute of the given FbcReactionPlugin_t structure is set, 0 (false) otherwise.

int FbcReactionPlugin_setGeneProductAssociation	(	SBasePlugin_t *	fbc,
		GeneProductAssociation_t *	gpa
	)

Takes a FbcReactionPlugin_t structure and sets its GeneProductAssociation_t.

Parameters

fbc	the FbcReactionPlugin_t whose GeneProductAssociation_t is sought.
gpa	a pointer to the GeneProductAssociation_t to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int FbcReactionPlugin_setLowerFluxBound	(	SBasePlugin_t *	fbc,
		const char *	LowerFluxBound
	)

Sets the "lowerFluxBound" attribute of the given FbcReactionPlugin_t to a copy of LowerFluxBound.

Parameters

fbc	the FbcReactionPlugin_t structure to set.
LowerFluxBound	the string to assign to the given FbcReactionPlugin_t's "lowerFluxBound" attribute.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

Note: Using this function with the name set to NULL is equivalent to unsetting the "lowerFluxBound" attribute.

int FbcReactionPlugin_setUpperFluxBound	(	SBasePlugin_t *	fbc,
		const char *	UpperFluxBound
	)

Sets the "upperFluxBound" attribute of the given FbcReactionPlugin_t to a copy of UpperFluxBound.

Parameters

fbc	the FbcReactionPlugin_t structure to set.
UpperFluxBound	the string to assign to the given FbcReactionPlugin_t's "upperFluxBound" attribute.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

Note: Using this function with the name set to NULL is equivalent to unsetting the "upperFluxBound" attribute.

int FbcReactionPlugin_unsetUpperFluxBound ( SBasePlugin_t * fbc )

Unsets the "upperFluxBound" attribute of the given FbcReactionPlugin_t structure.

Parameters

fbc	the FbcReactionPlugin_t structure to unset.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

Detailed Description

Public Member Functions

Member Function Documentation