Detailed Description

qual The output from a QualitativeSpecies_t.

Each Output_t refers to a QualitativeSpecies_t that participates in (is affected by) the corresponding Transition_t. In Petri net models these are the output places of the transition.

In a logical model, a QualitativeSpecies_t should be referenced in at most one ListOfOutputs_t, (that of the Transition_t defining the evolution of this species). When a Transition_t has several outputs, it is because the referenced species share the same regulators and the same logical rules.

Public Member Functions
Output_t *	Output_clone (Output_t *o)
	Returns a copy of the given Output_t structure. More...

Output_t *	Output_create (unsigned int level, unsigned int version, unsigned int pkgVersion)
	Creates a new Output_t structure using the given SBML `level` and `version`, and the `pkgVersion` package version. More...

void	Output_free (Output_t *o)
	Frees the given Output_t structure. More...

char *	Output_getId (Output_t *o)
	Takes an Output_t structure and returns its identifier. More...

char *	Output_getName (Output_t *o)
	Takes a Output_t structure and returns its name. More...

int	Output_getOutputLevel (Output_t *o)
	Takes a Output_t structure and returns its outputLevel. More...

char *	Output_getQualitativeSpecies (Output_t *o)
	Takes a Output_t structure and returns its qualitativeSpecies. More...

OutputTransitionEffect_t	Output_getTransitionEffect (Output_t *o)
	Takes a Output_t structure and returns its transitionEffect as a OutputTransitionEffect_t (an enumerated value of legal possible values for the attribute). More...

int	Output_hasRequiredAttributes (Output_t *o)
	Predicate returning `true` or `false` depending on whether all the required attributes for the given Output_t structure have been set. More...

int	Output_isSetId (Output_t *o)
	Predicate returning `1` (true) or `0` (false) depending on whether the given Output_t structure's identifier is set. More...

int	Output_isSetName (Output_t *o)
	Predicate returning `1` (true) or `0` (false) depending on whether the given Output_t structure's name is set. More...

int	Output_isSetOutputLevel (Output_t *o)
	Predicate returning `1` (true) or `0` (false) depending on whether the given Output_t structure's outputLevel is set. More...

int	Output_isSetQualitativeSpecies (Output_t *o)
	Predicate returning `1` (true) or `0` (false) depending on whether the given Output_t structure's qualitativeSpecies is set. More...

int	Output_isSetTransitionEffect (Output_t *o)
	Predicate returning `1` (true) or `0` (false) depending on whether the given Output_t structure's transitionEffect is set. More...

int	Output_setId (Output_t o, const char sid)
	Assigns the identifier of an Output_t structure. More...

int	Output_setName (Output_t o, const char name)
	Sets the name of the given Output_t to a copy of `name`. More...

int	Output_setOutputLevel (Output_t *o, int outputLevel)
	Sets the "outputLevel" attribute of the given Output_t structure. More...

int	Output_setQualitativeSpecies (Output_t o, const char qualitativeSpecies)
	Sets the qualitativeSpecies of the given Output_t to a copy of `qualitativeSpecies`. More...

int	Output_setTransitionEffect (Output_t o, const char transitionEffect)
	Sets the transitionEffect of the given Output_t to a copy of `transitionEffect`. More...

int	Output_unsetId (Output_t *o)
	Unsets the "id" attribute of the given Output_t structure. More...

int	Output_unsetName (Output_t *o)
	Unsets the "name" attribute of the given Output_t structure. More...

int	Output_unsetOutputLevel (Output_t *o)
	Unsets the "outputLevel" attribute of the given Output_t structure. More...

int	Output_unsetQualitativeSpecies (Output_t *o)
	Unsets the "qualitativeSpecies" attribute of the given Output_t structure. More...

int	Output_unsetTransitionEffect (Output_t *o)
	Unsets the "transitionEffect" attribute of the given Output_t structure. More...

OutputTransitionEffect_t	OutputTransitionEffect_fromString (const char *s)
	Returns the OutputTransitionEffect_t enumeration corresponding to the given string, or OUTPUT_TRANSITION_EFFECT_UNKNOWN if there is no such match. More...

int	OutputTransitionEffect_isValidOutputTransitionEffect (OutputTransitionEffect_t effect)
	Predicate returning `1` (true) or `0` (false) depending on whether the given OutputTransitionEffect_t is valid. More...

int	OutputTransitionEffect_isValidOutputTransitionEffectString (const char *s)
	Predicate returning `1` (true) or `0` (false) depending on whether the given string is a valid OutputTransitionEffect_t. More...

const char *	OutputTransitionEffect_toString (OutputTransitionEffect_t effect)
	Returns the string version of the provided OutputTransitionEffect_t enumeration. More...

Member Function Documentation

Output_t * Output_clone ( Output_t * o )

Returns a copy of the given Output_t structure.

Parameters

o	the Output_t structure to copy.

Returns: a (deep) copy of the Output_t.

Output_t * Output_create	(	unsigned int	level,
		unsigned int	version,
		unsigned int	pkgVersion
	)

Creates a new Output_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 Output_t.
version	an unsigned int, the SBML Version to assign to this Output_t.
pkgVersion	an unsigned int, the SBML 'Qual' package Version to assign to this Output_t.

Returns: a pointer to the newly created Output_t structure.

void Output_free ( Output_t * o )

Frees the given Output_t structure.

Parameters

o	the Output_t structure to free.

char * Output_getId ( Output_t * o )

Takes an Output_t structure and returns its identifier.

Parameters

o	the Output_t structure whose identifier is sought.

Returns: the identifier of this Output_t, as a pointer to a string.

char * Output_getName ( Output_t * o )

Takes a Output_t structure and returns its name.

Parameters

o	the Output_t whose name is sought.

Returns: the name of this Output_t, as a pointer to a string.

int Output_getOutputLevel ( Output_t * o )

Takes a Output_t structure and returns its outputLevel.

Parameters

o	the Output_t whose outputLevel is sought.

Returns: the outputLevel attribute of the given Output_t, as an int.

char * Output_getQualitativeSpecies ( Output_t * o )

Takes a Output_t structure and returns its qualitativeSpecies.

Parameters

o	the Output_t whose qualitativeSpecies is sought.

Returns: the qualitativeSpecies of the given Output_t, as a pointer to a string.

OutputTransitionEffect_t Output_getTransitionEffect ( Output_t * o )

Takes a Output_t structure and returns its transitionEffect as a OutputTransitionEffect_t (an enumerated value of legal possible values for the attribute).

Parameters

o	the Output_t whose transitionEffect is sought.

Returns: the transitionEffect of the given Output_t, as a OutputTransitionEffect_t

int Output_hasRequiredAttributes ( Output_t * o )

Predicate returning true or false depending on whether all the required attributes for the given Output_t structure have been set.

Note

The required attributes for a Output_t structure are:

qualitativeSpecies
transitionEffect

int Output_isSetId ( Output_t * o )

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

Parameters

o	the Output_t structure to query.

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

int Output_isSetName ( Output_t * o )

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

Parameters

o	the Output_t structure to query.

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

int Output_isSetOutputLevel ( Output_t * o )

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

Parameters

o	the Output_t structure to query.

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

int Output_isSetQualitativeSpecies ( Output_t * o )

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

Parameters

o	the Output_t structure to query.

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

int Output_isSetTransitionEffect ( Output_t * o )

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

Parameters

o	the Output_t structure to query.

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

int Output_setId	(	Output_t *	o,
		const char *	sid
	)

Assigns the identifier of an Output_t structure.

This makes a copy of the string passed in the parameter sid.

Parameters

o	the Output_t structure to set.
sid	the string to use as the identifier.

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 an sid of NULL is equivalent to unsetting the "id" attribute.

int Output_setName	(	Output_t *	o,
		const char *	name
	)

Sets the name of the given Output_t to a copy of name.

Parameters

