Detailed Description

multi Defines a outward-facing binding site for a MultiSpeciesType_t.

The OutwardBindingSite_t object is a child of a Species_t (via the MultiSpeciesPlugin_t). It has two optional attributes, "id" and "name", and two required attributes, "bindingStatus" and "component". A binding site not involved in any InSpeciesTypeBond_t object in the MultiSpeciesType_t referenced by a Species_t is an OutwardBindingSite_t. The bindingStatus attribute is of type BindingStatus_t. The component attribute, of type SIdRef, references a component which ultimately references a BindingSiteSpeciesType_t object. The attribute value must be the identifier of a SpeciesTypeInstance_t, SpeciesTypeComponentIndex_t or MultiSpeciesType_t object. An OutwardBindingSite_t cannot be a binding site referenced by any InSpeciesTypeBond_t in the species. There are three scenarios for the component attribute to have the value of an identifier of MultiSpeciesType_t, SpeciesTypeInstance_t, or SpeciesTypeComponentIndex_t respectively:

When a Species_t references a simple BindingSiteSpeciesType_t, the value of the component attribute of the OutwardBindingSite_t of the Species_t can only be the id of the referenced MultiSpeciesType_t.
When a Species_t references a MultiSpeciesType_t with a SpeciesTypeInstance_t being a binding site (have an id of BindingSiteSpeciesType_t as its "speciesType" attribute) and the id of the SpeciesTypeInstance_t can identify the binding site within the MultiSpeciesType_t (referenced by the Species_t) unambiguously, and therefore, the value of the component attribute of an OutwardBindingSite_t of the species can be the id of the SpeciesTypeInstance_t.
When a Species_t references a MultiSpeciesType_t with a SpeciesTypeInstance_t being a binding site (directly or indirectly) and id of the SpeciesTypeInstance_t can NOT identify the binding site without ambiguity, an id of SpeciesTypeComponentIndex_t can be used as the value of the component attribute of an OutwardBindingSite_t of the Species_t.

Public Member Functions
OutwardBindingSite_t *	OutwardBindingSite_clone (OutwardBindingSite_t *obs)
	Creates and returns a deep copy of this OutwardBindingSite_t object. More...

OutwardBindingSite_t *	OutwardBindingSite_create (unsigned int level, unsigned int version, unsigned int pkgVersion)
	Creates a new OutwardBindingSite_t using the given SBML Level, Version and “multi” package version. More...

void	OutwardBindingSite_free (OutwardBindingSite_t *obs)
	Frees this OutwardBindingSite_t object. More...

BindingStatus_t	OutwardBindingSite_getBindingStatus (const OutwardBindingSite_t *obs)
	Returns the value of the "bindingStatus" attribute of this OutwardBindingSite_t. More...

const char *	OutwardBindingSite_getBindingStatusAsString (const OutwardBindingSite_t *obs)
	Returns the value of the "bindingStatus" attribute of this OutwardBindingSite_t. More...

char *	OutwardBindingSite_getComponent (const OutwardBindingSite_t *obs)
	Returns the value of the "component" attribute of this OutwardBindingSite_t. More...

char *	OutwardBindingSite_getId (const OutwardBindingSite_t *obs)
	Returns the value of the "id" attribute of this OutwardBindingSite_t. More...

char *	OutwardBindingSite_getName (const OutwardBindingSite_t *obs)
	Returns the value of the "name" attribute of this OutwardBindingSite_t. More...

int	OutwardBindingSite_hasRequiredAttributes (OutwardBindingSite_t *obs)
	Predicate returning `1` (true) if all the required attributes for this OutwardBindingSite_t object have been set. More...

int	OutwardBindingSite_isSetBindingStatus (const OutwardBindingSite_t *obs)
	Predicate returning `1` (true) if this OutwardBindingSite_t's "bindingStatus" attribute is set. More...

int	OutwardBindingSite_isSetComponent (const OutwardBindingSite_t *obs)
	Predicate returning `1` (true) if this OutwardBindingSite_t's "component" attribute is set. More...

int	OutwardBindingSite_isSetId (const OutwardBindingSite_t *obs)
	Predicate returning `1` (true) if this OutwardBindingSite_t's "id" attribute is set. More...

int	OutwardBindingSite_isSetName (const OutwardBindingSite_t *obs)
	Predicate returning `1` (true) if this OutwardBindingSite_t's "name" attribute is set. More...

int	OutwardBindingSite_isValidBindingStatus (BindingStatus_t bindigStatus)

int	OutwardBindingSite_isValidBindingStatusString (const char *s)

int	OutwardBindingSite_setBindingStatus (OutwardBindingSite_t *obs, BindingStatus_t bindingStatus)
	Sets the value of the "bindingStatus" attribute of this OutwardBindingSite_t. More...

int	OutwardBindingSite_setBindingStatusAsString (OutwardBindingSite_t obs, const char bindingStatus)
	Sets the value of the "bindingStatus" attribute of this OutwardBindingSite_t. More...

int	OutwardBindingSite_setComponent (OutwardBindingSite_t obs, const char component)
	Sets the value of the "component" attribute of this OutwardBindingSite_t. More...

int	OutwardBindingSite_setId (OutwardBindingSite_t obs, const char id)
	Sets the value of the "id" attribute of this OutwardBindingSite_t. More...

int	OutwardBindingSite_setName (OutwardBindingSite_t obs, const char name)
	Sets the value of the "name" attribute of this OutwardBindingSite_t. More...

int	OutwardBindingSite_unsetBindingStatus (OutwardBindingSite_t *obs)
	Unsets the value of the "bindingStatus" attribute of this OutwardBindingSite_t. More...

int	OutwardBindingSite_unsetComponent (OutwardBindingSite_t *obs)
	Unsets the value of the "component" attribute of this OutwardBindingSite_t. More...

int	OutwardBindingSite_unsetId (OutwardBindingSite_t *obs)
	Unsets the value of the "id" attribute of this OutwardBindingSite_t. More...

int	OutwardBindingSite_unsetName (OutwardBindingSite_t *obs)
	Unsets the value of the "name" attribute of this OutwardBindingSite_t. More...

Member Function Documentation

OutwardBindingSite_t * OutwardBindingSite_clone ( OutwardBindingSite_t * obs )

Creates and returns a deep copy of this OutwardBindingSite_t object.

Parameters

obs	the OutwardBindingSite_t structure.

Returns: a (deep) copy of this OutwardBindingSite_t object.

Warning: The pointer that is returned by this function is owned by the caller, who is responsible for deleting it. Any changes made to the element will not be reflected in any resulting SBML document unless the element is added to an SBML Document. Even in this case, the element's deletion is still the responsibility of the caller with two exceptions: if it is used as the "disownedItem" in the ListOf_appendAndOwn() or ListOf_insertAndOwn() functions. All other functions in libsbml add a copy of the element, and do not transfer ownership of the pointer.

OutwardBindingSite_t * OutwardBindingSite_create	(	unsigned int	level,
		unsigned int	version,
		unsigned int	pkgVersion
	)

Creates a new OutwardBindingSite_t using the given SBML Level, Version and “multi” package version.

Parameters

level	an unsigned int, the SBML Level to assign to this OutwardBindingSite_t.
version	an unsigned int, the SBML Version to assign to this OutwardBindingSite_t.
pkgVersion	an unsigned int, the SBML Multi Version to assign to this OutwardBindingSite_t.

Note: Attempting to add an object to an SBMLDocument_t having a different combination of SBML Level, Version and XML namespaces than the object itself will result in an error at the time a caller attempts to make the addition. A parent object must have compatible Level, Version and XML namespaces. (Strictly speaking, a parent may also have more XML namespaces than a child, but the reverse is not permitted.) The restriction is necessary to ensure that an SBML model has a consistent overall structure. This requires callers to manage their objects carefully, but the benefit is increased flexibility in how models can be created by permitting callers to create objects bottom-up if desired. In situations where objects are not yet attached to parents (e.g., SBMLDocument_t), knowledge of the intented SBML Level and Version help libSBML determine such things as whether it is valid to assign a particular value to an attribute. For packages, this means that the parent object to which this package element is being added must have been created with the package namespace, or that the package namespace was added to it, even if that parent is not a package object itself.

Warning: The pointer that is returned by this function is owned by the caller, who is responsible for deleting it. Any changes made to the element will not be reflected in any resulting SBML document unless the element is added to an SBML Document. Even in this case, the element's deletion is still the responsibility of the caller with two exceptions: if it is used as the "disownedItem" in the ListOf_appendAndOwn() or ListOf_insertAndOwn() functions. All other functions in libsbml add a copy of the element, and do not transfer ownership of the pointer.

void OutwardBindingSite_free ( OutwardBindingSite_t * obs )

Frees this OutwardBindingSite_t object.

Parameters

obs	the OutwardBindingSite_t structure.

BindingStatus_t OutwardBindingSite_getBindingStatus ( const OutwardBindingSite_t * obs )

Returns the value of the "bindingStatus" attribute of this OutwardBindingSite_t.

Parameters

obs	the OutwardBindingSite_t structure whose bindingStatus is sought.

