DefaultTerm_t Class Reference

Detailed Description

qual The default result of a Transition_t.

The DefaultTerm_t defines the default result of a Transition_t, held in the (required) "resultLevel" attribute. This term is used when there are no other FunctionTerm_t elements or when none of the Math elements of the FunctionTerm_t elements evaluate to true.

Public Member Functions
DefaultTerm_t *	DefaultTerm_clone (DefaultTerm_t *dt)
	Returns a copy of the given DefaultTerm_t structure. More...
DefaultTerm_t *	DefaultTerm_create (unsigned int level, unsigned int version, unsigned int pkgVersion)
	Creates a new DefaultTerm_t structure using the given SBML level and version, and the pkgVersion package version. More...
void	DefaultTerm_free (DefaultTerm_t *dt)
	Frees the given DefaultTerm_t structure. More...
int	DefaultTerm_getResultLevel (DefaultTerm_t *dt)
	Takes a DefaultTerm_t structure and returns its resultLevel. More...
int	DefaultTerm_hasRequiredAttributes (DefaultTerm_t *dt)
	Predicate returning true or false depending on whether all the required attributes for the given DefaultTerm_t structure have been set. More...
int	DefaultTerm_isSetResultLevel (DefaultTerm_t *dt)
	Predicate returning 1 (true) or 0 (false) depending on whether the given DefaultTerm_t structure's resultLevel is set. More...
int	DefaultTerm_setResultLevel (DefaultTerm_t *dt, int resultLevel)
	Sets the "resultLevel" attribute of the given DefaultTerm_t structure. More...
int	DefaultTerm_unsetResultLevel (DefaultTerm_t *dt)
	Unsets the "resultLevel" attribute of the given DefaultTerm_t structure. More...

Member Function Documentation

DefaultTerm_t * DefaultTerm_clone

(

DefaultTerm_t *

dt

)

Returns a copy of the given DefaultTerm_t structure.

Parameters

dt	the DefaultTerm_t structure to copy.

Returns

a (deep) copy of the DefaultTerm_t.

DefaultTerm_t * DefaultTerm_create	(	unsigned int	level,
		unsigned int	version,
		unsigned int	pkgVersion
	)

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

Returns

a pointer to the newly created DefaultTerm_t structure.

void DefaultTerm_free

(

DefaultTerm_t *

dt

)

Frees the given DefaultTerm_t structure.

Parameters

dt	the DefaultTerm_t structure to free.

int DefaultTerm_getResultLevel

(

DefaultTerm_t *

dt

)

Takes a DefaultTerm_t structure and returns its resultLevel.

Parameters

dt	the DefaultTerm_t whose resultLevel is sought.

Returns

the resultLevel attribute of the given DefaultTerm_t, as an int.

int DefaultTerm_hasRequiredAttributes

(

DefaultTerm_t *

dt

)

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

Note

The required attributes for a DefaultTerm_t structure are:

• resultLevel

int DefaultTerm_isSetResultLevel

(

DefaultTerm_t *

dt

)

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

Parameters

dt	the DefaultTerm_t structure to query.

Returns

1 (true) if the "resultLevel" attribute of the given DefaultTerm_t structure is set, 0 (false) otherwise.

int DefaultTerm_setResultLevel	(	DefaultTerm_t *	dt,
		int	resultLevel
	)

Sets the "resultLevel" attribute of the given DefaultTerm_t structure.

Parameters

dt	the DefaultTerm_t structure.
resultLevel	the value of resultLevel to assign to the "resultLevel" 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:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_UNEXPECTED_ATTRIBUTE

int DefaultTerm_unsetResultLevel

(

DefaultTerm_t *

dt

)

Unsets the "resultLevel" attribute of the given DefaultTerm_t structure.

Parameters

dt	the DefaultTerm_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:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_OPERATION_FAILED