Detailed Description

qual The input to a QualitativeSpecies_t.

Each Input_t refers to a QualitativeSpecies_t that participates in the corresponding Transition_t. In Petri nets, these are the input places of the transition. In logical models, they are the regulators of the species whose behaviour is defined by the transition.

Public Member Functions
Input_t *	Input_clone (Input_t *i)
	Returns a copy of the given Input_t structure. More...

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

void	Input_free (Input_t *i)
	Frees the given Input_t structure. More...

char *	Input_getId (Input_t *i)
	Takes an Input_t structure and returns its identifier. More...

char *	Input_getName (Input_t *i)
	Takes a Input_t structure and returns its name. More...

char *	Input_getQualitativeSpecies (Input_t *i)
	Takes a Input_t structure and returns its qualitativeSpecies. More...

InputSign_t	Input_getSign (Input_t *i)
	Takes a Input_t structure and returns its sign as a InputSign_t (an enumerated value of legal possible values for the attribute). More...

int	Input_getThresholdLevel (Input_t *i)
	Takes a Input_t structure and returns its thresholdLevel. More...

InputTransitionEffect_t	Input_getTransitionEffect (Input_t *i)
	Takes a Input_t structure and returns its transitionEffect as a InputTransitionEffect_t (an enumerated value of legal possible values for the attribute). More...

int	Input_hasRequiredAttributes (Input_t *i)
	Predicate returning `1` (true) or `0` (false) depending on whether all the required attributes for the given Input_t structure have been set. More...

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

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

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

int	Input_isSetSign (Input_t *i)
	Predicate returning `1` (true) or `0` (false) depending on whether the given Input_t structure's sign is set. More...

int	Input_isSetThresholdLevel (Input_t *i)
	Predicate returning `1` (true) or `0` (false) depending on whether the given Input_t structure's thresholdLevel is set. More...

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

int	Input_setId (Input_t i, const char sid)
	Assigns the identifier of an Input_t structure. More...

int	Input_setName (Input_t i, const char name)
	Sets the name of the given Input_t to a copy of `name`. More...

int	Input_setQualitativeSpecies (Input_t i, const char qualitativeSpecies)
	Sets the qualitativeSpecies of the given Input_t to a copy of `qualitativeSpecies`. More...

int	Input_setSign (Input_t *i, InputSign_t sign)
	Sets the sign of this Input_t to a copy of the given InputSign_t. More...

int	Input_setThresholdLevel (Input_t *i, int thresholdLevel)
	Sets the "thresholdLevel" attribute of the given Input_t structure. More...

int	Input_setTransitionEffect (Input_t *i, InputTransitionEffect_t transitionEffect)
	Sets the transitionEffect of this Input_t to a copy of the given InputTransitionEffect_t. More...

int	Input_unsetId (Input_t *i)
	Unsets the "id" attribute of the given Input_t structure. More...

int	Input_unsetName (Input_t *i)
	Unsets the "name" attribute of the given Input_t structure. More...

int	Input_unsetQualitativeSpecies (Input_t *i)
	Unsets the "qualitativeSpecies" attribute of the given Input_t structure. More...

int	Input_unsetSign (Input_t *i)
	Unsets the "sign" attribute of the given Input_t structure. More...

int	Input_unsetThresholdLevel (Input_t *i)
	Unsets the "thresholdLevel" attribute of the given Input_t structure. More...

int	Input_unsetTransitionEffect (Input_t *i)
	Unsets the "transitionEffect" attribute of the given Input_t structure. More...

InputSign_t	InputSign_fromString (const char *s)
	Returns the InputSign_t enumeration corresponding to the given string, or INPUT_SIGN_VALUE_NOTSET if there is no such match. More...

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

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

const char *	InputSign_toString (InputSign_t effect)
	Returns the string version of the provided InputSign_t enumeration. More...

InputTransitionEffect_t	InputTransitionEffect_fromString (const char *s)
	Returns the InputTransitionEffect_t enumeration corresponding to the given string, or INPUT_TRANSITION_EFFECT_UNKNOWN if there is no such match. More...

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

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

