libSBML Perl API
libSBML 5.10.0 Perl API
|
{layout} Implementation of the 'layout' package extention to the SBMLDocument construct.
The LayoutSBMLDocumentPlugin class inherits from the SBMLDocumentPlugin class, and codifies the extentions to the SBMLDocument class defined in the SBML Level 3 Layout package ('layout').
The LayoutSBMLDocumentPlugin defines a required flag named required
, which indicates whether the 'fbc' constructs can be used to change the core mathematics of the <model>
child of the <sbml>
element. Because they can not, this attribute must be set false
.
Public Member Functions | |
virtual LayoutSBMLDocumentPlugin * | clone () const |
Creates and returns a deep copy of this LayoutSBMLDocumentPlugin object. 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 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... | |
unsigned int | getLevel () const |
Returns the SBML level of the package extension of this plugin object. 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... | |
virtual bool | getRequired () const |
Returns the bool value of "required" attribute of corresponding package in SBMLDocument element. 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... | |
virtual bool | isSetRequired () const |
Predicate returning true or false depending on whether this SBMLDocumentPlugin's "required" attribute has been set. More... | |
LayoutSBMLDocumentPlugin (const std::string &uri, const std::string &prefix, LayoutPkgNamespaces *layoutns) | |
Creates a new LayoutSBMLDocumentPlugin. More... | |
LayoutSBMLDocumentPlugin (const LayoutSBMLDocumentPlugin &orig) | |
Copy constructor for LayoutSBMLDocumentPlugin. More... | |
LayoutSBMLDocumentPlugin & | operator= (const LayoutSBMLDocumentPlugin &rhs) |
Assignment operator for LayoutSBMLDocumentPlugin. More... | |
int | setElementNamespace (const std::string &uri) |
Sets the XML namespace to which this element belongs to. More... | |
virtual int | setRequired (bool value) |
Sets the bool value of "required" attribute of corresponding package in SBMLDocument element. More... | |
virtual int | unsetRequired () |
Unsets the value of the "required" attribute of this SBMLDocumentPlugin. More... | |
virtual | ~LayoutSBMLDocumentPlugin () |
Destructor for LayoutSBMLDocumentPlugin. More... | |
LayoutSBMLDocumentPlugin::LayoutSBMLDocumentPlugin | ( | const std::string & | uri, |
const std::string & | prefix, | ||
LayoutPkgNamespaces * | layoutns | ||
) |
Creates a new LayoutSBMLDocumentPlugin.
LayoutSBMLDocumentPlugin::LayoutSBMLDocumentPlugin | ( | const LayoutSBMLDocumentPlugin & | orig | ) |
Copy constructor for LayoutSBMLDocumentPlugin.
orig; | the LayoutSBMLDocumentPlugin instance to copy. |
|
virtual |
Destructor for LayoutSBMLDocumentPlugin.
|
virtual |
Creates and returns a deep copy of this LayoutSBMLDocumentPlugin object.
Reimplemented from SBMLDocumentPlugin.
|
virtualinherited |
Returns a List of all child SBase objects, including those nested to an arbitrary depth.
Reimplemented in LayoutModelPlugin, FbcModelPlugin, CompModelPlugin, CompSBasePlugin, CompSBMLDocumentPlugin, and QualModelPlugin.
|
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.
|
inherited |
Returns the SBML level of the package extension of this plugin object.
|
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.
|
virtualinherited |
Returns the bool value of "required" attribute of corresponding package in SBMLDocument element.
(EXTENSION) Additional public functions
|
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.
|
virtualinherited |
Predicate returning true
or false
depending on whether this SBMLDocumentPlugin's "required" attribute has been set.
true
if the "required" attribute of this SBMLDocument has been set, false
otherwise. LayoutSBMLDocumentPlugin & LayoutSBMLDocumentPlugin::operator= | ( | const LayoutSBMLDocumentPlugin & | rhs | ) |
Assignment operator for LayoutSBMLDocumentPlugin.
rhs; | the object whose values are used as the basis of the assignment |
|
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/"
|
virtualinherited |
Sets the bool value of "required" attribute of corresponding package in SBMLDocument element.
value | the bool value of "required" attribute of corresponding package in SBMLDocument element. |
Reimplemented in CompSBMLDocumentPlugin.
|
virtualinherited |
Unsets the value of the "required" attribute of this SBMLDocumentPlugin.