Inheritance diagram for LayoutExtension:

Detailed Description

layout 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 LayoutExtension *	clone () const
	Creates and returns a deep copy of this LayoutExtension 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 for the given URI of this package. More...

virtual const std::string &	getName () const
	Returns the name of this package ("layout") 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 SBML Level 3 package version for the given URI of this package. More...

virtual SBMLNamespaces *	getSBMLExtensionNamespaces (const std::string &uri) const
	Returns a LayoutPkgNamespaces object. More...

virtual const char *	getStringFromTypeCode (int typeCode) const
	Takes a type code of the “layout” package and returns a string describing 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 a string representing the SBML XML namespace of this SBML Level 3 package. More...

virtual unsigned int	getVersion (const std::string &uri) const
	Returns the Version within the SBML Level for 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...

	LayoutExtension ()
	Creates a new LayoutExtension instance. More...

	LayoutExtension (const LayoutExtension &orig)
	Copy constructor. More...

LayoutExtension &	operator= (const LayoutExtension &orig)
	Assignment operator for LayoutExtension. More...

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

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

virtual	~LayoutExtension ()
	Destroy this object. More...

Static Public Member Functions
static unsigned int	getDefaultLevel ()
	Returns the default SBML Level used by this libSBML package extension. More...

static unsigned int	getDefaultPackageVersion ()
	Returns the default version of the SBML Level 3 package implemented by this libSBML extension. More...

static unsigned int	getDefaultVersion ()
	Returns the default SBML Version used by this libSBML package extension. More...

static const std::string &	getPackageName ()
	Returns the nickname of the SBML Level 3 package implemented by this libSBML extension. More...

static const std::string &	getXmlnsL2 ()
	Returns the XML namespace URI of the SBML Level 2 version of the package implemented by this libSBML Extension. More...

static const std::string &	getXmlnsL3V1V1 ()
	Returns the XML namespace URI of the SBML Level 3 package implemented by this libSBML extension. More...

static const std::string &	getXmlnsXSI ()
	Returns the XML namespace URI of any additional XML namespaces needed or used by this SBML Level 3 package. More...

Constructor & Destructor Documentation

◆ LayoutExtension() [1/2]

LayoutExtension::LayoutExtension ( )

Creates a new LayoutExtension instance.

◆ LayoutExtension() [2/2]

LayoutExtension::LayoutExtension ( const LayoutExtension & orig )

Copy constructor.

Parameters

orig	the instance to copy.

◆ ~LayoutExtension()

LayoutExtension::~LayoutExtension ( )

virtual

Destroy this object.

Member Function Documentation

◆ addL2Namespaces()

void LayoutExtension::addL2Namespaces ( XMLNamespaces * xmlns ) const

virtual

adds all L2 Extension namespaces to the namespace list.

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

Reimplemented from SBMLExtension.

◆ clone()

LayoutExtension * LayoutExtension::clone ( ) const

virtual

Creates and returns a deep copy of this LayoutExtension object.

Returns: a (deep) copy of this LayoutExtension object.

Implements SBMLExtension.

◆ enableL2NamespaceForDocument()

void LayoutExtension::enableL2NamespaceForDocument ( SBMLDocument * doc ) const

virtual

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

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

Reimplemented from SBMLExtension.

◆ getDefaultLevel()

unsigned int LayoutExtension::getDefaultLevel ( )

static

Returns the default SBML Level used by this libSBML package extension.

Returns: the SBML Level.

◆ getDefaultPackageVersion()

unsigned int LayoutExtension::getDefaultPackageVersion ( )

static

Returns the default version of the SBML Level 3 package implemented by this libSBML extension.

Returns: the default version number of the SBML Level 3 package definition.

◆ getDefaultVersion()

unsigned int LayoutExtension::getDefaultVersion ( )

static

Returns the default SBML Version used by this libSBML package extension.

Returns: the Version within the default SBML Level.

◆ getLevel()

unsigned int LayoutExtension::getLevel ( const std::string & uri ) const

virtual

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

Parameters

uri	a URI that represents a version of this package.

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

Implements SBMLExtension.

◆ getName()

const std::string & LayoutExtension::getName ( ) const

virtual

Returns the name of this package ("layout")

Returns: the name of this package ("layout").

Implements SBMLExtension.

◆ getNumOfSBasePlugins()

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.

◆ getNumOfSupportedPackageURI()

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.

◆ getPackageName()

const std::string & LayoutExtension::getPackageName ( )

static

Returns the nickname of the SBML Level 3 package implemented by this libSBML extension.

Returns: the package nickname, as a string.

◆ getPackageVersion()

unsigned int LayoutExtension::getPackageVersion ( const std::string & uri ) const

virtual

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

Parameters

uri	a URI that represents one of the valid versions of this package.

Returns: the version of the SBML Level 3 package with the given URI, or 0 if the given URI is invalid, or for a different package.