Returns: the value of the "bindingStatus" attribute of this OutwardBindingSite_t as a BindingStatus_t.

: The attribute "bindingStatus" on a OutwardBindingSite_t object is used to describe the status of the binding site.

In the SBML Level 3 Version 1 Multi specification, the following are the allowable values for "bindingStatus":

"bound", the binding site is bound.
"unbound", the binding site is not bound.
"either", the binding site may either be bound or unbound.

The value is drawn from the enumeration BindingStatus_t The possible values returned by this method are:

const char * OutwardBindingSite_getBindingStatusAsString ( const OutwardBindingSite_t * obs )

Returns the value of the "bindingStatus" attribute of this OutwardBindingSite_t.

Parameters

obs	the OutwardBindingSite_t structure whose bindingStatus is sought.

Returns: the value of the "bindingStatus" attribute of this OutwardBindingSite_t as a const char *.

Note: The string returned by this function is a pointer to a string literal defined in the libSBML library, and may not be modified or deleted.

: The attribute "bindingStatus" on a OutwardBindingSite_t object is used to describe the status of the binding site.

In the SBML Level 3 Version 1 Multi specification, the following are the allowable values for "bindingStatus":

"bound", the binding site is bound.
"unbound", the binding site is not bound.
"either", the binding site may either be bound or unbound.

The possible values returned by this method are:

"bound"
"unbound"
"either"
NULL

char * OutwardBindingSite_getComponent ( const OutwardBindingSite_t * obs )

Returns the value of the "component" attribute of this OutwardBindingSite_t.

Parameters

obs	the OutwardBindingSite_t structure whose component is sought.

Returns: the value of the "component" attribute of this OutwardBindingSite_t as a pointer to a string.

Warning: The string returned by this function is owned by the caller, who is responsible for deleting it. Any changes made to the string will not be reflected in any resulting SBML document unless the string is added to an SBML Document. Even in this case, the string should be deleted, as adding a string to an SBML Document adds a copy of the string, and does not transfer ownership of that string.

char * OutwardBindingSite_getId ( const OutwardBindingSite_t * obs )

Returns the value of the "id" attribute of this OutwardBindingSite_t.

Parameters

obs	the OutwardBindingSite_t structure whose id is sought.

Returns: the value of the "id" attribute of this OutwardBindingSite_t as a pointer to a string.

Warning: The string returned by this function is owned by the caller, who is responsible for deleting it. Any changes made to the string will not be reflected in any resulting SBML document unless the string is added to an SBML Document. Even in this case, the string should be deleted, as adding a string to an SBML Document adds a copy of the string, and does not transfer ownership of that string.

char * OutwardBindingSite_getName ( const OutwardBindingSite_t * obs )

Returns the value of the "name" attribute of this OutwardBindingSite_t.

Parameters

obs	the OutwardBindingSite_t structure whose name is sought.

Returns: the value of the "name" attribute of this OutwardBindingSite_t as a pointer to a string.

Warning: The string returned by this function is owned by the caller, who is responsible for deleting it. Any changes made to the string will not be reflected in any resulting SBML document unless the string is added to an SBML Document. Even in this case, the string should be deleted, as adding a string to an SBML Document adds a copy of the string, and does not transfer ownership of that string.

int OutwardBindingSite_hasRequiredAttributes ( OutwardBindingSite_t * obs )

Predicate returning 1 (true) if all the required attributes for this OutwardBindingSite_t object have been set.

Parameters

obs	the OutwardBindingSite_t structure.

Returns: 1 (true) to indicate that all the required attributes of this OutwardBindingSite_t have been set, otherwise 0 (false) is returned.

Note

The required attributes for the OutwardBindingSite_t object are:

"bindingStatus"
"component"

int OutwardBindingSite_isSetBindingStatus ( const OutwardBindingSite_t * obs )

Predicate returning 1 (true) if this OutwardBindingSite_t's "bindingStatus" attribute is set.

Parameters

obs	the OutwardBindingSite_t structure.

Returns: 1 (true) if this OutwardBindingSite_t's "bindingStatus" attribute has been set, otherwise 0 (false) is returned.

: The attribute "bindingStatus" on a OutwardBindingSite_t object is used to describe the status of the binding site.

In the SBML Level 3 Version 1 Multi specification, the following are the allowable values for "bindingStatus":

"bound", the binding site is bound.
"unbound", the binding site is not bound.
"either", the binding site may either be bound or unbound.

int OutwardBindingSite_isSetComponent ( const OutwardBindingSite_t * obs )

Predicate returning 1 (true) if this OutwardBindingSite_t's "component" attribute is set.

Parameters

obs	the OutwardBindingSite_t structure.

