libSBML Perl API
libSBML 5.17.2 Perl API
|
{render}
render The Render extension of the layout GraphicalObject class.The Render package extends the GraphicalObject object from the Layout package with the addition of the objectRole attribute, which specifies with which Style the object should be rendered.
Public Member Functions | |
virtual RenderGraphicalObjectPlugin * | clone () const |
Creates and returns a deep copy of this RenderGraphicalObjectPlugin object. More... | |
virtual List * | getAllElements (ElementFilter *filter=NULL) |
Returns all child objects of this object. 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 & | getObjectRole () const |
Returns the object role string for the 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... | |
bool | isSetObjectRole () const |
Returns whether the object role has been set or not. More... | |
virtual bool | isValidTypeForList (SBase *item) const |
RenderGraphicalObjectPlugin & | operator= (const RenderGraphicalObjectPlugin &orig) |
Assignment operator for RenderGraphicalObjectPlugin . 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) |
RenderGraphicalObjectPlugin (const std::string &uri, const std::string &prefix, RenderPkgNamespaces *groupsns) | |
Constructor. More... | |
RenderGraphicalObjectPlugin (const RenderGraphicalObjectPlugin &orig) | |
Copy constructor. More... | |
int | setElementNamespace (const std::string &uri) |
Sets the XML namespace to which this object belongs. More... | |
void | setObjectRole (const std::string &role) |
Sets the object role string for the object. More... | |
virtual | ~RenderGraphicalObjectPlugin () |
Destroy this object. More... | |
RenderGraphicalObjectPlugin::RenderGraphicalObjectPlugin | ( | const std::string & | uri, |
const std::string & | prefix, | ||
RenderPkgNamespaces * | groupsns | ||
) |
Constructor.
RenderGraphicalObjectPlugin::RenderGraphicalObjectPlugin | ( | const RenderGraphicalObjectPlugin & | orig | ) |
Copy constructor.
Creates a copy of this SBase object.
|
virtual |
Destroy this object.
|
virtual |
Creates and returns a deep copy of this RenderGraphicalObjectPlugin object.
Reimplemented from SBasePlugin.
|
virtualinherited |
Returns all child objects of this object.
This returns a List object containing all child SBase objects of this one, at any nesting depth. Optionally, callers can supply a filter that will establish the search criteria for matching objects.
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 in GroupsModelPlugin, FbcModelPlugin, MultiCompartmentPlugin, MultiSpeciesPlugin, LayoutModelPlugin, MultiSimpleSpeciesReferencePlugin, RenderListOfLayoutsPlugin, FbcReactionPlugin, CompModelPlugin, CompSBasePlugin, CompSBMLDocumentPlugin, RenderLayoutPlugin, MultiSpeciesReferencePlugin, MultiModelPlugin, and QualModelPlugin.
|
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.
const std::string & RenderGraphicalObjectPlugin::getObjectRole | ( | ) | const |
Returns the object role string for the 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.
bool RenderGraphicalObjectPlugin::isSetObjectRole | ( | ) | const |
Returns whether the object role has been set or not.
|
virtualinherited |
RenderGraphicalObjectPlugin & RenderGraphicalObjectPlugin::operator= | ( | const RenderGraphicalObjectPlugin & | orig | ) |
Assignment operator for RenderGraphicalObjectPlugin .
|
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. |
void RenderGraphicalObjectPlugin::setObjectRole | ( | const std::string & | role | ) |
Sets the object role string for the object.