libSBML Perl API
libSBML 5.17.2 Perl API
|
{multi}
multi Extension of SimpleSpeciesReference for the "multi" package.The MultiSpeciesPlugin class extends the SimpleSpeciesReference class with a new optional attribute "compartmentReference", of type SIdRef, that points to a CompartmentReference. The compartmentReference attribute can serve to indicate in which subcompartment the SpeciesReference or ModifierSpeciesReference (which inherit from SimpleSpeciesReference) is located.
Public Member Functions | |
virtual MultiSimpleSpeciesReferencePlugin * | clone () const |
Creates and returns a deep copy of this MultiSimpleSpeciesReferencePlugin object. More... | |
virtual List * | getAllElements (ElementFilter *filter=NULL) |
Returns a List of all child SBase objects, including those nested to an arbitary depth. More... | |
virtual const std::string & | getCompartmentReference () const |
Returns the value of the "compartmentReference" attribute of this SimpleSpeciesReference. 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 | hasRequiredElements () const |
Returns true if this object has all the required elements. More... | |
virtual bool | isSetCompartmentReference () const |
Returns true if this SimpleSpeciesReference's "compartmentReference" attribute has been set. More... | |
virtual bool | isValidTypeForList (SBase *item) const |
MultiSimpleSpeciesReferencePlugin (const std::string &uri, const std::string &prefix, MultiPkgNamespaces *multins) | |
Creates a new MultiSimpleSpeciesReferencePlugin object. More... | |
MultiSimpleSpeciesReferencePlugin (const MultiSimpleSpeciesReferencePlugin &orig) | |
Copy constructor for MultiSimpleSpeciesReferencePlugin. More... | |
MultiSimpleSpeciesReferencePlugin & | operator= (const MultiSimpleSpeciesReferencePlugin &rhs) |
Assignment operator for MultiSimpleSpeciesReferencePlugin. 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) |
virtual int | setCompartmentReference (const std::string &compartmentReference) |
Sets the value of the "compartmentReference" attribute of this SimpleSpeciesReference. More... | |
int | setElementNamespace (const std::string &uri) |
Sets the XML namespace to which this object belongs. More... | |
virtual int | unsetCompartmentReference () |
Unsets the value of the "compartmentReference" attribute of this SimpleSpeciesReference. More... | |
virtual | ~MultiSimpleSpeciesReferencePlugin () |
Destructor for MultiSimpleSpeciesReferencePlugin. More... | |
MultiSimpleSpeciesReferencePlugin::MultiSimpleSpeciesReferencePlugin | ( | const std::string & | uri, |
const std::string & | prefix, | ||
MultiPkgNamespaces * | multins | ||
) |
Creates a new MultiSimpleSpeciesReferencePlugin object.
"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 of the SBML Level 3 package implemented by this libSBML package extension. |
prefix | the XML namespace prefix being used for the package. |
multins | the namespaces object for the package. |
MultiSimpleSpeciesReferencePlugin::MultiSimpleSpeciesReferencePlugin | ( | const MultiSimpleSpeciesReferencePlugin & | orig | ) |
Copy constructor for MultiSimpleSpeciesReferencePlugin.
orig | the MultiSimpleSpeciesReferencePlugin instance to copy. |
|
virtual |
Destructor for MultiSimpleSpeciesReferencePlugin.
|
virtual |
Creates and returns a deep copy of this MultiSimpleSpeciesReferencePlugin object.
Reimplemented from SBasePlugin.
Reimplemented in MultiSpeciesReferencePlugin.
|
virtual |
Returns a List of all child SBase objects, including those nested to an arbitary depth.
filter | a pointer to an ElementFilter, which causes the function to return only elements that match a particular set of constraints. If NULL (the default), the function will return all child objects. |
Reimplemented from SBasePlugin.
Reimplemented in MultiSpeciesReferencePlugin.
|
virtual |
Returns the value of the "compartmentReference" attribute of this SimpleSpeciesReference.
|
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 QualModelPlugin, GroupsModelPlugin, 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.
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 QualModelPlugin, GroupsModelPlugin, 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 |
Returns true
if this object has all the required elements.
true
if this object has all the elements required by the package specification; otherwise, false
will be returned. Reimplemented in MultiSpeciesReferencePlugin.
|
virtual |
Returns true
if this SimpleSpeciesReference's "compartmentReference" attribute has been set.
true
if this SimpleSpeciesReference's "compartmentReference" attribute has been set; otherwise, false
is returned.
|
virtualinherited |
MultiSimpleSpeciesReferencePlugin & MultiSimpleSpeciesReferencePlugin::operator= | ( | const MultiSimpleSpeciesReferencePlugin & | rhs | ) |
Assignment operator for MultiSimpleSpeciesReferencePlugin.
rhs | the object whose values are used as the basis of the assignment |
|
virtualinherited |
|
virtualinherited |
Reimplemented in FbcReactionPlugin.
|
virtualinherited |
|
virtual |
Sets the value of the "compartmentReference" attribute of this SimpleSpeciesReference.
compartmentReference | the new value of the "compartmentReference" attribute. |
|
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 "compartmentReference" attribute of this SimpleSpeciesReference.