libsbml.SBMLExtensionRegistry Class Reference

Inheritance diagram for libsbml.SBMLExtensionRegistry:

Detailed Description

{core}

Registry class in which extension packages are registered.

Public Member Functions
def	addExtension
def	addL2Namespaces
def	disablePackage
def	disableUnusedPackages
def	enableL2NamespaceForDocument
def	enablePackage
def	getExtension
def	getInstance
def	getNumExtension
def	getNumRegisteredPackages
def	getRegisteredPackageName
def	isEnabled
def	isPackageEnabled
def	isRegistered
def	removeL2Namespaces
def	setEnabled

Member Function Documentation

def libsbml.SBMLExtensionRegistry.addExtension	(		self,
			args
	)

Python method signature(s):

addExtension(SBMLExtensionRegistry self, SBMLExtension ext)   int

Add the given SBMLExtension to this SBMLExtensionRegistry.

Parameters

ext	the SBMLExtension object to be added.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_PKG_CONFLICT
• LIBSBML_INVALID_ATTRIBUTE_VALUE

def libsbml.SBMLExtensionRegistry.addL2Namespaces	(		self,
			args
	)

Python method signature(s):

addL2Namespaces(SBMLExtensionRegistry self, XMLNamespaces xmlns)

adds all L2 Extension namespaces to the namespace list. This will call all overriden SBMLExtension::addL2Namespaces methods.

def libsbml.SBMLExtensionRegistry.disablePackage

(

args

)

Python method signature(s):

disablePackage(string package)

Disables the package with the given URI / name.

def libsbml.SBMLExtensionRegistry.disableUnusedPackages	(		self,
			args
	)

Python method signature(s):

disableUnusedPackages(SBMLExtensionRegistry self, SBMLDocument doc)

Goes through all extensions in the list of plugins of the given document and disables all plugins that are not being used.

def libsbml.SBMLExtensionRegistry.enableL2NamespaceForDocument	(		self,
			args
	)

Python method signature(s):

enableL2NamespaceForDocument(SBMLExtensionRegistry self, SBMLDocument doc)

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

def libsbml.SBMLExtensionRegistry.enablePackage

(

args

)

Python method signature(s):

enablePackage(string package)

Enables the package with the given URI / name.

def libsbml.SBMLExtensionRegistry.getExtension	(		self,
			args
	)

Python method signature(s):

getExtension(SBMLExtensionRegistry self, string package)   SBMLExtension

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

Parameters

package

the 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!

def libsbml.SBMLExtensionRegistry.getInstance

(

)

{core}

Registry class in which extension packages are registered. Python method signature(s):

getInstance()   SBMLExtensionRegistry

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.

def libsbml.SBMLExtensionRegistry.getNumExtension	(		self,
			args
	)

Python method signature(s):

getNumExtension(SBMLExtensionRegistry self, SBaseExtensionPoint extPoint)   long

Returns the number of SBMLExtension with the given extension point.

Parameters

extPoint

the SBaseExtensionPoint

Returns

the number of SBMLExtension with the given extension point.

def libsbml.SBMLExtensionRegistry.getNumRegisteredPackages

(

)

Python method signature(s):

getNumRegisteredPackages()   long

Returns the number of registered packages.

Returns

the number of registered packages.

def libsbml.SBMLExtensionRegistry.getRegisteredPackageName

(

args

)

Python method signature(s):

getRegisteredPackageName(long index)   string

Returns the registered package name at the given index

Parameters

index

zero based index of the package name to return

Returns

the package name with the given index or None

def libsbml.SBMLExtensionRegistry.isEnabled	(		self,
			args
	)

Python method signature(s):

isEnabled(SBMLExtensionRegistry self, string uri)   bool

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

Parameters

uri	the URI of the target package.

Returns

false will be returned if the given package is disabled or not registered, otherwise true will be returned.

def libsbml.SBMLExtensionRegistry.isPackageEnabled

(

args

)

Python method signature(s):

isPackageEnabled(string package)   bool

If the given package is enabled, returns True; otherwise, returns False.

Returns

the status (enabled = true, disabled = false of the given package.

def libsbml.SBMLExtensionRegistry.isRegistered	(		self,
			args
	)

Python method signature(s):

isRegistered(SBMLExtensionRegistry self, string uri)   bool

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

Parameters

uri	the URI of the target package.

Returns

true will be returned if the package with the given URI is registered, otherwise false will be returned.

def libsbml.SBMLExtensionRegistry.removeL2Namespaces	(		self,
			args
	)

Python method signature(s):

removeL2Namespaces(SBMLExtensionRegistry self, XMLNamespaces xmlns)

Remove all L2 Extension namespaces from the namespace list. This will call all overriden SBMLExtension::removeL2Namespaces methods.

def libsbml.SBMLExtensionRegistry.setEnabled	(		self,
			args
	)

Python method signature(s):

setEnabled(SBMLExtensionRegistry self, string uri, bool isEnabled)   bool

Enable/disable the package with the given uri.

Parameters

uri	the URI of the target package.
isEnabled	the 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.