libSBML Perl API
libSBML 5.8.0 Perl API
|
Public Member Functions | |
virtual void | addL2Namespaces (XMLNamespaces *xmlns) const |
adds all L2 Extension namespaces to the namespace list. More... | |
virtual CompExtension * | clone () const |
Creates and returns a deep copy of this CompExtension object. More... | |
CompExtension () | |
Constructor. More... | |
CompExtension (const CompExtension &) | |
Copy constructor. 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 as a short-form label ("comp "). More... | |
int | getNumOfSBasePlugins () const |
Returns the number of SBasePlugin objects stored in this object. More... | |
unsigned int | getNumOfSupportedPackageURI () const |
Returns the number of supported package Namespace (package versions) of this package extension. More... | |
virtual unsigned int | getPackageVersion (const std::string &uri) const |
Returns the package version with the given URI of this package. More... | |
virtual SBMLNamespaces * | getSBMLExtensionNamespaces (const std::string &uri) const |
Returns an SBMLExtensionNamespaces<CompExtension> object whose alias type is CompPkgNamespace. More... | |
virtual const char * | getStringFromTypeCode (int typeCode) const |
This method takes a type code of comp package and returns a string representing the code. More... | |
const std::string & | getSupportedPackageURI (unsigned int i) const |
Returns the ith URI (the supported package version) 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 Level 3 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 |
Check if this package is enabled (true) or disabled (false). 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 a flag indicating, whether the given URI (package version) is supported by this package extension. More... | |
CompExtension & | operator= (const CompExtension &) |
Assignment operator for CompExtension. More... | |
virtual void | removeL2Namespaces (XMLNamespaces *xmlns) const |
Removes the L2 Namespaces. More... | |
bool | setEnabled (bool isEnabled) |
enable/disable this package. More... | |
virtual | ~CompExtension () |
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 & | getXmlnsL3V1V1 () |
Returns URI of supported versions of this package. More... | |
CompExtension::CompExtension | ( | ) |
Constructor.
CompExtension::CompExtension | ( | const CompExtension & | orig | ) |
Copy constructor.
|
virtual |
Destroy this object.
|
virtualinherited |
adds all L2 Extension namespaces to the namespace list.
adds the L2 Namespace
This method should be overridden by all extensions that want to serialize to an L2 annotation.
|
virtual |
Creates and returns a deep copy of this CompExtension object.
Implements SBMLExtension.
|
virtualinherited |
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.
|
static |
Returns the default SBML Level this extension.
|
static |
Returns the default SBML version this extension.
|
static |
Returns the default SBML Version this extension.
|
virtual |
Returns the SBML Level with the given URI of this package.
uri | the string of URI that represents one of versions of the comp package. |
0
will be returned if the given URI is invalid. Implements SBMLExtension.
|
virtual |
Returns the name of this package as a short-form label ("comp
").
Implements SBMLExtension.
|
inherited |
Returns the number of SBasePlugin objects stored in this object.
|
inherited |
Returns the number of supported package Namespace (package versions) of this package extension.
|
static |
Returns the package name of this extension.
|
virtual |
Returns the package version with the given URI of this package.
uri | the string of URI that represents one of versions of comp package. |
Implements SBMLExtension.
|
virtual |
Returns an SBMLExtensionNamespaces<CompExtension> object whose alias type is CompPkgNamespace.
uri | the string of URI that represents one of versions of comp package. |
NULL
will be returned if the given URI is not defined in comp package. Implements SBMLExtension.
|
virtual |
This method takes a type code of comp package and returns a string representing the code.
typeCode | the libSBML typecode in question. |
Implements SBMLExtension.
|
inherited |
Returns the ith URI (the supported package version)
i | the index of the list of URI (the list of supporeted pacakge versions) |
|
virtual |
Returns the URI (namespace) of the package corresponding to the combination of the given SBML Level, SBML Version, and Level 3 package version.
sbmlLevel | the level of SBML |
sbmlVersion | the version of SBML |
pkgVersion | the version of package |
Implements SBMLExtension.
|
virtual |
Returns the SBML version with the given URI of this package.
uri | the string of URI that represents one of versions of comp package. |
0
will be returned if the given URI is invalid. Implements SBMLExtension.
|
static |
Returns URI of supported versions of this package.
|
inherited |
Check if this package is enabled (true) or disabled (false).
|
virtualinherited |
Determines whether this extension is being used by the given SBMLDocument.
The default implementation returns true. This means that when a document had this extension enabled, it will not be possible to convert it to L2 as we cannot make sure that the extension can be converted.
doc | the sbml document to test. |
|
inherited |
Returns a flag indicating, whether the given URI (package version) is supported by this package extension.
CompExtension & CompExtension::operator= | ( | const CompExtension & | orig | ) |
Assignment operator for CompExtension.
|
virtualinherited |
Removes the L2 Namespaces.
Removes the L2 Namespace.
This method should be overridden by all extensions that want to serialize to an L2 annotation.
|
inherited |
enable/disable this package.
Returned value is the result of this function.
isEnabled | the bool value: true (enabled) or false (disabled) |