libSBML Perl API
libSBML 5.17.2 Perl API
|
{render}
render LibSBML implementation for the extension to the Layout class by the Render extension.The Render package extends the Layout object from the Layout package with the addition of an optional ListOfLocalRenderInformation object.
Public Member Functions | |
void | addLocalRenderInformation (const LocalRenderInformation *pLRI) |
Adds a copy of the given local render information object to the list of local render information objects. More... | |
virtual RenderLayoutPlugin * | clone () const |
Creates and returns a deep copy of this RenderLayoutPlugin object. More... | |
LocalRenderInformation * | createLocalRenderInformation () |
Creates a new local render information object and adds it to the list. 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... | |
unsigned int | getLevel () const |
Returns the SBML Level of the package extension of this plugin object. More... | |
ListOfLocalRenderInformation * | getListOfLocalRenderInformation () |
Returns a pointer to the list object that contains local render information. More... | |
const ListOfLocalRenderInformation * | getListOfLocalRenderInformation () const |
Returns a const pointer to the list object that contains local render information. More... | |
unsigned int | getNumLocalRenderInformationObjects () const |
Returns the number of local render information 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... | |
LocalRenderInformation * | getRenderInformation (unsigned int index) |
Returns a pointer to the local render information object with the given index. More... | |
const LocalRenderInformation * | getRenderInformation (unsigned int index) const |
Returns a const pointer to the local render information object with the given index. More... | |
LocalRenderInformation * | getRenderInformation (const std::string &id) |
Returns a pointer to the local render information object with the given id. More... | |
const LocalRenderInformation * | getRenderInformation (const std::string &id) const |
Returns a const pointer to the local render information object with the given id. 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 |
RenderLayoutPlugin & | operator= (const RenderLayoutPlugin &orig) |
Assignment operator for RenderLayoutPlugin . More... | |
LocalRenderInformation * | removeLocalRenderInformation (unsigned int index) |
Removed the render information with the given index from the list. More... | |
LocalRenderInformation * | removeLocalRenderInformation (const std::string &id) |
Removed the render information with the given id from the list. 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) |
RenderLayoutPlugin (const std::string &uri, const std::string &prefix, RenderPkgNamespaces *groupsns) | |
Constructor. More... | |
RenderLayoutPlugin (const RenderLayoutPlugin &orig) | |
Copy constructor. More... | |
int | setElementNamespace (const std::string &uri) |
Sets the XML namespace to which this object belongs. More... | |
virtual | ~RenderLayoutPlugin () |
Destroy this object. More... | |
RenderLayoutPlugin::RenderLayoutPlugin | ( | const std::string & | uri, |
const std::string & | prefix, | ||
RenderPkgNamespaces * | groupsns | ||
) |
Constructor.
RenderLayoutPlugin::RenderLayoutPlugin | ( | const RenderLayoutPlugin & | orig | ) |
Copy constructor.
Creates a copy of this SBase object.
|
virtual |
Destroy this object.
void RenderLayoutPlugin::addLocalRenderInformation | ( | const LocalRenderInformation * | pLRI | ) |
Adds a copy of the given local render information object to the list of local render information objects.
If an object with the same id exists, it is replaced.
|
virtual |
Creates and returns a deep copy of this RenderLayoutPlugin object.
Reimplemented from SBasePlugin.
LocalRenderInformation * RenderLayoutPlugin::createLocalRenderInformation | ( | ) |
Creates a new local render information object and adds it to the list.
The created object does not have a id and it is the responsibility of the calling code to ensure that it gets one. For constraints on the id, please consult the render information document.
|
virtual |
Returns a List of all child SBase objects, including those nested to an arbitrary depth.
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.
|
inherited |
Returns the SBML Level of the package extension of this plugin object.
ListOfLocalRenderInformation * RenderLayoutPlugin::getListOfLocalRenderInformation | ( | ) |
Returns a pointer to the list object that contains local render information.
const ListOfLocalRenderInformation * RenderLayoutPlugin::getListOfLocalRenderInformation | ( | ) | const |
Returns a const pointer to the list object that contains local render information.
unsigned int RenderLayoutPlugin::getNumLocalRenderInformationObjects | ( | ) | const |
Returns the number of local render information 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.
LocalRenderInformation * RenderLayoutPlugin::getRenderInformation | ( | unsigned int | index | ) |
Returns a pointer to the local render information object with the given index.
If the index is invalid, NULL
is returned.
const LocalRenderInformation * RenderLayoutPlugin::getRenderInformation | ( | unsigned int | index | ) | const |
Returns a const pointer to the local render information object with the given index.
If the index is invalid, NULL
is returned.
LocalRenderInformation * RenderLayoutPlugin::getRenderInformation | ( | const std::string & | id | ) |
Returns a pointer to the local render information object with the given id.
If no object with the given id
exists, NULL
is returned.
const LocalRenderInformation * RenderLayoutPlugin::getRenderInformation | ( | const std::string & | id | ) | const |
Returns a const pointer to the local render information object with the given id.
If no object with the given id
exists, NULL
is returned.
|
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 |
RenderLayoutPlugin & RenderLayoutPlugin::operator= | ( | const RenderLayoutPlugin & | orig | ) |
Assignment operator for RenderLayoutPlugin .
LocalRenderInformation * RenderLayoutPlugin::removeLocalRenderInformation | ( | unsigned int | index | ) |
Removed the render information with the given index from the list.
The removed object is returned. It is the responsibility of the calling code to delete the object. If the index is not valid, NULL
is returned.
LocalRenderInformation * RenderLayoutPlugin::removeLocalRenderInformation | ( | const std::string & | id | ) |
Removed the render information with the given id
from the list.
The removed object is returned. It is the responsibility of the calling code to delete the object. If an object with the given id
does not exist, NULL
is returned.
|
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. |