libSBML Perl API
libSBML 5.10.0 Perl API
|
{layout} Implementation of the 'layout' package extention to the Model construct.
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) |
------------------------------------------------------------------ More... | |
virtual SBase * | getElementByMetaId (const std::string &metaid) |
Returns the first child element it can find with the given metaid , or NULL if no such object is found. More... | |
virtual SBase * | getElementBySId (const std::string &id) |
Returns the first child element found 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 XML namespace (URI) of the package extension of this plugin object. 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 package name of this plugin object. More... | |
unsigned int | getPackageVersion () const |
Returns the package version of the package extension of this plugin object. More... | |
SBase * | getParentSBMLObject () |
Returns the parent SBase object to which this plugin object connected. More... | |
const SBase * | getParentSBMLObject () const |
Returns the parent SBase object to which this plugin object connected. More... | |
const std::string & | getPrefix () const |
Returns the prefix of the package extension of this plugin object. More... | |
SBMLDocument * | getSBMLDocument () |
Returns the parent SBMLDocument of this plugin object. More... | |
const SBMLDocument * | getSBMLDocument () const |
Returns the parent SBMLDocument of this plugin object. More... | |
std::string | getURI () const |
Gets the URI to which this element belongs to. More... | |
unsigned int | getVersion () const |
Returns the SBML version of the package extension of this plugin object. More... | |
LayoutModelPlugin (const std::string &uri, const std::string &prefix, LayoutPkgNamespaces *layoutns) | |
Constructor. 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... | |
int | setElementNamespace (const std::string &uri) |
Sets the XML namespace to which this element belongs to. More... | |
virtual | ~LayoutModelPlugin () |
Destroy this object. More... | |
LayoutModelPlugin::LayoutModelPlugin | ( | const std::string & | uri, |
const std::string & | prefix, | ||
LayoutPkgNamespaces * | layoutns | ||
) |
Constructor.
LayoutModelPlugin::LayoutModelPlugin | ( | const LayoutModelPlugin & | orig | ) |
Copy constructor.
Creates a copy of this SBase object.
|
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.
Implements SBasePlugin.
Layout * LayoutModelPlugin::createLayout | ( | ) |
Creates a new layout object and adds it to the list of layout objects and returns it.
|
virtual |
------------------------------------------------------------------
Additional public functions
------------------------------------------------------------------ Returns a List of all child SBase objects, including those nested to an arbitrary depth
Reimplemented from SBasePlugin.
|
virtualinherited |
Returns the first child element it can find with the given metaid
, or NULL
if no such object is found.
metaid | string representing the metaid of objects to find |
metaid
. Reimplemented in FbcModelPlugin, CompModelPlugin, CompSBasePlugin, and CompSBMLDocumentPlugin.
|
virtualinherited |
Returns the first child element found that has the given id
in the model-wide SId namespace, or NULL
if no such object is found.
id | string representing the id of objects to find |
id
. Reimplemented in FbcModelPlugin, CompModelPlugin, CompSBasePlugin, and CompSBMLDocumentPlugin.
|
inherited |
Returns the XML namespace (URI) of the package extension of this plugin object.
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 package name of this plugin object.
|
inherited |
Returns the package version of the package extension of this plugin object.
|
inherited |
|
inherited |
|
inherited |
Returns the prefix of the package extension of this plugin object.
|
inherited |
Returns the parent SBMLDocument of this plugin object.
|
inherited |
Returns the parent SBMLDocument of this plugin object.
|
inherited |
Gets the URI to which this element belongs to.
For example, all elements that belong to SBML Level 3 Version 1 Core must would have the URI "http://www.sbml.org/sbml/level3/version1/core"; all elements that belong to Layout Extension Version 1 for SBML Level 3 Version 1 Core must would have the URI "http://www.sbml.org/sbml/level3/version1/layout/version1/"
Unlike getElementNamespace, this function first returns the URI for this element by looking into the SBMLNamespaces object of the document with the its package name. if not found it will return the result of getElementNamespace
|
inherited |
Returns the SBML version of the package extension of this plugin object.
LayoutModelPlugin & LayoutModelPlugin::operator= | ( | const LayoutModelPlugin & | orig | ) |
Assignment operator for LayoutModelPlugin.
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.
|
inherited |
Sets the XML namespace to which this element belongs to.
For example, all elements that belong to SBML Level 3 Version 1 Core must set the namespace to "http://www.sbml.org/sbml/level3/version1/core"; all elements that belong to Layout Extension Version 1 for SBML Level 3 Version 1 Core must set the namespace to "http://www.sbml.org/sbml/level3/version1/layout/version1/"