libSBML C++ API
5.18.0
|
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... | |
LayoutExtension::LayoutExtension | ( | ) |
Creates a new LayoutExtension instance.
LayoutExtension::LayoutExtension | ( | const LayoutExtension & | orig | ) |
Copy constructor.
orig | the instance to copy. |
|
virtual |
Destroy this object.
|
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.
|
virtual |
Creates and returns a deep copy of this LayoutExtension object.
Implements SBMLExtension.
|
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.
|
static |
Returns the default SBML Level used by this libSBML package extension.
|
static |
Returns the default version of the SBML Level 3 package implemented by this libSBML extension.
|
static |
Returns the default SBML Version used by this libSBML package extension.
|
virtual |
Returns the SBML Level for the given URI of this package.
uri | a URI that represents a version of this package. |
0
if the given URI is invalid, or for a different package. Implements SBMLExtension.
|
virtual |
Returns the name of this package ("layout")
Implements SBMLExtension.
|
inherited |
Returns the number of SBasePluginCreatorBase objects stored in this object.
|
inherited |
Returns the number of supported package namespace URIs.
|
static |
Returns the nickname of the SBML Level 3 package implemented by this libSBML extension.
|
virtual |
Returns the SBML Level 3 package version for the given URI of this package.
uri | a URI that represents one of the valid versions of this package. |
0
if the given URI is invalid, or for a different package. Implements SBMLExtension.
|
virtual |
Returns a LayoutPkgNamespaces object.
uri | a URI that represents one of the valid versions of the “layout” package. |
uri
, or NULL
if the URI is not defined in the Layout package. Implements SBMLExtension.
|
virtual |
Takes a type code of the “layout” package and returns a string describing the code.
typeCode | a libSBML type code defined by the libSBML extension. implementing support for the SBML Level 3 “layout” package. |
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.
|
inherited |
Returns the nth XML namespace URI.
n | the index number of the namespace URI being sought. |
|
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
.)
sbmlLevel | the level of SBML. |
sbmlVersion | the version of SBML. |
pkgVersion | the version of the package. |
Implements SBMLExtension.
|
virtual |
Returns the Version within the SBML Level for the given URI of this package.
uri | a URI that represents a version of this package. |
0
if the given URI is invalid, or for a different package. Implements SBMLExtension.
|
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.
|
static |
Returns the XML namespace URI of the SBML Level 3 package implemented by this libSBML extension.
|
static |
Returns the XML namespace URI of any additional XML namespaces needed or used by this SBML Level 3 package.
|
inherited |
Returns true
if this package is enabled.
true
if this package is enabled, false
otherwise.
|
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.
doc | the sbml document to test. |
Reimplemented from SBMLExtension.
|
inherited |
Returns true
if the given XML namespace URI is supported by this package extension.
true
if the given XML namespace URI (equivalent to a package version) is supported by this package extension, false
otherwise. LayoutExtension & LayoutExtension::operator= | ( | const LayoutExtension & | orig | ) |
Assignment operator for LayoutExtension.
orig | the object whose values are used as the basis of the assignment. |
|
virtual |
Removes the L2 Namespace from a document.
This method is overridden here since Layout does serialize to an L2 annotation.
Reimplemented from SBMLExtension.
|
inherited |
Enable or disable this package.
isEnabled | flag indicating whether to enable (if true ) or disable (false ) this package extension. |
true
if this call succeeded; false
otherwise.