Returns: 1 (true) if this OutwardBindingSite_t's "component" attribute has been set, otherwise 0 (false) is returned.

int OutwardBindingSite_isSetId ( const OutwardBindingSite_t * obs )

Predicate returning 1 (true) if this OutwardBindingSite_t's "id" attribute is set.

Parameters

obs	the OutwardBindingSite_t structure.

Returns: 1 (true) if this OutwardBindingSite_t's "id" attribute has been set, otherwise 0 (false) is returned.

int OutwardBindingSite_isSetName ( const OutwardBindingSite_t * obs )

Predicate returning 1 (true) if this OutwardBindingSite_t's "name" attribute is set.

Parameters

obs	the OutwardBindingSite_t structure.

Returns: 1 (true) if this OutwardBindingSite_t's "name" attribute has been set, otherwise 0 (false) is returned.

int OutwardBindingSite_isValidBindingStatus ( BindingStatus_t bindigStatus )

int OutwardBindingSite_isValidBindingStatusString ( const char * s )

int OutwardBindingSite_setBindingStatus	(	OutwardBindingSite_t *	obs,
		BindingStatus_t	bindingStatus
	)

Sets the value of the "bindingStatus" attribute of this OutwardBindingSite_t.

Parameters

obs	the OutwardBindingSite_t structure.
bindingStatus	BindingStatus_t value of the "bindingStatus" attribute 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:

: The attribute "bindingStatus" on a OutwardBindingSite_t object is used to describe the status of the binding site.

In the SBML Level 3 Version 1 Multi specification, the following are the allowable values for "bindingStatus":

"bound", the binding site is bound.
"unbound", the binding site is not bound.
"either", the binding site may either be bound or unbound.

int OutwardBindingSite_setBindingStatusAsString	(	OutwardBindingSite_t *	obs,
		const char *	bindingStatus
	)

Sets the value of the "bindingStatus" attribute of this OutwardBindingSite_t.

Parameters

obs	the OutwardBindingSite_t structure.
bindingStatus	const char * of the "bindingStatus" attribute 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:

: The attribute "bindingStatus" on a OutwardBindingSite_t object is used to describe the status of the binding site.

In the SBML Level 3 Version 1 Multi specification, the following are the allowable values for "bindingStatus":

"bound", the binding site is bound.
"unbound", the binding site is not bound.
"either", the binding site may either be bound or unbound.

int OutwardBindingSite_setComponent	(	OutwardBindingSite_t *	obs,
		const char *	component
	)

Sets the value of the "component" attribute of this OutwardBindingSite_t.

Parameters

obs	the OutwardBindingSite_t structure.
component	const char * value of the "component" attribute 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 OutwardBindingSite_setId	(	OutwardBindingSite_t *	obs,
		const char *	id
	)

Sets the value of the "id" attribute of this OutwardBindingSite_t.

Parameters

obs	the OutwardBindingSite_t structure.
id	const char * value of the "id" attribute 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:

Calling this function with id = NULL or an empty string is equivalent to calling OutwardBindingSite_unsetId().

int OutwardBindingSite_setName	(	OutwardBindingSite_t *	obs,
		const char *	name
	)

Sets the value of the "name" attribute of this OutwardBindingSite_t.

Parameters

obs	the OutwardBindingSite_t structure.
name	const char * value of the "name" attribute 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:

Calling this function with name = NULL or an empty string is equivalent to calling OutwardBindingSite_unsetName().

int OutwardBindingSite_unsetBindingStatus ( OutwardBindingSite_t * obs )

Unsets the value of the "bindingStatus" attribute of this OutwardBindingSite_t.

Parameters

obs	the OutwardBindingSite_t structure.

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:

: The attribute "bindingStatus" on a OutwardBindingSite_t object is used to describe the status of the binding site.

In the SBML Level 3 Version 1 Multi specification, the following are the allowable values for "bindingStatus":

"bound", the binding site is bound.
"unbound", the binding site is not bound.
"either", the binding site may either be bound or unbound.

int OutwardBindingSite_unsetComponent ( OutwardBindingSite_t * obs )

Unsets the value of the "component" attribute of this OutwardBindingSite_t.

Parameters

obs	the OutwardBindingSite_t structure.

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 OutwardBindingSite_unsetId ( OutwardBindingSite_t * obs )

Unsets the value of the "id" attribute of this OutwardBindingSite_t.

Parameters

obs	the OutwardBindingSite_t structure.

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 OutwardBindingSite_unsetName ( OutwardBindingSite_t * obs )

Unsets the value of the "name" attribute of this OutwardBindingSite_t.

Parameters

obs	the OutwardBindingSite_t structure.

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