const char *	InputTransitionEffect_toString (InputTransitionEffect_t effect)
	Returns the string version of the provided InputTransitionEffect_t enumeration. More...

Member Function Documentation

Input_t * Input_clone ( Input_t * i )

Returns a copy of the given Input_t structure.

Parameters

i	the Input_t structure to copy.

Returns: a (deep) copy of the Input_t.

Input_t * Input_create	(	unsigned int	level,
		unsigned int	version,
		unsigned int	pkgVersion
	)

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

Returns: a pointer to the newly created Input_t structure.

void Input_free ( Input_t * i )

Frees the given Input_t structure.

Parameters

i	the Input_t structure to free.

char * Input_getId ( Input_t * i )

Takes an Input_t structure and returns its identifier.

Parameters

i	the Input_t structure whose identifier is sought.

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

char * Input_getName ( Input_t * i )

Takes a Input_t structure and returns its name.

Parameters

i	the Input_t whose name is sought.

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

char * Input_getQualitativeSpecies ( Input_t * i )

Takes a Input_t structure and returns its qualitativeSpecies.

Parameters

i	the Input_t whose qualitativeSpecies is sought.

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

InputSign_t Input_getSign ( Input_t * i )

Takes a Input_t structure and returns its sign as a InputSign_t (an enumerated value of legal possible values for the attribute).

Parameters

i	the Input_t whose sign is sought.

Returns: the sign of the given Input_t, as a InputSign_t

int Input_getThresholdLevel ( Input_t * i )

Takes a Input_t structure and returns its thresholdLevel.

Parameters

i	the Input_t whose thresholdLevel is sought.

Returns: the thresholdLevel attribute of the given Input_t, as an int.

InputTransitionEffect_t Input_getTransitionEffect ( Input_t * i )

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

Parameters

i	the Input_t whose transitionEffect is sought.

Returns: the transitionEffect of the given Input_t, as a InputTransitionEffect_t

int Input_hasRequiredAttributes ( Input_t * i )

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

Note

The required attributes for a Input_t structure are:

qualitativeSpecies
transitionEffect

int Input_isSetId ( Input_t * i )

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

Parameters

i	the Input_t structure to query.

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

int Input_isSetName ( Input_t * i )

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

Parameters

i	the Input_t structure to query.

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

int Input_isSetQualitativeSpecies ( Input_t * i )

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

Parameters

i	the Input_t structure to query.

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

int Input_isSetSign ( Input_t * i )

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

Parameters

i	the Input_t structure to query.

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

int Input_isSetThresholdLevel ( Input_t * i )

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

Parameters

i	the Input_t structure to query.

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

int Input_isSetTransitionEffect ( Input_t * i )

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

Parameters

i	the Input_t structure to query.

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

int Input_setId	(	Input_t *	i,
		const char *	sid
	)

Assigns the identifier of an Input_t structure.

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

Parameters

i	the Input_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 Input_setName	(	Input_t *	i,
		const char *	name
	)

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

Parameters

i	the Input_t structure to set.
name	the name to assign to the given Input_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 Input_setQualitativeSpecies	(	Input_t *	i,
		const char *	qualitativeSpecies
	)

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

Parameters

i	the Input_t structure to set.
qualitativeSpecies	the qualitativeSpecies to assign to the given Input_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 Input_setSign	(	Input_t *	i,
		InputSign_t	sign
	)

Sets the sign of this Input_t to a copy of the given InputSign_t.

Parameters

i	the Input_t structure to set.
sign	the InputSign_t structure to use.

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 Input_setThresholdLevel	(	Input_t *	i,
		int	thresholdLevel
	)

Sets the "thresholdLevel" attribute of the given Input_t structure.

Parameters

i	the Input_t structure.
thresholdLevel	the value of thresholdLevel to assign to the "thresholdLevel" 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 Input_setTransitionEffect	(	Input_t *	i,
		InputTransitionEffect_t	transitionEffect
	)

