libSBML C++ API  5.18.0
RenderExtension Class Reference
Inheritance diagram for RenderExtension:
[legend]

Detailed Description

render Base extension class for the package.

This class of objects is defined by libSBML only and has no direct equivalent in terms of SBML components. This class is not prescribed by the SBML specifications, although it is used to implement features defined in SBML.

Public Member Functions

virtual void addL2Namespaces (XMLNamespaces *xmlns) const
 adds all L2 Extension namespaces to the namespace list. More...
 
virtual RenderExtensionclone () const
 Creates and returns a deep copy of this RenderExtension object. More...
 
virtual void enableL2NamespaceForDocument (SBMLDocument *doc) const
 Adds the L2 Namespace to the document and enables the extension. More...
 
virtual unsigned int getLevel (const std::string &uri) const
 Returns the SBML level with the given URI of this package. More...
 
virtual const std::string & getName () const
 Returns the name of this package ("render") More...
 
int getNumOfSBasePlugins () const
 Returns the number of SBasePluginCreatorBase objects stored in this object. More...
 
unsigned int getNumOfSupportedPackageURI () const
 Returns the number of supported package namespace URIs. More...
 
virtual unsigned int getPackageVersion (const std::string &uri) const
 Returns the package version with the given URI of this package. More...
 
virtual SBMLNamespacesgetSBMLExtensionNamespaces (const std::string &uri) const
 Returns a RenderPkgNamespaces object. More...
 
virtual const char * getStringFromTypeCode (int typeCode) const
 This method takes a type code of groups package and returns a string representing the code. More...
 
const std::string & getSupportedPackageURI (unsigned int n) const
 Returns the nth XML namespace URI. More...
 
virtual const std::string & getURI (unsigned int sbmlLevel, unsigned int sbmlVersion, unsigned int pkgVersion) const
 Returns the URI (namespace) of the package corresponding to the combination of the given sbml level, sbml version, and package version. More...
 
virtual unsigned int getVersion (const std::string &uri) const
 Returns the SBML version with the given URI of this package. More...
 
bool isEnabled () const
 Returns true if this package is enabled. More...
 
virtual bool isInUse (SBMLDocument *doc) const
 Determines whether this extension is being used by the given SBMLDocument. More...
 
bool isSupported (const std::string &uri) const
 Returns true if the given XML namespace URI is supported by this package extension. More...
 
RenderExtensionoperator= (const RenderExtension &)
 Assignment operator for GroupsExtension. More...
 
virtual void removeL2Namespaces (XMLNamespaces *xmlns) const
 Removes the L2 Namespace from a document. More...
 
 RenderExtension ()
 Constructor. More...
 
 RenderExtension (const RenderExtension &)
 Copy constructor. More...
 
bool setEnabled (bool isEnabled)
 Enable or disable this package. More...
 
virtual ~RenderExtension ()
 Destroy this object. More...
 

Static Public Member Functions

static unsigned int getDefaultLevel ()
 Returns the default SBML Level this extension. More...
 
static unsigned int getDefaultPackageVersion ()
 Returns the default SBML version this extension. More...
 
static unsigned int getDefaultVersion ()
 Returns the default SBML Version this extension. More...
 
static const std::string & getPackageName ()
 Returns the package name of this extension. More...
 
static const std::string & getXmlnsL2 ()
 Returns URI of L2 version of supported versions of this package. More...
 
static const std::string & getXmlnsL3V1V1 ()
 Returns URI of supported versions of this package. More...
 

Constructor & Destructor Documentation

RenderExtension::RenderExtension ( )

Constructor.

RenderExtension::RenderExtension ( const RenderExtension orig)

Copy constructor.

RenderExtension::~RenderExtension ( )
virtual

Destroy this object.

Member Function Documentation

void RenderExtension::addL2Namespaces ( XMLNamespaces xmlns) const
virtual

adds all L2 Extension namespaces to the namespace list.

This method is overridden here since Render does serialize to an L2 annotation.

Reimplemented from SBMLExtension.

RenderExtension * RenderExtension::clone ( ) const
virtual

Creates and returns a deep copy of this RenderExtension object.

Returns
a (deep) copy of this RenderExtension object

Implements SBMLExtension.

void RenderExtension::enableL2NamespaceForDocument ( SBMLDocument doc) const
virtual

Adds the L2 Namespace to the document and enables the extension.

This method is overridden here since Render does serialize to an L2 annotation.

Reimplemented from SBMLExtension.

unsigned int RenderExtension::getDefaultLevel ( )
static

Returns the default SBML Level this extension.

unsigned int RenderExtension::getDefaultPackageVersion ( )
static

Returns the default SBML version this extension.