Implements SBMLExtension.

◆ getSBMLExtensionNamespaces()

SBMLNamespaces * LayoutExtension::getSBMLExtensionNamespaces ( const std::string & uri ) const

virtual

Returns a LayoutPkgNamespaces object.

Parameters

uri	a URI that represents one of the valid versions of the “layout” package.

Returns: a LayoutPkgNamespaces object corresponding to the given uri, or NULL if the URI is not defined in the Layout package.

Implements SBMLExtension.

◆ getStringFromTypeCode()

const char * LayoutExtension::getStringFromTypeCode ( int typeCode ) const

virtual

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

Parameters

typeCode a libSBML type code defined by the libSBML extension. implementing support for the SBML Level 3 “layout” package.

Returns: a text string representing the type code given by typeCode. If the type code is unrecognized for this implementation of the libSBML “layout” package, the string returned will be "(Unknown SBML Layout Type)".

Implements SBMLExtension.

◆ getSupportedPackageURI()

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

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.

◆ getURI()

const std::string & LayoutExtension::getURI	(	unsigned int	sbmlLevel,
		unsigned int	sbmlVersion,
		unsigned int	pkgVersion
	)		const

virtual

Returns a string representing the SBML XML namespace of this SBML Level 3 package.

The namespace URI constructed by this method corresponds to the combination of the Level and Version of SBML, and the Version of the SBML Level 3 package. (At the time of this writing, the only SBML Level that supports packages is Level 3, so the value of sbmlLevel must necessarily always be 3.)

Parameters

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

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

Implements SBMLExtension.

◆ getVersion()

unsigned int LayoutExtension::getVersion ( const std::string & uri ) const

virtual

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

Parameters

uri	a URI that represents a version of this package.

Returns: the SBML Version within the SBML Level for the given URI of this package, or 0 if the given URI is invalid, or for a different package.

Implements SBMLExtension.

◆ getXmlnsL2()

const std::string & LayoutExtension::getXmlnsL2 ( )

static

Returns the XML namespace URI of the SBML Level 2 version of the package implemented by this libSBML Extension.

Unique among the SBML Level 3 packages, the Layout package existed and was in widespread use prior to the introduction of SBML Level 3. The Layout package was used as model annotations in SBML Level 2. This method returns the SBML annotation XML namespace used for Level 2.

Returns: the XML namespace as a string.

Examples: addLayout.cpp, example1.cpp, example2.cpp, and example3.cpp.

◆ getXmlnsL3V1V1()

const std::string & LayoutExtension::getXmlnsL3V1V1 ( )

static

Returns the XML namespace URI of the SBML Level 3 package implemented by this libSBML extension.

Returns: the XML namespace as a string.

Examples: addLayout.cpp.

◆ getXmlnsXSI()

const std::string & LayoutExtension::getXmlnsXSI ( )

static

Returns the XML namespace URI of any additional XML namespaces needed or used by this SBML Level 3 package.

Returns: the XML namespace as a string.

◆ isEnabled()

bool SBMLExtension::isEnabled ( ) const

inherited

Returns true if this package is enabled.

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

◆ isInUse()

bool LayoutExtension::isInUse ( SBMLDocument * doc ) const

virtual

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 boolean indicating whether the extension is actually being used by the document.

Reimplemented from SBMLExtension.

◆ isSupported()

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.

◆ operator=()

LayoutExtension & LayoutExtension::operator= ( const LayoutExtension & orig )

Assignment operator for LayoutExtension.

Parameters

orig	the object whose values are used as the basis of the assignment.

◆ removeL2Namespaces()

void LayoutExtension::removeL2Namespaces ( XMLNamespaces * xmlns ) const

virtual

Removes the L2 Namespace from a document.

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

Reimplemented from SBMLExtension.

◆ setEnabled()

bool 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.

Detailed Description

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

◆ LayoutExtension() [1/2]

◆ LayoutExtension() [2/2]

◆ ~LayoutExtension()

Member Function Documentation

◆ addL2Namespaces()

◆ clone()

◆ enableL2NamespaceForDocument()

◆ getDefaultLevel()

◆ getDefaultPackageVersion()

◆ getDefaultVersion()

◆ getLevel()

◆ getName()

◆ getNumOfSBasePlugins()

◆ getNumOfSupportedPackageURI()

◆ getPackageName()

◆ getPackageVersion()

◆ getSBMLExtensionNamespaces()

◆ getStringFromTypeCode()

◆ getSupportedPackageURI()

◆ getURI()

◆ getVersion()

◆ getXmlnsL2()

◆ getXmlnsL3V1V1()

◆ getXmlnsXSI()

◆ isEnabled()

◆ isInUse()

◆ isSupported()

◆ operator=()

◆ removeL2Namespaces()

◆ setEnabled()