Inheritance diagram for libsbmlcs.RenderExtension:

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
new void	addL2Namespaces (XMLNamespaces xmlns)
	adds all L2 Extension namespaces to the namespace list. More...

new RenderExtension	clone ()
	Creates and returns a deep copy of this RenderExtension object. More...

override void	Dispose ()

override SBase	DowncastSBase (IntPtr cPtr, bool owner)

override SBasePlugin	DowncastSBasePlugin (IntPtr cPtr, bool owner)

new void	enableL2NamespaceForDocument (SBMLDocument doc)
	Adds the L2 Namespace to the document and enables the extension. More...

long	getCategory (long index)

new long	getLevel (string uri)
	Returns the SBML level with the given URI of this package. More...

string	getMessage (long index, long pkgVersion, string details)

new string	getName ()
	Returns the name of this package ('render') More...

int	getNumOfSBasePlugins ()
	Returns the number of SBasePluginCreatorBase objects stored in this object. More...

long	getNumOfSupportedPackageURI ()
	Returns the number of supported package namespace URIs. More...

new long	getPackageVersion (string uri)
	Returns the package version with the given URI of this package. More...

new SBMLNamespaces	getSBMLExtensionNamespaces (string uri)
	Returns a RenderPkgNamespaces object. More...

long	getSeverity (long index, long pkgVersion)

string	getShortMessage (long index)

new string	getStringFromTypeCode (int typeCode)
	This method takes a type code of groups package and returns a string representing the code. More...

string	getSupportedPackageURI (long n)
	Returns the nth XML namespace URI. More...

new string	getURI (long sbmlLevel, long sbmlVersion, long pkgVersion)
	Returns the URI (namespace) of the package corresponding to the combination of the given sbml level, sbml version, and package version. More...

new long	getVersion (string uri)
	Returns the SBML version with the given URI of this package. More...

bool	isEnabled ()
	Returns `true` if this package is enabled. More...

new bool	isInUse (SBMLDocument doc)
	Determines whether this extension is being used by the given SBMLDocument. More...

bool	isSupported (string uri)
	Returns `true` if the given XML namespace URI is supported by this package extension. More...

new void	removeL2Namespaces (XMLNamespaces xmlns)
	Removes the L2 Namespace from a document. More...

	RenderExtension ()
	Constructor. More...

	RenderExtension (RenderExtension arg0)
	Copy constructor. More...

bool	setEnabled (bool isEnabled)
	Enable or disable this package. More...

Static Public Member Functions
static long	getDefaultLevel ()
	Returns the default SBML Level this extension. More...

static long	getDefaultPackageVersion ()
	Returns the default SBML version this extension. More...

static long	getDefaultVersion ()
	Returns the default SBML Version this extension. More...

static string	getPackageName ()
	Returns the package name of this extension. More...

static string	getXmlnsL2 ()
	Returns URI of L2 version of supported versions of this package. More...

static string	getXmlnsL3V1V1 ()
	Returns URI of supported versions of this package. More...

static void	init ()

Protected Attributes
bool	swigCMemOwn

Constructor & Destructor Documentation

libsbmlcs.RenderExtension.RenderExtension ( )

Constructor.

libsbmlcs.RenderExtension.RenderExtension ( RenderExtension arg0 )

Copy constructor.

Member Function Documentation

new void libsbmlcs.RenderExtension.addL2Namespaces ( XMLNamespaces xmlns )

adds all L2 Extension namespaces to the namespace list.

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

new RenderExtension libsbmlcs.RenderExtension.clone ( )

Creates and returns a deep copy of this RenderExtension object.

Returns: a (deep) copy of this RenderExtension object

override void libsbmlcs.RenderExtension.Dispose ( )

virtual

Reimplemented from libsbmlcs.SBMLExtension.

override SBase libsbmlcs.RenderExtension.DowncastSBase	(	IntPtr	cPtr,
		bool	owner
	)

virtual

Reimplemented from libsbmlcs.SBMLExtension.

