Inheritance diagram for libsbmlcs.LayoutExtension:

Detailed Description

{layout}

layout The core module of the 'layout' package extension.

Public Member Functions
void	addL2Namespaces (XMLNamespaces xmlns)
	adds all L2 Extension namespaces to the namespace list. More...

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

override void	Dispose ()

override SBase	DowncastSBase (IntPtr cPtr, bool owner)

override SBasePlugin	DowncastSBasePlugin (IntPtr cPtr, bool owner)

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

long	getCategory (long index)

SWIGTYPE_p_packageErrorTableEntry	getErrorTable (long index)
	Return the entry in the error table at this index. More...

long	getErrorTableIndex (long errorId)
	Return the index in the error table with the given errorId. More...

long	getLevel (string uri)
	Returns the SBML Level for the given URI of this package. More...

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

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

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

long	getNumOfSupportedPackageURI ()
	Returns the number of supported package Namespace (package versions) of this package extension. More...

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

SBMLNamespaces	getSBMLExtensionNamespaces (string uri)
	Returns an LayoutPkgNamespaces object. More...

long	getSeverity (long index, long pkgVersion)

string	getShortMessage (long index)

string	getStringFromTypeCode (int typeCode)
	Takes a type code of the “layout” package and returns a string describing the code. More...

string	getSupportedPackageURI (long i)
	Returns the ith URI (the supported package version) More...

string	getURI (long sbmlLevel, long sbmlVersion, long pkgVersion)
	Returns the namespace URI corresponding to the combination of the given SBML Level, Version, and package version. More...

long	getVersion (string uri)
	Returns the SBML Version for the given URI of this package. More...

bool	isEnabled ()
	Check if this package is enabled (true) or disabled (false). More...

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

bool	isSupported (string uri)
	Returns a flag indicating, whether the given URI (package version) is supported by this package extension. More...

	LayoutExtension ()
	Constructor. More...

	LayoutExtension (LayoutExtension arg0)
	Copy constructor. More...

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

bool	setEnabled (bool isEnabled)
	enable/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 ()

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

static string	getXmlnsXSI ()

static void	init ()
	Initializes layout extension by creating an object of this class with required SBasePlugin derived objects and registering the object to the SBMLExtensionRegistry class. More...

Protected Attributes
bool	swigCMemOwn

Constructor & Destructor Documentation

libsbmlcs.LayoutExtension.LayoutExtension ( )

Constructor.

libsbmlcs.LayoutExtension.LayoutExtension ( LayoutExtension arg0 )

Copy constructor.

Member Function Documentation

void libsbmlcs.LayoutExtension.addL2Namespaces ( XMLNamespaces xmlns )

adds all L2 Extension namespaces to the namespace list.

This method should be overridden by all extensions that want to serialize to an L2 annotation.

new LayoutExtension libsbmlcs.LayoutExtension.clone ( )

Creates and returns a deep copy of this LayoutExtension object.

Returns: a (deep) copy of this LayoutExtension object

override void libsbmlcs.LayoutExtension.Dispose ( )

virtual

Reimplemented from libsbmlcs.SBMLExtension.

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

virtual

Reimplemented from libsbmlcs.SBMLExtension.

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

virtual

Reimplemented from libsbmlcs.SBMLExtension.

void libsbmlcs.LayoutExtension.enableL2NamespaceForDocument ( SBMLDocument doc )

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

If the extension supports serialization to SBML L2 Annotations, this method should be overrridden, so it will be activated.

long libsbmlcs.SBMLExtension.getCategory ( long index )

inherited

static long libsbmlcs.LayoutExtension.getDefaultLevel ( )

static

Returns the default SBML Level this extension.

static long libsbmlcs.LayoutExtension.getDefaultPackageVersion ( )

static

Returns the default SBML version this extension.

static long libsbmlcs.LayoutExtension.getDefaultVersion ( )

static

Returns the default SBML Version this extension.

SWIGTYPE_p_packageErrorTableEntry libsbmlcs.LayoutExtension.getErrorTable ( long index )

Return the entry in the error table at this index.

Parameters

index a long integergere representing the index of the error in the LayoutSBMLErrorTable

Returns: packageErrorTableEntry object in the LayoutSBMLErrorTable corresponding to the index given.

long libsbmlcs.LayoutExtension.getErrorTableIndex ( long errorId )

Return the index in the error table with the given errorId.

Parameters

errorId a long integergere representing the errorId of the error in the LayoutSBMLErrorTable

Returns: longeger representing the index in the LayoutSBMLErrorTable corresponding to the errorId given.

long libsbmlcs.LayoutExtension.getLevel ( string uri )

Returns the SBML Level for the given URI of this package.

Parameters

uri	the string of URI that represents one of versions of the “layout” package

Returns: the SBML Level with the given URI of this package, or 0 if the given URI is invalid.

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

inherited

string libsbmlcs.LayoutExtension.getName ( )

Returns the name of this package ('layout')

Returns: the name of this package ('layout')

int libsbmlcs.SBMLExtension.getNumOfSBasePlugins ( )

inherited

Returns the number of SBasePlugin objects stored in this object.

Returns: the number of SBasePlugin objects stored in this object.

long libsbmlcs.SBMLExtension.getNumOfSupportedPackageURI ( )

inherited

Returns the number of supported package Namespace (package versions) of this package extension.

Returns: the number of supported package Namespace (package versions) of this package extension.

static string libsbmlcs.LayoutExtension.getPackageName ( )

static

Returns the package name of this extension.

long libsbmlcs.LayoutExtension.getPackageVersion ( string uri )

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

Parameters

uri	the string of URI that represents one of versions of the “layout” package

Returns: the package version with the given URI of this package, or 0 if the given URI is invalid.

SBMLNamespaces libsbmlcs.LayoutExtension.getSBMLExtensionNamespaces ( string uri )

Returns an LayoutPkgNamespaces object.

Parameters

uri	the string of URI that represents one of versions of the “layout” package

Returns: an LayoutPkgNamespace object corresponding to the given uri, or null if the URI is not defined in the Layout package.

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

inherited

string libsbmlcs.SBMLExtension.getShortMessage ( long index )

inherited

string libsbmlcs.LayoutExtension.getStringFromTypeCode ( int typeCode )

Takes a type code of the “layout” package and returns a string describing the code.

string libsbmlcs.SBMLExtension.getSupportedPackageURI ( long i )

inherited

Returns the ith URI (the supported package version)

Parameters

i	the index of the list of URI (the list of supporeted package versions)

Returns: the URI of supported package version with the given index.

string libsbmlcs.LayoutExtension.getURI	(	long	sbmlLevel,
		long	sbmlVersion,
		long	pkgVersion
	)

Returns the namespace URI corresponding to the combination of the given SBML Level, Version, and package version.

Parameters

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

Returns: a string of the package URI, or an empty string if no corresponding URI exists.

long libsbmlcs.LayoutExtension.getVersion ( string uri )

Returns the SBML Version for the given URI of this package.

Parameters

uri	the string of URI that represents one of versions of the “layout” package

Returns: the SBML version with the given URI of this package, or 0 if the given URI is invalid.

static string libsbmlcs.LayoutExtension.getXmlnsL2 ( )

static

static string libsbmlcs.LayoutExtension.getXmlnsL3V1V1 ( )

static

Returns URI of supported versions of this package.

static string libsbmlcs.LayoutExtension.getXmlnsXSI ( )

static

static void libsbmlcs.LayoutExtension.init ( )

static

Initializes layout extension by creating an object of this class with required SBasePlugin derived objects and registering the object to the SBMLExtensionRegistry class.

(NOTE) This function is automatically invoked when creating the following global object in LayoutExtension.cpp

static SBMLExtensionRegister<LayoutExtension> layoutExtensionRegistry;

bool libsbmlcs.SBMLExtension.isEnabled ( )

inherited

Check if this package is enabled (true) or disabled (false).

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

bool libsbmlcs.LayoutExtension.isInUse ( SBMLDocument doc )

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

The implementation returns true if the model object contains one or more layouts.

Parameters

doc	the sbml document to test.

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

bool libsbmlcs.SBMLExtension.isSupported ( string uri )

inherited

Returns a flag indicating, whether the given URI (package version) is supported by this package extension.

Returns: true if the given URI (package version) is supported by this package extension, otherwise false is returned.

void libsbmlcs.LayoutExtension.removeL2Namespaces ( XMLNamespaces xmlns )

Removes the L2 Namespace from a document.

This method should be overridden by all extensions that want to serialize to an L2 annotation.

bool libsbmlcs.SBMLExtension.setEnabled ( bool isEnabled )

inherited

enable/disable this package.

Returned value is the result of this function.

Parameters

isEnabled the bool value: true (enabled) or false (disabled)

Returns: true if this function call succeeded, otherwise false is returned.

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