Detailed Description

qual Extension of Model_t.

The extension of SBML Level 3 Core's Model_t class is relatively straightforward: the Qualitative Models Package adds two lists, one for holding qualitativeSpecies (ListOfQualitativeSpecies_t), and the other for holding transitions (ListOfTransitions_t). The Model_t element may contain at most one ListOfQualitativeSpecies_t, which must contain at least one QualitativeSpecies_t. It may also contain at most one ListOfTransitions_t which must contain at least one Transition_t.

Public Member Functions
int	QualModelPlugin_addQualitativeSpecies (QualModelPlugin_t qmp, const QualitativeSpecies_t qs)
	Adds a copy of the given QualitativeSpecies_t to this QualModelPlugin_t. More...

int	QualModelPlugin_addTransition (QualModelPlugin_t qmp, const Transition_t t)
	Adds a copy of the given Transition_t to this QualModelPlugin_t. More...

QualitativeSpecies_t *	QualModelPlugin_createQualitativeSpecies (QualModelPlugin_t *qmp)
	Creates a new QualitativeSpecies_t object, adds it to this QualModelPlugin_t object and returns the QualitativeSpecies_t object created. More...

Transition_t *	QualModelPlugin_createTransition (QualModelPlugin_t *qmp)
	Creates a new Transition_t object, adds it to this QualModelPlugin_t object and returns the Transition_t object created. More...

ListOf_t *	QualModelPlugin_getListOfQualitativeSpecies (QualModelPlugin_t *qmp)
	Returns a ListOf_t * containing QualitativeSpecies_t objects from this QualModelPlugin_t. More...

ListOf_t *	QualModelPlugin_getListOfTransitions (QualModelPlugin_t *qmp)
	Returns a ListOf_t * containing Transition_t objects from this QualModelPlugin_t. More...

unsigned int	QualModelPlugin_getNumQualitativeSpecies (QualModelPlugin_t *qmp)
	Get the number of QualitativeSpecies_t objects in this QualModelPlugin_t. More...

unsigned int	QualModelPlugin_getNumTransitions (QualModelPlugin_t *qmp)
	Get the number of Transition_t objects in this QualModelPlugin_t. More...

const QualitativeSpecies_t *	QualModelPlugin_getQualitativeSpecies (QualModelPlugin_t *qmp, unsigned int n)
	Get a QualitativeSpecies_t from the QualModelPlugin_t. More...

const QualitativeSpecies_t *	QualModelPlugin_getQualitativeSpeciesByCompartment (QualModelPlugin_t qmp, const char sid)
	Get a QualitativeSpecies_t from the QualModelPlugin_t based on the Compartment_t to which it refers. More...

const QualitativeSpecies_t *	QualModelPlugin_getQualitativeSpeciesById (QualModelPlugin_t qmp, const char sid)
	Get a QualitativeSpecies_t from the QualModelPlugin_t based on its identifier. More...

const Transition_t *	QualModelPlugin_getTransition (QualModelPlugin_t *qmp, unsigned int n)
	Get a Transition_t from the QualModelPlugin_t. More...

const Transition_t *	QualModelPlugin_getTransitionById (QualModelPlugin_t qmp, const char sid)
	Get a Transition_t from the QualModelPlugin_t based on its identifier. More...

QualitativeSpecies_t *	QualModelPlugin_removeQualitativeSpecies (QualModelPlugin_t *qmp, unsigned int n)
	Removes the nth QualitativeSpecies_t from this QualModelPlugin_t and returns a pointer to it. More...

QualitativeSpecies_t *	QualModelPlugin_removeQualitativeSpeciesById (QualModelPlugin_t qmp, const char sid)
	Removes the QualitativeSpecies_t from this QualModelPlugin_t based on its identifier and returns a pointer to it. More...

Transition_t *	QualModelPlugin_removeTransition (QualModelPlugin_t *qmp, unsigned int n)
	Removes the nth Transition_t from this QualModelPlugin_t and returns a pointer to it. More...

