libSBML Perl API
libSBML 5.17.2 Perl API
|
Public Member Functions | |
int | addLayout (const Layout *layout) |
Adds a copy of the layout object to the list of layouts. More... | |
virtual LayoutModelPlugin * | clone () const |
Creates and returns a deep copy of this LayoutModelPlugin object. More... | |
Layout * | createLayout () |
Creates a new layout object and adds it to the list of layout objects and returns it. 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) |
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... | |
Layout * | getLayout (unsigned int index) |
Returns the layout object that belongs to the given index. More... | |
const Layout * | getLayout (unsigned int index) const |
Returns the layout object that belongs to the given index. More... | |
Layout * | getLayout (const std::string &sid) |
Returns the layout object with the given sid attribute. More... | |
const Layout * | getLayout (const std::string &sid) const |
Returns the layout object with the given sid attribute. More... | |
unsigned int | getLevel () const |
Returns the SBML Level of the package extension of this plugin object. More... | |
const ListOfLayouts * | getListOfLayouts () const |
Returns the ListOfLayouts object for this Model. More... | |
ListOfLayouts * | getListOfLayouts () |
Returns the ListOfLayouts object for this Model. More... | |
int | getNumLayouts () const |
Returns the number of layout objects. 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 |
LayoutModelPlugin (const std::string &uri, const std::string &prefix, LayoutPkgNamespaces *layoutns) | |
Creates a new LayoutModelPlugin object using the given parameters. More... | |
LayoutModelPlugin (const LayoutModelPlugin &orig) | |
Copy constructor. More... | |
LayoutModelPlugin & | operator= (const LayoutModelPlugin &orig) |
Assignment operator for LayoutModelPlugin. More... | |
Layout * | removeLayout (unsigned int n) |
Removes the nth Layout object from this Model object 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 | ~LayoutModelPlugin () |
Destroy this object. More... | |
LayoutModelPlugin::LayoutModelPlugin | ( | const std::string & | uri, |
const std::string & | prefix, | ||
LayoutPkgNamespaces * | layoutns | ||
) |
Creates a new LayoutModelPlugin object using the given parameters.
"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. |
layoutns | the namespaces object for the package. |
LayoutModelPlugin::LayoutModelPlugin | ( | const LayoutModelPlugin & | orig | ) |
|
virtual |
Destroy this object.
int LayoutModelPlugin::addLayout | ( | const Layout * | layout | ) |
Adds a copy of the layout object to the list of layouts.
layout | the layout object to be added. |
|
virtual |
Creates and returns a deep copy of this LayoutModelPlugin object.
Reimplemented from SBasePlugin.
Layout * LayoutModelPlugin::createLayout | ( | ) |
Creates a new layout object and adds it to the list of layout objects and returns it.
|
virtual |
Returns a List of all child SBase objects, including those nested to an arbitrary 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.
|
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.
Layout * LayoutModelPlugin::getLayout | ( | unsigned int | index | ) |
Returns the layout object that belongs to the given index.
If the index is invalid, NULL
is returned.
index | the index of list of layout objects. |
const Layout * LayoutModelPlugin::getLayout | ( | unsigned int | index | ) | const |
Returns the layout object that belongs to the given index.
If the index is invalid, NULL
is returned.
index | the index of list of layout objects. |
Layout * LayoutModelPlugin::getLayout | ( | const std::string & | sid | ) |
Returns the layout object with the given sid
attribute.
If the id is invalid, NULL
is returned.
sid | the id attribute of the layout object. |
sid
attribute. NULL is returned if the given sid
is invalid. const Layout * LayoutModelPlugin::getLayout | ( | const std::string & | sid | ) | const |
Returns the layout object with the given sid
attribute.
If the id is invalid, NULL
is returned.
sid | the id attribute of the layout object. |
sid
attribute. NULL is returned if the given sid
is invalid.
|
inherited |
Returns the SBML Level of the package extension of this plugin object.
const ListOfLayouts * LayoutModelPlugin::getListOfLayouts | ( | ) | const |
Returns the ListOfLayouts object for this Model.
ListOfLayouts * LayoutModelPlugin::getListOfLayouts | ( | ) |
Returns the ListOfLayouts object for this Model.
int LayoutModelPlugin::getNumLayouts | ( | ) | const |
Returns the number of layout objects.
|
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 |
LayoutModelPlugin & LayoutModelPlugin::operator= | ( | const LayoutModelPlugin & | orig | ) |
Assignment operator for LayoutModelPlugin.
orig | the object whose values are used as the basis of the assignment. |
Layout * LayoutModelPlugin::removeLayout | ( | unsigned int | n | ) |
Removes the nth Layout object from this Model object and returns a pointer to it.
The caller owns the returned object and is responsible for deleting it.
n | the index of the Layout object to remove. |
NULL
is returned if the given index is out of range.
|
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. |