libSBML Perl API
libSBML 5.19.7 Perl API
|
Public Member Functions | |
int | addKeyValuePair (const KeyValuePair *kvp) |
Adds a copy of the given KeyValuePair to this FbcSBasePlugin. More... | |
virtual FbcSBasePlugin * | clone () const |
Creates and returns a deep copy of this FbcSBasePlugin object. More... | |
KeyValuePair * | createKeyValuePair () |
Creates a new KeyValuePair object, adds it to this FbcSBasePlugin object and returns the KeyValuePair object created. More... | |
FbcSBasePlugin (const FbcSBasePlugin &orig) | |
Copy constructor for FbcSBasePlugin. More... | |
FbcSBasePlugin (const std::string &uri, const std::string &prefix, FbcPkgNamespaces *fbcns) | |
Creates a new FbcSBasePlugin using the given URI, prefix and package namespace. More... | |
virtual List * | getAllElements (ElementFilter *filter=NULL) |
Returns a List of all child SBase objects, including those nested to an arbitrary depth. More... | |
virtual SBase * | getElementByMetaId (const std::string &metaid) |
Returns the first child element that has the given metaid , or NULL if no such object is found. More... | |
virtual SBase * | getElementBySId (const std::string &id) |
Returns the first child element that has the given id in the model-wide SId namespace, or NULL if no such object is found. More... | |
const std::string & | getElementNamespace () const |
Returns the namespace URI of the package to which this plugin object belongs. More... | |
KeyValuePair * | getKeyValuePair (const std::string &sid) |
Get a KeyValuePair from the FbcSBasePlugin based on its identifier. More... | |
const KeyValuePair * | getKeyValuePair (const std::string &sid) const |
Get a KeyValuePair from the FbcSBasePlugin based on its identifier. More... | |
KeyValuePair * | getKeyValuePair (unsigned int n) |
Get a KeyValuePair from the FbcSBasePlugin. More... | |
const KeyValuePair * | getKeyValuePair (unsigned int n) const |
Get a KeyValuePair from the FbcSBasePlugin. More... | |
unsigned int | getLevel () const |
Returns the SBML Level of the package extension of this plugin object. More... | |
ListOfKeyValuePairs * | getListOfKeyValuePairs () |
Returns the ListOfKeyValuePairs from this FbcSBasePlugin. More... | |
const ListOfKeyValuePairs * | getListOfKeyValuePairs () const |
Returns the ListOfKeyValuePairs from this FbcSBasePlugin. More... | |
unsigned int | getNumKeyValuePairs () const |
Get the number of KeyValuePair objects in this FbcSBasePlugin. 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 | isValidTypeForList (SBase *item) const |
FbcSBasePlugin & | operator= (const FbcSBasePlugin &rhs) |
Assignment operator for FbcSBasePlugin. More... | |
KeyValuePair * | removeKeyValuePair (const std::string &sid) |
Removes the KeyValuePair from this FbcSBasePlugin based on its identifier and returns a pointer to it. More... | |
KeyValuePair * | removeKeyValuePair (unsigned int n) |
Removes the nth KeyValuePair from this FbcSBasePlugin and returns a pointer to it. More... | |
virtual void | renameMetaIdRefs (const std::string &oldid, const std::string &newid) |
virtual void | renameSIdRefs (const std::string &oldid, const std::string &newid) |
virtual void | renameUnitSIdRefs (const std::string &oldid, const std::string &newid) |
int | setElementNamespace (const std::string &uri) |
Sets the XML namespace to which this object belongs. More... | |
virtual | ~FbcSBasePlugin () |
Destructor for FbcSBasePlugin. More... | |
FbcSBasePlugin::FbcSBasePlugin | ( | const std::string & | uri, |
const std::string & | prefix, | ||
FbcPkgNamespaces * | fbcns | ||
) |
Creates a new FbcSBasePlugin using the given URI, prefix and package namespace.
uri | a string, representing the URI of the SBML Level 3 package implemented by this libSBML package extension. |
prefix | a string, the XML namespace prefix being used for this package. |
fbcns | a pointer to the namesspaces object (FbcPkgNamespaces) for this package. |
"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/"
.FbcSBasePlugin::FbcSBasePlugin | ( | const FbcSBasePlugin & | orig | ) |
Copy constructor for FbcSBasePlugin.
orig | the FbcSBasePlugin instance to copy. |
|
virtual |
Destructor for FbcSBasePlugin.
int FbcSBasePlugin::addKeyValuePair | ( | const KeyValuePair * | kvp | ) |
Adds a copy of the given KeyValuePair to this FbcSBasePlugin.
kvp | the KeyValuePair object to add. |
|
virtual |
Creates and returns a deep copy of this FbcSBasePlugin object.
Reimplemented from SBasePlugin.
Reimplemented in FbcModelPlugin, FbcReactionPlugin, and FbcSpeciesPlugin.
KeyValuePair * FbcSBasePlugin::createKeyValuePair | ( | ) |
Creates a new KeyValuePair object, adds it to this FbcSBasePlugin object and returns the KeyValuePair object created.
|
virtual |
Returns a List of all child SBase objects, including those nested to an arbitrary depth.
filter | an ElementFilter that may impose restrictions on the objects to be retrieved. |
Reimplemented from SBasePlugin.
Reimplemented in FbcModelPlugin, and FbcReactionPlugin.
|
virtual |
Returns the first child element that has the given metaid
, or NULL
if no such object is found.
metaid | a string representing the metaid attribute of the object to retrieve. |
metaid
. If no such object is found this method returns NULL
. Reimplemented from SBasePlugin.
Reimplemented in FbcModelPlugin.
|
virtual |
Returns the first child element that has the given id
in the model-wide SId namespace, or NULL
if no such object is found.
id | a string representing the id attribute of the object to retrieve. |
id
. If no such object is found, this method returns NULL
. Reimplemented from SBasePlugin.
Reimplemented in FbcModelPlugin.
|
inherited |
Returns the namespace URI of the package to which this plugin object belongs.
KeyValuePair * FbcSBasePlugin::getKeyValuePair | ( | const std::string & | sid | ) |
Get a KeyValuePair from the FbcSBasePlugin based on its identifier.
sid | a string representing the identifier of the KeyValuePair to retrieve. |
sid
or NULL
if no such KeyValuePair exists.const KeyValuePair * FbcSBasePlugin::getKeyValuePair | ( | const std::string & | sid | ) | const |
Get a KeyValuePair from the FbcSBasePlugin based on its identifier.
sid | a string representing the identifier of the KeyValuePair to retrieve. |
sid
or NULL
if no such KeyValuePair exists.KeyValuePair * FbcSBasePlugin::getKeyValuePair | ( | unsigned int | n | ) |
Get a KeyValuePair from the FbcSBasePlugin.
n | an unsigned int representing the index of the KeyValuePair to retrieve. |
NULL
if no such object exists.const KeyValuePair * FbcSBasePlugin::getKeyValuePair | ( | unsigned int | n | ) | const |
Get a KeyValuePair from the FbcSBasePlugin.
n | an unsigned int representing the index of the KeyValuePair to retrieve. |
NULL
if no such object exists.
|
inherited |
Returns the SBML Level of the package extension of this plugin object.
ListOfKeyValuePairs * FbcSBasePlugin::getListOfKeyValuePairs | ( | ) |
Returns the ListOfKeyValuePairs from this FbcSBasePlugin.
const ListOfKeyValuePairs * FbcSBasePlugin::getListOfKeyValuePairs | ( | ) | const |
Returns the ListOfKeyValuePairs from this FbcSBasePlugin.
unsigned int FbcSBasePlugin::getNumKeyValuePairs | ( | ) | const |
Get the number of KeyValuePair objects in this FbcSBasePlugin.
|
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.
|
virtualinherited |
FbcSBasePlugin & FbcSBasePlugin::operator= | ( | const FbcSBasePlugin & | rhs | ) |
Assignment operator for FbcSBasePlugin.
rhs | the FbcSBasePlugin object whose values are to be used as the basis of the assignment. |
KeyValuePair * FbcSBasePlugin::removeKeyValuePair | ( | const std::string & | sid | ) |
Removes the KeyValuePair from this FbcSBasePlugin based on its identifier and returns a pointer to it.
sid | a string representing the identifier of the KeyValuePair to remove. |
KeyValuePair * FbcSBasePlugin::removeKeyValuePair | ( | unsigned int | n | ) |
Removes the nth KeyValuePair from this FbcSBasePlugin and returns a pointer to it.
n | an unsigned int representing the index of the KeyValuePair to remove. |
|
virtualinherited |
|
virtualinherited |
Reimplemented in FbcReactionPlugin.
|
virtualinherited |
|
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. |