o	the Output_t structure to set.
name	the name to assign to the given Output_t's "name" 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 "name" attribute.

int Output_setOutputLevel	(	Output_t *	o,
		int	outputLevel
	)

Sets the "outputLevel" attribute of the given Output_t structure.

Parameters

o	the Output_t structure.
outputLevel	the value of outputLevel to assign to the "outputLevel" 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:

int Output_setQualitativeSpecies	(	Output_t *	o,
		const char *	qualitativeSpecies
	)

Sets the qualitativeSpecies of the given Output_t to a copy of qualitativeSpecies.

Parameters

o	the Output_t structure to set.
qualitativeSpecies	the qualitativeSpecies to assign to the given Output_t's "qualitativeSpecies" 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 "qualitativeSpecies" attribute.

int Output_setTransitionEffect	(	Output_t *	o,
		const char *	transitionEffect
	)

Sets the transitionEffect of the given Output_t to a copy of transitionEffect.

Parameters

o	the Output_t structure to set.
transitionEffect	the transitionEffect to assign to the given Output_t's "transitionEffect" 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 "transitionEffect" attribute.

int Output_unsetId ( Output_t * o )

Unsets the "id" attribute of the given Output_t structure.

Parameters

o	the Output_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:

int Output_unsetName ( Output_t * o )

Unsets the "name" attribute of the given Output_t structure.

Parameters

o	the Output_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:

int Output_unsetOutputLevel ( Output_t * o )

Unsets the "outputLevel" attribute of the given Output_t structure.

Parameters

o	the Output_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:

int Output_unsetQualitativeSpecies ( Output_t * o )

Unsets the "qualitativeSpecies" attribute of the given Output_t structure.

Parameters

o	the Output_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:

int Output_unsetTransitionEffect ( Output_t * o )

Unsets the "transitionEffect" attribute of the given Output_t structure.

Parameters

o	the Output_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:

OutputTransitionEffect_t OutputTransitionEffect_fromString ( const char * s )

Returns the OutputTransitionEffect_t enumeration corresponding to the given string, or OUTPUT_TRANSITION_EFFECT_UNKNOWN if there is no such match.

The matching is case-sensitive: "production" will return OUTPUT_TRANSITION_EFFECT_PRODUCTION, but "Production" will return OUTPUT_TRANSITION_EFFECT_UNKNOWN.

Parameters

s	the string to convert to an OutputTransitionEffect_t.

Returns: The corresponding OutputTransitionEffect_t, or OUTPUT_TRANSITION_EFFECT_UNKNOWN if no match found.

int OutputTransitionEffect_isValidOutputTransitionEffect ( OutputTransitionEffect_t effect )

Predicate returning 1 (true) or 0 (false) depending on whether the given OutputTransitionEffect_t is valid.

Parameters

effect the OutputTransitionEffect_t enumeration to query.

Returns: 1 (true) if the OutputTransitionEffect_t is OUTPUT_TRANSITION_EFFECT_PRODUCTION or OUTPUT_TRANSITION_EFFECT_ASSIGNMENT_LEVEL, 0 (false) otherwise (including OUTPUT_TRANSITION_EFFECT_UNKNOWN).

int OutputTransitionEffect_isValidOutputTransitionEffectString ( const char * s )

Predicate returning 1 (true) or 0 (false) depending on whether the given string is a valid OutputTransitionEffect_t.

The matching is case-sensitive: "production" will return true, but "Production" will return false.

Parameters

s	the string to query.

Returns: 1 (true) if the string is "production" or "assignmentLevel"; 0 (false) otherwise.

const char * OutputTransitionEffect_toString ( OutputTransitionEffect_t effect )

Returns the string version of the provided OutputTransitionEffect_t enumeration.

Parameters

effect the OutputTransitionEffect_t enumeration to convert.

Returns: A string corresponding to the given effect: "production", "assignmentLevel", or NULL if the value is OUTPUT_TRANSITION_EFFECT_UNKNOWN or another invalid enumeration value.

Detailed Description

Public Member Functions

Member Function Documentation