override SBasePlugin libsbmlcs.RenderExtension.DowncastSBasePlugin	(	IntPtr	cPtr,
		bool	owner
	)

virtual

Reimplemented from libsbmlcs.SBMLExtension.

new void libsbmlcs.RenderExtension.enableL2NamespaceForDocument ( SBMLDocument doc )

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

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

long libsbmlcs.SBMLExtension.getCategory ( long index )

inherited

static long libsbmlcs.RenderExtension.getDefaultLevel ( )

static

Returns the default SBML Level this extension.

static long libsbmlcs.RenderExtension.getDefaultPackageVersion ( )

static

Returns the default SBML version this extension.

static long libsbmlcs.RenderExtension.getDefaultVersion ( )

static

Returns the default SBML Version this extension.

new long libsbmlcs.RenderExtension.getLevel ( string uri )

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

Parameters

uri	the 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.

string libsbmlcs.SBMLExtension.getMessage	(	long	index,
		long	pkgVersion,
		string	details
	)

inherited

new string libsbmlcs.RenderExtension.getName ( )

Returns the name of this package ('render')

int libsbmlcs.SBMLExtension.getNumOfSBasePlugins ( )

inherited

Returns the number of SBasePluginCreatorBase objects stored in this object.

Returns: the total number of SBasePluginCreatorBase objects stored in this SBMLExtension-derived object.

long libsbmlcs.SBMLExtension.getNumOfSupportedPackageURI ( )

inherited

Returns the number of supported package namespace URIs.

Returns: the number of supported package XML namespace URIs of this package extension.

static string libsbmlcs.RenderExtension.getPackageName ( )

static

Returns the package name of this extension.

new long libsbmlcs.RenderExtension.getPackageVersion ( string uri )

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

Parameters

uri	the 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.

new SBMLNamespaces libsbmlcs.RenderExtension.getSBMLExtensionNamespaces ( string uri )

Returns a RenderPkgNamespaces object.

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

Parameters

uri	the 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.

long libsbmlcs.SBMLExtension.getSeverity	(	long	index,
		long	pkgVersion
	)

inherited

string libsbmlcs.SBMLExtension.getShortMessage ( long index )

inherited

new string libsbmlcs.RenderExtension.getStringFromTypeCode ( int typeCode )

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

string libsbmlcs.SBMLExtension.getSupportedPackageURI ( long n )

inherited

Returns the nth XML namespace URI.

Parameters

n	the 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.

new string libsbmlcs.RenderExtension.getURI	(	long	sbmlLevel,
		long	sbmlVersion,
		long	pkgVersion
	)

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

sbmlLevel	the level of SBML
sbmlVersion	the version of SBML
pkgVersion	the version of package

Returns: a string of the package URI

new long libsbmlcs.RenderExtension.getVersion ( string uri )

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

Parameters

uri	the 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.

static string libsbmlcs.RenderExtension.getXmlnsL2 ( )

static

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

static string libsbmlcs.RenderExtension.getXmlnsL3V1V1 ( )

static

Returns URI of supported versions of this package.

static void libsbmlcs.RenderExtension.init ( )

static

bool libsbmlcs.SBMLExtension.isEnabled ( )

inherited

Returns true if this package is enabled.

Returns: true if this package is enabled, false otherwise.

new bool libsbmlcs.RenderExtension.isInUse ( SBMLDocument doc )

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

doc	the sbml document to test.

Returns: a boolean indicating whether the extension is actually being used byy the document.

bool libsbmlcs.SBMLExtension.isSupported ( string uri )

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.

new void libsbmlcs.RenderExtension.removeL2Namespaces ( XMLNamespaces xmlns )

Removes the L2 Namespace from a document.

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

bool libsbmlcs.SBMLExtension.setEnabled ( bool isEnabled )

inherited

Enable or disable this package.

Parameters

isEnabled flag indicating whether to enable (if true) or disable (false) this package extension.

Returns: true if this call succeeded; false otherwise.

Member Data Documentation

bool libsbmlcs.SBMLExtension.swigCMemOwn

protectedinherited

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation