PossibleSpeciesFeatureValue_t Class Reference

Detailed Description

multi Defines one value of a SpeciesFeature_t.

The PossibleSpeciesFeatureValue_t object is a child of a SpeciesFeatureType_t, and defines one value (though its optional "numericValue" attribute) which the parent SpeciesFeatureType_t can hold.

Public Member Functions
PossibleSpeciesFeatureValue_t *	PossibleSpeciesFeatureValue_clone (PossibleSpeciesFeatureValue_t *psfv)
	Creates and returns a deep copy of this PossibleSpeciesFeatureValue_t object. More...
PossibleSpeciesFeatureValue_t *	PossibleSpeciesFeatureValue_create (unsigned int level, unsigned int version, unsigned int pkgVersion)
	Creates a new PossibleSpeciesFeatureValue_t using the given SBML Level, Version and “multi” package version. More...
void	PossibleSpeciesFeatureValue_free (PossibleSpeciesFeatureValue_t *psfv)
	Frees this PossibleSpeciesFeatureValue_t object. More...
char *	PossibleSpeciesFeatureValue_getId (const PossibleSpeciesFeatureValue_t *psfv)
	Returns the value of the "id" attribute of this PossibleSpeciesFeatureValue_t. More...
char *	PossibleSpeciesFeatureValue_getName (const PossibleSpeciesFeatureValue_t *psfv)
	Returns the value of the "name" attribute of this PossibleSpeciesFeatureValue_t. More...
char *	PossibleSpeciesFeatureValue_getNumericValue (const PossibleSpeciesFeatureValue_t *psfv)
	Returns the value of the "numericValue" attribute of this PossibleSpeciesFeatureValue_t. More...
int	PossibleSpeciesFeatureValue_hasRequiredAttributes (PossibleSpeciesFeatureValue_t *psfv)
	Predicate returning 1 (true) if all the required attributes for this PossibleSpeciesFeatureValue_t object have been set. More...
int	PossibleSpeciesFeatureValue_isSetId (const PossibleSpeciesFeatureValue_t *psfv)
	Predicate returning 1 (true) if this PossibleSpeciesFeatureValue_t's "id" attribute is set. More...
int	PossibleSpeciesFeatureValue_isSetName (const PossibleSpeciesFeatureValue_t *psfv)
	Predicate returning 1 (true) if this PossibleSpeciesFeatureValue_t's "name" attribute is set. More...
int	PossibleSpeciesFeatureValue_isSetNumericValue (const PossibleSpeciesFeatureValue_t *psfv)
	Predicate returning 1 (true) if this PossibleSpeciesFeatureValue_t's "numericValue" attribute is set. More...
int	PossibleSpeciesFeatureValue_setId (PossibleSpeciesFeatureValue_t *psfv, const char *id)
	Sets the value of the "id" attribute of this PossibleSpeciesFeatureValue_t. More...
int	PossibleSpeciesFeatureValue_setName (PossibleSpeciesFeatureValue_t *psfv, const char *name)
	Sets the value of the "name" attribute of this PossibleSpeciesFeatureValue_t. More...
int	PossibleSpeciesFeatureValue_setNumericValue (PossibleSpeciesFeatureValue_t *psfv, const char *numericValue)
	Sets the value of the "numericValue" attribute of this PossibleSpeciesFeatureValue_t. More...
int	PossibleSpeciesFeatureValue_unsetId (PossibleSpeciesFeatureValue_t *psfv)
	Unsets the value of the "id" attribute of this PossibleSpeciesFeatureValue_t. More...
int	PossibleSpeciesFeatureValue_unsetName (PossibleSpeciesFeatureValue_t *psfv)
	Unsets the value of the "name" attribute of this PossibleSpeciesFeatureValue_t. More...
int	PossibleSpeciesFeatureValue_unsetNumericValue (PossibleSpeciesFeatureValue_t *psfv)
	Unsets the value of the "numericValue" attribute of this PossibleSpeciesFeatureValue_t. More...

Member Function Documentation

PossibleSpeciesFeatureValue_t * PossibleSpeciesFeatureValue_clone

(

PossibleSpeciesFeatureValue_t *

psfv

)

Creates and returns a deep copy of this PossibleSpeciesFeatureValue_t object.

Parameters

psfv	the PossibleSpeciesFeatureValue_t structure.

Returns

a (deep) copy of this PossibleSpeciesFeatureValue_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.

PossibleSpeciesFeatureValue_t * PossibleSpeciesFeatureValue_create	(	unsigned int	level,
		unsigned int	version,
		unsigned int	pkgVersion
	)

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

Parameters