Transition_t *	QualModelPlugin_removeTransitionById (QualModelPlugin_t qmp, const char sid)
	Removes the Transition_t from this QualModelPlugin_t based on its identifier and returns a pointer to it. More...

Member Function Documentation

int QualModelPlugin_addQualitativeSpecies	(	QualModelPlugin_t *	qmp,
		const QualitativeSpecies_t *	qs
	)

Adds a copy of the given QualitativeSpecies_t to this QualModelPlugin_t.

Parameters

qmp	the QualModelPlugin_t structure to which the QualitativeSpecies_t should be added.
qs	the QualitativeSpecies_t object to add.

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 QualModelPlugin_addTransition	(	QualModelPlugin_t *	qmp,
		const Transition_t *	t
	)

Adds a copy of the given Transition_t to this QualModelPlugin_t.

Parameters

qmp	the QualModelPlugin_t structure to which the Transition_t should be added.
t	the Transition_t object to add.

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:

QualitativeSpecies_t * QualModelPlugin_createQualitativeSpecies ( QualModelPlugin_t * qmp )

Creates a new QualitativeSpecies_t object, adds it to this QualModelPlugin_t object and returns the QualitativeSpecies_t object created.

Parameters

qmp	the QualModelPlugin_t structure to which the QualitativeSpecies_t should be added.

Returns: a new QualitativeSpecies_t object instance.

Transition_t * QualModelPlugin_createTransition ( QualModelPlugin_t * qmp )

Creates a new Transition_t object, adds it to this QualModelPlugin_t object and returns the Transition_t object created.

Parameters

qmp	the QualModelPlugin_t structure to which the Transition_t should be added.

Returns: a new Transition_t object instance.

ListOf_t * QualModelPlugin_getListOfQualitativeSpecies ( QualModelPlugin_t * qmp )

Returns a ListOf_t * containing QualitativeSpecies_t objects from this QualModelPlugin_t.

Parameters

qmp	the QualModelPlugin_t structure whose ListOfQualitativeSpecies_t is sought.

Returns: the ListOfQualitativeSpecies_t from this QualModelPlugin_t as a ListOf_t *.

ListOf_t * QualModelPlugin_getListOfTransitions ( QualModelPlugin_t * qmp )

Returns a ListOf_t * containing Transition_t objects from this QualModelPlugin_t.

Parameters

qmp	the QualModelPlugin_t structure whose ListOfTransitions_t is sought.

Returns: the ListOfTransitions_t from this QualModelPlugin_t as a ListOf_t *.

unsigned int QualModelPlugin_getNumQualitativeSpecies ( QualModelPlugin_t * qmp )

Get the number of QualitativeSpecies_t objects in this QualModelPlugin_t.

Parameters

qmp	the QualModelPlugin_t structure to query.

Returns: the number of QualitativeSpecies_t objects in this QualModelPlugin_t.

unsigned int QualModelPlugin_getNumTransitions ( QualModelPlugin_t * qmp )

Get the number of Transition_t objects in this QualModelPlugin_t.

Parameters

qmp	the QualModelPlugin_t structure to query.

Returns: the number of Transition_t objects in this QualModelPlugin_t.

const QualitativeSpecies_t * QualModelPlugin_getQualitativeSpecies	(	QualModelPlugin_t *	qmp,
		unsigned int	n
	)

Get a QualitativeSpecies_t from the QualModelPlugin_t.

Parameters

qmp	the QualModelPlugin_t structure to search.
n	an unsigned int representing the index of the QualitativeSpecies_t to retrieve.

Returns: the nth QualitativeSpecies_t in the ListOfQualitativeSpecies_t within this QualModelPlugin_t. If the index n is invalid, NULL is returned.

const QualitativeSpecies_t * QualModelPlugin_getQualitativeSpeciesByCompartment	(	QualModelPlugin_t *	qmp,
		const char *	sid
	)

Get a QualitativeSpecies_t from the QualModelPlugin_t based on the Compartment_t to which it refers.

Parameters

qmp	the QualModelPlugin_t structure to search.
sid	a string representing the compartment attribute of the QualitativeSpecies_t object to retrieve.

Returns: the first QualitativeSpecies_t in this QualModelPlugin_t based on the given compartment attribute or NULL if no such QualitativeSpecies_t exists.

const QualitativeSpecies_t * QualModelPlugin_getQualitativeSpeciesById	(	QualModelPlugin_t *	qmp,
		const char *	sid
	)

Get a QualitativeSpecies_t from the QualModelPlugin_t based on its identifier.

Parameters

qmp	the QualModelPlugin_t structure to search.
sid	a string representing the identifier of the QualitativeSpecies_t to retrieve.

Returns: the QualitativeSpecies_t in the ListOfQualitativeSpecies_t within this QualModelPlugin_t with the given id or NULL if no such QualitativeSpecies_t exists.

const Transition_t * QualModelPlugin_getTransition	(	QualModelPlugin_t *	qmp,
		unsigned int	n
	)

Get a Transition_t from the QualModelPlugin_t.

Parameters

qmp	the QualModelPlugin_t structure to search.
n	an unsigned int representing the index of the Transition_t to retrieve.

Returns: the nth Transition_t in the ListOfTransitions_t within this QualModelPlugin_t. If the index n is invalid, NULL is returned.

const Transition_t * QualModelPlugin_getTransitionById	(	QualModelPlugin_t *	qmp,
		const char *	sid
	)

Get a Transition_t from the QualModelPlugin_t based on its identifier.

Parameters

qmp	the QualModelPlugin_t structure to search.
sid	a string representing the identifier of the Transition_t to retrieve.

Returns: the Transition_t in the ListOfTransitions_t within this QualModelPlugin_t with the given id or NULL if no such Transition_t exists.

QualitativeSpecies_t * QualModelPlugin_removeQualitativeSpecies	(	QualModelPlugin_t *	qmp,
		unsigned int	n
	)

Removes the nth QualitativeSpecies_t from this QualModelPlugin_t and returns a pointer to it.

Parameters

qmp	the QualModelPlugin_t structure to search.
n	an unsigned int representing the index of the QualitativeSpecies_t to remove.

Returns: a pointer to the nth QualitativeSpecies_t in this QualModelPlugin_t.

QualitativeSpecies_t * QualModelPlugin_removeQualitativeSpeciesById	(	QualModelPlugin_t *	qmp,
		const char *	sid
	)

Removes the QualitativeSpecies_t from this QualModelPlugin_t based on its identifier and returns a pointer to it.

Parameters

qmp	the QualModelPlugin_t structure to search.
sid	a string representing the identifier of the QualitativeSpecies_t to remove.

Returns: the QualitativeSpecies_t in this QualModelPlugin_t based on the identifier or NULL if no such QualitativeSpecies_t exists.

Transition_t * QualModelPlugin_removeTransition	(	QualModelPlugin_t *	qmp,
		unsigned int	n
	)

Removes the nth Transition_t from this QualModelPlugin_t and returns a pointer to it.

Parameters

qmp	the QualModelPlugin_t structure to search.
n	an unsigned int representing the index of the Transition_t to remove.

Returns: a pointer to the nth Transition_t in this QualModelPlugin_t.

Transition_t * QualModelPlugin_removeTransitionById	(	QualModelPlugin_t *	qmp,
		const char *	sid
	)

Removes the Transition_t from this QualModelPlugin_t based on its identifier and returns a pointer to it.

Parameters

qmp	the QualModelPlugin_t structure to search.
sid	a string representing the identifier of the Transition_t to remove.

Returns: the Transition_t in this QualModelPlugin_t based on the identifier or NULL if no such Transition_t exists.

Detailed Description

Public Member Functions

Member Function Documentation