Sets the transitionEffect of this Input_t to a copy of the given InputTransitionEffect_t.

Parameters

i	the Input_t structure to set.
transitionEffect	the InputTransitionEffect_t structure to use.

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 Input_unsetId ( Input_t * i )

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

Parameters

i	the Input_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 Input_unsetName ( Input_t * i )

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

Parameters

i	the Input_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 Input_unsetQualitativeSpecies ( Input_t * i )

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

Parameters

i	the Input_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 Input_unsetSign ( Input_t * i )

Unsets the "sign" attribute of the given Input_t structure.

Parameters

i	the Input_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 Input_unsetThresholdLevel ( Input_t * i )

Unsets the "thresholdLevel" attribute of the given Input_t structure.

Parameters

i	the Input_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 Input_unsetTransitionEffect ( Input_t * i )

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

Parameters

i	the Input_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:

InputSign_t InputSign_fromString ( const char * s )

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

The matching is case-sensitive: "negative" will return INPUT_SIGN_NEGATIVE, but "Negative" will return INPUT_SIGN_VALUE_NOTSET.

Parameters

s	the string to convert to an InputSign_t.

Returns: The corresponding InputSign_t, or INPUT_SIGN_VALUE_NOTSET if no match found.

int InputSign_isValidInputSign ( InputSign_t effect )

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

Parameters

effect the InputSign_t enumeration to query.

Returns: 1 (true) if the InputSign_t is INPUT_SIGN_POSITIVE, INPUT_SIGN_NEGATIVE, INPUT_SIGN_DUAL, or INPUT_SIGN_UNKNOWN; 0 (false) otherwise (including INPUT_SIGN_VALUE_NOTSET).

int InputSign_isValidInputSignString ( const char * s )

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

The matching is case-sensitive: "negative" will return 1 (true), but "Negative" will return 0 (false).

Parameters

s	the string to query.

Returns: 1 (true) if the string is "positive", "negative", "dual", or "unknown"; 0 (false) otherwise.

const char * InputSign_toString ( InputSign_t effect )

Returns the string version of the provided InputSign_t enumeration.

Parameters

effect the InputSign_t enumeration to convert.

Returns: A string corresponding to the given effect: "positive", "negative", "dual", "unknown", or NULL if the value is INPUT_SIGN_VALUE_NOTSET or some other invalid enumeration value.

InputTransitionEffect_t InputTransitionEffect_fromString ( const char * s )

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

The matching is case-sensitive: "none" will return INPUT_TRANSITION_EFFECT_NONE, but "NONE" will return INPUT_TRANSITION_EFFECT_UNKNOWN.

Parameters

s	the string to convert to an InputTransitionEffect_t.

Returns: The corresponding InputTransitionEffect_t, or INPUT_TRANSITION_EFFECT_UNKNOWN if no match found.

int InputTransitionEffect_isValidInputTransitionEffect ( InputTransitionEffect_t effect )

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

Parameters

effect the InputTransitionEffect_t enumeration to query.

Returns: 1 (true) if the InputTransitionEffect_t is INPUT_TRANSITION_EFFECT_NONE or INPUT_TRANSITION_EFFECT_CONSUMPTION, 0 (false) otherwise (including INPUT_TRANSITION_EFFECT_UNKNOWN).

int InputTransitionEffect_isValidInputTransitionEffectString ( const char * s )

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

The matching is case-sensitive: "none" will return 1 (true), but "NONE" will return 0 (false).

Parameters

s	the string to query.

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

const char * InputTransitionEffect_toString ( InputTransitionEffect_t effect )

Returns the string version of the provided InputTransitionEffect_t enumeration.

Parameters

effect the InputTransitionEffect_t enumeration to convert.

Returns: A string corresponding to the given effect: "none", "consumption", or NULL if the value is INPUT_TRANSITION_EFFECT_UNKNOWN or another invalid enumeration value.

Detailed Description

Public Member Functions

Member Function Documentation