level	an unsigned int, the SBML Level to assign to this PossibleSpeciesFeatureValue_t.
version	an unsigned int, the SBML Version to assign to this PossibleSpeciesFeatureValue_t.
pkgVersion	an unsigned int, the SBML Multi Version to assign to this PossibleSpeciesFeatureValue_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 PossibleSpeciesFeatureValue_free

(

PossibleSpeciesFeatureValue_t *

psfv

)

Frees this PossibleSpeciesFeatureValue_t object.

Parameters

psfv	the PossibleSpeciesFeatureValue_t structure.

char * PossibleSpeciesFeatureValue_getId

(

const PossibleSpeciesFeatureValue_t *

psfv

)

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

Parameters

psfv	the PossibleSpeciesFeatureValue_t structure whose id is sought.

Returns

the value of the "id" attribute of this PossibleSpeciesFeatureValue_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 * PossibleSpeciesFeatureValue_getName

(

const PossibleSpeciesFeatureValue_t *

psfv

)

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

Parameters

psfv	the PossibleSpeciesFeatureValue_t structure whose name is sought.

Returns

the value of the "name" attribute of this PossibleSpeciesFeatureValue_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 * PossibleSpeciesFeatureValue_getNumericValue

(

const PossibleSpeciesFeatureValue_t *

psfv

)

Returns the value of the "numericValue" attribute of this PossibleSpeciesFeatureValue_t.

Parameters

psfv	the PossibleSpeciesFeatureValue_t structure whose numericValue is sought.

Returns

the value of the "numericValue" attribute of this PossibleSpeciesFeatureValue_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 PossibleSpeciesFeatureValue_hasRequiredAttributes

(

PossibleSpeciesFeatureValue_t *

psfv

)

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

Parameters

psfv	the PossibleSpeciesFeatureValue_t structure.

Returns

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

Note

The required attributes for the PossibleSpeciesFeatureValue_t object are:

• "id"

int PossibleSpeciesFeatureValue_isSetId

(

const PossibleSpeciesFeatureValue_t *

psfv

)

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

Parameters

psfv	the PossibleSpeciesFeatureValue_t structure.

Returns

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

int PossibleSpeciesFeatureValue_isSetName

(

const PossibleSpeciesFeatureValue_t *

psfv

)

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

Parameters

psfv	the PossibleSpeciesFeatureValue_t structure.

Returns

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

int PossibleSpeciesFeatureValue_isSetNumericValue

(

const PossibleSpeciesFeatureValue_t *

psfv

)

Predicate returning 1 (true) if this PossibleSpeciesFeatureValue_t's "numericValue" attribute is set.

Parameters

psfv	the PossibleSpeciesFeatureValue_t structure.

Returns

1 (true) if this PossibleSpeciesFeatureValue_t's "numericValue" attribute has been set, otherwise 0 (false) is returned.

int PossibleSpeciesFeatureValue_setId	(	PossibleSpeciesFeatureValue_t *	psfv,
		const char *	id
	)

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

Parameters

psfv	the PossibleSpeciesFeatureValue_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:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE
• LIBSBML_INVALID_OBJECT

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

int PossibleSpeciesFeatureValue_setName	(	PossibleSpeciesFeatureValue_t *	psfv,
		const char *	name
	)

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

Parameters

psfv	the PossibleSpeciesFeatureValue_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:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_OBJECT

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

int PossibleSpeciesFeatureValue_setNumericValue	(	PossibleSpeciesFeatureValue_t *	psfv,
		const char *	numericValue
	)

Sets the value of the "numericValue" attribute of this PossibleSpeciesFeatureValue_t.

Parameters

psfv	the PossibleSpeciesFeatureValue_t structure.
numericValue	const char * value of the "numericValue" 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:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE
• LIBSBML_INVALID_OBJECT

int PossibleSpeciesFeatureValue_unsetId

(

PossibleSpeciesFeatureValue_t *

psfv

)

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

Parameters

psfv	the PossibleSpeciesFeatureValue_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:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_OPERATION_FAILED
• LIBSBML_INVALID_OBJECT

int PossibleSpeciesFeatureValue_unsetName

(

PossibleSpeciesFeatureValue_t *

psfv

)

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

Parameters

psfv	the PossibleSpeciesFeatureValue_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:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_OPERATION_FAILED
• LIBSBML_INVALID_OBJECT

int PossibleSpeciesFeatureValue_unsetNumericValue

(

PossibleSpeciesFeatureValue_t *

psfv

)

Unsets the value of the "numericValue" attribute of this PossibleSpeciesFeatureValue_t.

Parameters

psfv	the PossibleSpeciesFeatureValue_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:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_OPERATION_FAILED
• LIBSBML_INVALID_OBJECT