multi
Defines a particular value for a
SpeciesFeature_t.
The SpeciesFeatureValue_t object is a child of a SpeciesFeature_t, and serves to specify a value for a SpeciesFeature_t to select from the ListOfPossibleSpeciesFeatureValues_t defined in the SpeciesFeatureType_t referenced by the parent SpeciesFeature_t.
Creates and returns a deep copy of this SpeciesFeatureValue_t object.
- Parameters
-
- Returns
- a (deep) copy of this SpeciesFeatureValue_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.
| SpeciesFeatureValue_t * SpeciesFeatureValue_create |
( |
unsigned int |
level, |
|
|
unsigned int |
version, |
|
|
unsigned int |
pkgVersion |
|
) |
| |
Creates a new SpeciesFeatureValue_t using the given SBML Level, Version and “multi” package version.
- Parameters
-
- 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.
Returns the value of the "value" attribute of this SpeciesFeatureValue_t.
- Parameters
-
- Returns
- the value of the "value" attribute of this SpeciesFeatureValue_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.
Predicate returning 1 (true) if all the required attributes for this SpeciesFeatureValue_t object have been set.
- Parameters
-
- Returns
1 (true) to indicate that all the required attributes of this SpeciesFeatureValue_t have been set, otherwise 0 (false) is returned.
- Note
- The required attributes for the SpeciesFeatureValue_t object are:
Predicate returning 1 (true) if this SpeciesFeatureValue_t's "value" attribute is set.
- Parameters
-
- Returns
1 (true) if this SpeciesFeatureValue_t's "value" attribute has been set, otherwise 0 (false) is returned.
Sets the value of the "value" attribute of this SpeciesFeatureValue_t.
- Parameters
-
- 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:
Unsets the value of the "value" attribute of this SpeciesFeatureValue_t.
- Parameters
-
- 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:
