libSBML C++ API
5.11.0
|
The Flux Balance Constraints package extends the SBML Level 3 Version 1 Core Species class with the addition of two attributes: 'charge' and 'chemicalFormula'.
Public Member Functions | |
virtual FbcSpeciesPlugin * | clone () const |
Creates and returns a deep copy of this FbcSpeciesPlugin object. More... | |
FbcSpeciesPlugin (const std::string &uri, const std::string &prefix, FbcPkgNamespaces *fbcns) | |
Constructor. More... | |
FbcSpeciesPlugin (const FbcSpeciesPlugin &orig) | |
Copy constructor. More... | |
virtual List * | getAllElements (ElementFilter *filter=NULL) |
Returns all child objects of this object. More... | |
virtual int | getCharge () const |
Returns the value of the "charge" attribute of this FbcSpeciesPlugin. More... | |
virtual const std::string & | getChemicalFormula () const |
Returns the value of the "chemicalFormula" attribute of this FbcSpeciesPlugin. More... | |
virtual SBase * | getElementByMetaId (const std::string &metaid) |
Return the first child object found with a given meta identifier. More... | |
virtual SBase * | getElementBySId (const std::string &id) |
Return the first child object found with a given identifier. More... | |
const std::string & | getElementNamespace () const |
Returns the namespace URI of the package to which this plugin object belongs. More... | |
unsigned int | getLevel () const |
Returns the SBML Level of the package extension of this plugin object. More... | |
const std::string & | getPackageName () const |
Returns the short-form name of the package to which this plugin object belongs. More... | |
unsigned int | getPackageVersion () const |
Returns the package version of the package extension of this plugin object. More... | |
SBase * | getParentSBMLObject () |
Returns the parent object to which this plugin object is connected. More... | |
const SBase * | getParentSBMLObject () const |
Returns the parent object to which this plugin object is connected. More... | |
const std::string & | getPrefix () const |
Returns the XML namespace prefix of the package to which this plugin object belongs. More... | |
SBMLDocument * | getSBMLDocument () |
Returns the SBMLDocument object containing this object instance. More... | |
const SBMLDocument * | getSBMLDocument () const |
Returns the SBMLDocument object containing this object instance. More... | |
std::string | getURI () const |
Returns the XML namespace URI for the package to which this object belongs. More... | |
unsigned int | getVersion () const |
Returns the Version within the SBML Level of the package extension of this plugin object. More... | |
virtual bool | isSetCharge () const |
Predicate returning true or false depending on whether this FbcSpeciesPlugin "charge" attribute has been set. More... | |
virtual bool | isSetChemicalFormula () const |
Predicate returning true or false depending on whether this FbcSpeciesPlugin "chemicalFormula" attribute has been set. More... | |
FbcSpeciesPlugin & | operator= (const FbcSpeciesPlugin &orig) |
Assignment operator for FbcSpeciesPlugin . More... | |
virtual int | setCharge (int charge) |
Sets the value of the "charge" attribute of this FbcSpeciesPlugin. More... | |
virtual int | setChemicalFormula (const std::string &chemicalFormula) |
Sets the value of the "chemicalFormula" attribute of this FbcSpeciesPlugin. More... | |
int | setElementNamespace (const std::string &uri) |
Sets the XML namespace to which this object belongs. More... | |
virtual int | unsetCharge () |
Unsets the value of the "charge" attribute of this FbcSpeciesPlugin. More... | |
virtual int | unsetChemicalFormula () |
Unsets the value of the "chemicalFormula" attribute of this FbcSpeciesPlugin. More... | |
virtual | ~FbcSpeciesPlugin () |
Destroy this object. More... | |
FbcSpeciesPlugin::FbcSpeciesPlugin | ( | const std::string & | uri, |
const std::string & | prefix, | ||
FbcPkgNamespaces * | fbcns | ||
) |
Constructor.
FbcSpeciesPlugin::FbcSpeciesPlugin | ( | const FbcSpeciesPlugin & | orig | ) |
Copy constructor.
Creates a copy of this FbcSpeciesPlugin object.
|
virtual |
Destroy this object.
|
virtual |
Creates and returns a deep copy of this FbcSpeciesPlugin object.
Implements SBasePlugin.
|
virtualinherited |
Returns all child objects of this object.
This returns a List object containing all child SBase objects of this one, at any nesting depth. Optionally, callers can supply a filter that will establish the search criteria for matching objects.
filter | an ElementFilter to use for determining the properties of the objects to be returned. |
Reimplemented in LayoutModelPlugin, FbcModelPlugin, CompModelPlugin, CompSBasePlugin, CompSBMLDocumentPlugin, and QualModelPlugin.
|
virtual |
Returns the value of the "charge" attribute of this FbcSpeciesPlugin.
|
virtual |
Returns the value of the "chemicalFormula" attribute of this FbcSpeciesPlugin.
|
virtualinherited |
Return the first child object found with a given meta identifier.
This method searches all the subobjects under this one, compares their meta identifiers to metaid
, and returns the first one that machines.
metaid | string, the metaid of the object to find. |
metaid
. Reimplemented in FbcModelPlugin, CompModelPlugin, CompSBasePlugin, and CompSBMLDocumentPlugin.
|
virtualinherited |
Return the first child object found with a given identifier.
This method searches all the subobjects under this one, compares their identifiers to id
, and returns the first one that machines. It uses SBasePlugin::getAllElements(ElementFilter* filter) to get the list of identifiers, so the order in which identifiers are searched is the order in which they appear in the results returned by that method.
Normally, SId
type identifier values are unique across a model in SBML. However, in some circumstances they may not be, such as if a model is invalid because of multiple objects having the same identifier.
id | string representing the identifier of the object to find |
id
. Reimplemented in FbcModelPlugin, CompModelPlugin, CompSBasePlugin, and CompSBMLDocumentPlugin.
|
inherited |
Returns the namespace URI of the package to which this plugin object belongs.
|
inherited |
Returns the SBML Level of the package extension of this plugin object.
|
inherited |
Returns the short-form name of the package to which this plugin object belongs.
|
inherited |
Returns the package version of the package extension of this plugin object.
|
inherited |
Returns the parent object to which this plugin object is connected.
|
inherited |
Returns the parent object to which this plugin object is connected.
|
inherited |
Returns the XML namespace prefix of the package to which this plugin object belongs.
|
inherited |
Returns the SBMLDocument object containing this object instance.
This method allows the caller to obtain the SBMLDocument for the current object.
|
inherited |
Returns the SBMLDocument object containing this object instance.
This method allows the caller to obtain the SBMLDocument for the current object.
|
inherited |
Returns the XML namespace URI for the package to which this object belongs.
"http://www.sbml.org/sbml/level3/version1/core"
. Individual SBML Level 3 packages define their own XML namespaces; for example, all elements belonging to the SBML Level 3 Layout Version 1 package must be placed in the XML namespace "http://www.sbml.org/sbml/level3/version1/layout/version1/"
.This method first looks into the SBMLNamespaces object possessed by the parent SBMLDocument object of the current object. If this cannot be found, this method returns the result of getElementNamespace().
|
inherited |
Returns the Version within the SBML Level of the package extension of this plugin object.
|
virtual |
Predicate returning true
or false
depending on whether this FbcSpeciesPlugin "charge" attribute has been set.
true
if this FbcSpeciesPlugin "charge" attribute has been set, otherwise false
is returned.
|
virtual |
Predicate returning true
or false
depending on whether this FbcSpeciesPlugin "chemicalFormula" attribute has been set.
true
if this FbcSpeciesPlugin "chemicalFormula" attribute has been set, otherwise false
is returned. FbcSpeciesPlugin & FbcSpeciesPlugin::operator= | ( | const FbcSpeciesPlugin & | orig | ) |
Assignment operator for FbcSpeciesPlugin .
|
virtual |
Sets the value of the "charge" attribute of this FbcSpeciesPlugin.
|
virtual |
Sets the value of the "chemicalFormula" attribute of this FbcSpeciesPlugin.
The format of chemicalFormula must consist only of atomic names (as in the Periodic Table) or user defined compounds either of which take the form of a single capital letter followed by zero or more lowercase letters. Where there is more than a single atom present, this is indicated with an integer. With regards to order (and enhance inter-operability) it is recommended to use the Hill system order. (However, no error-checking is performed by this routine.)
|
inherited |
Sets the XML namespace to which this object belongs.
"http://www.sbml.org/sbml/level3/version1/core"
. Individual SBML Level 3 packages define their own XML namespaces; for example, all elements belonging to the SBML Level 3 Layout Version 1 package must be placed in the XML namespace "http://www.sbml.org/sbml/level3/version1/layout/version1/"
.uri | the URI to assign to this object. |
|
virtual |
Unsets the value of the "charge" attribute of this FbcSpeciesPlugin.
|
virtual |
Unsets the value of the "chemicalFormula" attribute of this FbcSpeciesPlugin.