libSBML C# API  libSBML 5.8.0 C# API
 All Classes Namespaces Files Functions Variables Properties Pages
libsbmlcs.SBMLExtensionRegistry Class Reference
Inheritance diagram for libsbmlcs.SBMLExtensionRegistry:
[legend]

Public Member Functions

int addExtension (SBMLExtension ext)
 Add the given SBMLExtension to this SBMLExtensionRegistry. More...
 
void addL2Namespaces (XMLNamespaces xmlns)
 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...
 
virtual void Dispose ()
 
void enableL2NamespaceForDocument (SBMLDocument doc)
 Enables all extensions that support serialization / deserialization with SBML Annotations. More...
 
SBMLExtension getExtension (string package)
 Returns an SBMLExtension object with the given package URI or package name (string). More...
 
long getNumExtension (SBaseExtensionPoint extPoint)
 Returns the number of SBMLExtension with the given extension point. More...
 
bool isEnabled (string uri)
 Checks if the extension with the given URI is enabled (true) or disabled (false) More...
 
bool isRegistered (string uri)
 Checks if the extension with the given URI is registered (true) or not (false) More...
 
void removeL2Namespaces (XMLNamespaces xmlns)
 Remove all L2 Extension namespaces from the namespace list. More...
 
bool setEnabled (string uri, bool isEnabled)
 Enable/disable the package with the given uri. More...
 

Static Public Member Functions

static void disablePackage (string package)
 Disables the package with the given URI / name. More...
 
static void disablePackages (SWIGTYPE_p_std__vectorT_std__string_t packages)
 Disables all packages with the given URI / name. More...
 
static void enablePackage (string package)
 Enables the package with the given URI / name. More...
 
static void enablePackages (SWIGTYPE_p_std__vectorT_std__string_t packages)
 Enables all packages with the given URI / name. More...
 
static SBMLExtensionRegistry getInstance ()
 Returns an instance (singleton) of the SBMLExtensionRegistry class. More...
 
static long getNumRegisteredPackages ()
 Returns the number of registered packages. More...
 
static string getRegisteredPackageName (long index)
 Returns the registered package name at the given index. More...
 
static bool isPackageEnabled (string package)
 

Protected Attributes

bool swigCMemOwn
 

Member Function Documentation

int libsbmlcs.SBMLExtensionRegistry.addExtension ( SBMLExtension  ext)

Add the given SBMLExtension to this SBMLExtensionRegistry.

Parameters
extthe SBMLExtension object to be added.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
void libsbmlcs.SBMLExtensionRegistry.addL2Namespaces ( XMLNamespaces  xmlns)

adds all L2 Extension namespaces to the namespace list.

This will call all overridden SBMLExtension::addL2Namespaces methods.

static void libsbmlcs.SBMLExtensionRegistry.disablePackage ( string  package)
static

Disables the package with the given URI / name.

static void libsbmlcs.SBMLExtensionRegistry.disablePackages ( SWIGTYPE_p_std__vectorT_std__string_t  packages)
static

Disables all packages with the given URI / name.

void libsbmlcs.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.

virtual void libsbmlcs.SBMLExtensionRegistry.Dispose ( )
virtual
void libsbmlcs.SBMLExtensionRegistry.enableL2NamespaceForDocument ( SBMLDocument  doc)

Enables all extensions that support serialization / deserialization with SBML Annotations.

static void libsbmlcs.SBMLExtensionRegistry.enablePackage ( string  package)
static

Enables the package with the given URI / name.

static void libsbmlcs.SBMLExtensionRegistry.enablePackages ( SWIGTYPE_p_std__vectorT_std__string_t  packages)
static

Enables all packages with the given URI / name.

SBMLExtension libsbmlcs.SBMLExtensionRegistry.getExtension ( string  package)

Returns an SBMLExtension object with the given package URI or package name (string).

Parameters
packagethe URI or name of the package extension
Returns
a clone of the SBMLExtension object with the given package URI or name. The returned extension is to be freed (i.e.: deleted) by the caller!
static SBMLExtensionRegistry libsbmlcs.SBMLExtensionRegistry.getInstance ( )
static

Returns an instance (singleton) of the SBMLExtensionRegistry class.

This function needs to be invoked when manipulating the SBMLExtensionRegistry class.

Returns
the instance of the SBMLExtensionRegistry object.
long libsbmlcs.SBMLExtensionRegistry.getNumExtension ( SBaseExtensionPoint  extPoint)

Returns the number of SBMLExtension with the given extension point.

Parameters
extPointthe SBaseExtensionPoint
Returns
the number of SBMLExtension with the given extension point.
static long libsbmlcs.SBMLExtensionRegistry.getNumRegisteredPackages ( )
static

Returns the number of registered packages.

Returns
the number of registered packages.
static string libsbmlcs.SBMLExtensionRegistry.getRegisteredPackageName ( long  index)
static

Returns the registered package name at the given index.

Parameters
indexzero based index of the package name to return
Returns
the package name with the given index or null
bool libsbmlcs.SBMLExtensionRegistry.isEnabled ( string  uri)

Checks if the extension with the given URI is enabled (true) or disabled (false)

Parameters
urithe URI of the target package.
Returns
false will be returned if the given package is disabled or not registered, otherwise true will be returned.
static bool libsbmlcs.SBMLExtensionRegistry.isPackageEnabled ( string  package)
static
Returns
the status (enabled = true, disabled = false of the given package.
bool libsbmlcs.SBMLExtensionRegistry.isRegistered ( string  uri)

Checks if the extension with the given URI is registered (true) or not (false)

Parameters
urithe URI of the target package.
Returns
true will be returned if the package with the given URI is registered, otherwise false will be returned.
void libsbmlcs.SBMLExtensionRegistry.removeL2Namespaces ( XMLNamespaces  xmlns)

Remove all L2 Extension namespaces from the namespace list.

This will call all overridden SBMLExtension::removeL2Namespaces methods.

bool libsbmlcs.SBMLExtensionRegistry.setEnabled ( string  uri,
bool  isEnabled 
)

Enable/disable the package with the given uri.

Parameters
urithe URI of the target package.
isEnabledthe bool value corresponding to enabled (true) or disabled (false)
Returns
false will be returned if the given bool value is false or the given package is not registered, otherwise true will be returned.

Member Data Documentation

bool libsbmlcs.SBMLExtensionRegistry.swigCMemOwn
protected