unsigned int RenderExtension::getDefaultVersion ( )
static

Returns the default SBML Version this extension.

unsigned int RenderExtension::getLevel ( const std::string &  uri) const
virtual

Returns the SBML level with the given URI of this package.

Parameters
urithe string of URI that represents one of the versions of the render package
Returns
the SBML level with the given URI of this package. 0 will be returned if the given URI is invalid.

Implements SBMLExtension.

const std::string & RenderExtension::getName ( ) const
virtual

Returns the name of this package ("render")

Implements SBMLExtension.

int SBMLExtension::getNumOfSBasePlugins ( ) const
inherited

Returns the number of SBasePluginCreatorBase objects stored in this object.

Returns
the total number of SBasePluginCreatorBase objects stored in this SBMLExtension-derived object.
unsigned int SBMLExtension::getNumOfSupportedPackageURI ( ) const
inherited

Returns the number of supported package namespace URIs.

Returns
the number of supported package XML namespace URIs of this package extension.
const std::string & RenderExtension::getPackageName ( )
static

Returns the package name of this extension.

unsigned int RenderExtension::getPackageVersion ( const std::string &  uri) const
virtual

Returns the package version with the given URI of this package.

Parameters
urithe string of URI that represents one of the versions of the render package
Returns
the package version with the given URI of this package. 0 will be returned if the given URI is invalid.

Implements SBMLExtension.

SBMLNamespaces * RenderExtension::getSBMLExtensionNamespaces ( const std::string &  uri) const
virtual

Returns a RenderPkgNamespaces object.

NULL will be returned if the given uri is not defined in the render package.

Parameters
urithe string of URI that represents one of the versions of the render package
Returns
a RenderPkgNamespaces object corresponding to the given uri. NULL will be returned if the given URI is not defined in render package.

Implements SBMLExtension.

const char * RenderExtension::getStringFromTypeCode ( int  typeCode) const
virtual

This method takes a type code of groups package and returns a string representing the code.

Implements SBMLExtension.

const std::string & SBMLExtension::getSupportedPackageURI ( unsigned int  n) const
inherited

Returns the nth XML namespace URI.

Parameters
nthe index number of the namespace URI being sought.
Returns
a string representing the XML namespace URI understood to be supported by this package. An empty string will be returned if there is no nth URI.
const std::string & RenderExtension::getURI ( unsigned int  sbmlLevel,
unsigned int  sbmlVersion,
unsigned int  pkgVersion 
) const
virtual

Returns the URI (namespace) of the package corresponding to the combination of the given sbml level, sbml version, and package version.

Empty string will be returned if no corresponding URI exists.

Parameters
sbmlLevelthe level of SBML
sbmlVersionthe version of SBML
pkgVersionthe version of package
Returns
a string of the package URI

Implements SBMLExtension.

unsigned int RenderExtension::getVersion ( const std::string &  uri) const
virtual

Returns the SBML version with the given URI of this package.

Parameters
urithe string of URI that represents one of the versions of the render package
Returns
the SBML version with the given URI of this package. 0 will be returned if the given URI is invalid.

Implements SBMLExtension.

const std::string & RenderExtension::getXmlnsL2 ( )
static

Returns URI of L2 version of supported versions of this package.

const std::string & RenderExtension::getXmlnsL3V1V1 ( )
static

Returns URI of supported versions of this package.

bool SBMLExtension::isEnabled ( ) const
inherited

Returns true if this package is enabled.

Returns
true if this package is enabled, false otherwise.
bool RenderExtension::isInUse ( SBMLDocument doc) const
virtual

Determines whether this extension is being used by the given SBMLDocument.

The implementation returns true if the list of layouts contains a global render information, or a layout object contains a local render information object.

Parameters
docthe sbml document to test.
Returns
a boolean indicating whether the extension is actually being used byy the document.

Reimplemented from SBMLExtension.

bool SBMLExtension::isSupported ( const std::string &  uri) const
inherited

Returns true if the given XML namespace URI is supported by this package extension.

Returns
true if the given XML namespace URI (equivalent to a package version) is supported by this package extension, false otherwise.
RenderExtension & RenderExtension::operator= ( const RenderExtension orig)

Assignment operator for GroupsExtension.

void RenderExtension::removeL2Namespaces ( XMLNamespaces xmlns) const
virtual

Removes the L2 Namespace from a document.

This method is overridden here since Render does serialize to an L2 annotation.

Reimplemented from SBMLExtension.

bool SBMLExtension::setEnabled ( bool  isEnabled)
inherited

Enable or disable this package.

Parameters
isEnabledflag indicating whether to enable (if true) or disable (false) this package extension.
Returns
true if this call succeeded; false otherwise.