libSBML Perl API
libSBML 5.10.0 Perl API
|
{core} Registry class in which extension packages are registered.
Public Member Functions | |
int | addExtension (const SBMLExtension *ext) |
Add the given SBMLExtension to this SBMLExtensionRegistry. More... | |
void | addL2Namespaces (XMLNamespaces *xmlns) const |
adds all L2 Extension namespaces to the namespace list. More... | |
void | disableUnusedPackages (SBMLDocument *doc) |
Goes through all extensions in the list of plugins of the given document and disables all plugins that are not being used. More... | |
void | enableL2NamespaceForDocument (SBMLDocument *doc) const |
Enables all extensions that support serialization / deserialization with SBML Annotations. More... | |
SBMLExtension * | getExtension (const std::string &package) |
Returns an SBMLExtension object with the given package URI or package name (string). More... | |
unsigned int | getNumExtension (const SBaseExtensionPoint &extPoint) |
Returns the number of SBMLExtension* with the given extension point. More... | |
bool | isEnabled (const std::string &uri) |
Checks if the extension with the given URI is enabled (true) or disabled (false) More... | |
bool | isRegistered (const std::string &uri) |
Checks if the extension with the given URI is registered (true) or not (false) More... | |
void | removeL2Namespaces (XMLNamespaces *xmlns) const |
Remove all L2 Extension namespaces from the namespace list. More... | |
bool | setEnabled (const std::string &uri, bool isEnabled) |
Enable/disable the package with the given uri. More... | |
Static Public Member Functions | |
static void | disablePackage (const std::string &package) |
Disables the package with the given URI / name. More... | |
static void | enablePackage (const std::string &package) |
Enables the package with the given URI / name. More... | |
static SBMLExtensionRegistry & | getInstance () |
Returns an instance (singleton) of the SBMLExtensionRegistry class. More... | |
static unsigned int | getNumRegisteredPackages () |
Returns the number of registered packages. More... | |
static std::string | getRegisteredPackageName (unsigned int index) |
Returns the registered package name at the given index. More... | |
static List * | getRegisteredPackageNames () |
Returns a list of registered packages (such as 'layout', 'fbc' or 'comp') the list contains char* strings and has to be freed by the caller. More... | |
static bool | isPackageEnabled (const std::string &package) |
If the given package is enabled, returns true ; otherwise, returns false . More... | |
int SBMLExtensionRegistry::addExtension | ( | const SBMLExtension * | ext | ) |
Add the given SBMLExtension to this SBMLExtensionRegistry.
ext | the SBMLExtension object to be added. |
void SBMLExtensionRegistry::addL2Namespaces | ( | XMLNamespaces * | xmlns | ) | const |
adds all L2 Extension namespaces to the namespace list.
This will call all overriden SBMLExtension::addL2Namespaces methods.
|
static |
Disables the package with the given URI / name.
void SBMLExtensionRegistry::disableUnusedPackages | ( | SBMLDocument * | doc | ) |
Goes through all extensions in the list of plugins of the given document and disables all plugins that are not being used.
void SBMLExtensionRegistry::enableL2NamespaceForDocument | ( | SBMLDocument * | doc | ) | const |
Enables all extensions that support serialization / deserialization with SBML Annotations.
|
static |
Enables the package with the given URI / name.
SBMLExtension* SBMLExtensionRegistry::getExtension | ( | const std::string & | package | ) |
Returns an SBMLExtension object with the given package URI or package name (string).
package | the URI or name of the package extension |
|
static |
Returns an instance (singleton) of the SBMLExtensionRegistry class.
This function needs to be invoked when manipulating the SBMLExtensionRegistry class.
unsigned int SBMLExtensionRegistry::getNumExtension | ( | const SBaseExtensionPoint & | extPoint | ) |
Returns the number of SBMLExtension* with the given extension point.
extPoint | the SBaseExtensionPoint |
|
static |
Returns the number of registered packages.
|
static |
Returns the registered package name at the given index.
index | zero based index of the package name to return |
|
static |
Returns a list of registered packages (such as 'layout', 'fbc' or 'comp') the list contains char* strings and has to be freed by the caller.
bool SBMLExtensionRegistry::isEnabled | ( | const std::string & | uri | ) |
Checks if the extension with the given URI is enabled (true) or disabled (false)
uri | the URI of the target package. |
|
static |
If the given package
is enabled, returns true
; otherwise, returns false
.
bool SBMLExtensionRegistry::isRegistered | ( | const std::string & | uri | ) |
Checks if the extension with the given URI is registered (true) or not (false)
uri | the URI of the target package. |
void SBMLExtensionRegistry::removeL2Namespaces | ( | XMLNamespaces * | xmlns | ) | const |
Remove all L2 Extension namespaces from the namespace list.
This will call all overriden SBMLExtension::removeL2Namespaces methods.
bool SBMLExtensionRegistry::setEnabled | ( | const std::string & | uri, |
bool | isEnabled | ||
) |
Enable/disable the package with the given uri.
uri | the URI of the target package. |
isEnabled | the bool value corresponding to enabled (true) or disabled (false) |