This interface is for a 'module manager': a way of managing the modules currently loaded. More...

Inheritance diagram for cellml_context::CellMLModuleManager:

Collaboration diagram for cellml_context::CellMLModuleManager:

Public Member Functions
void	registerModule (in CellMLModule mod)
	Registers a new module.
void	deregisterModule (in CellMLModule mod)
	Deregisters a module.
CellMLModule	findModuleByName (in wstring moduleName, in wstring moduleVersion) raises (cellml_api::CellMLException)
	Finds a module, by name, and optionally version.
void	requestModuleByName (in wstring moduleName, in wstring moduleVersion) raises (cellml_api::CellMLException)
	Requests that a module become available.
void	addMonitor (in CellMLModuleMonitor moduleMonitor)
	Adds a CellMLModuleMonitor.
void	removeMonitor (in CellMLModuleMonitor moduleMonitor)
	Removes a CellMLModuleMonitor.
CellMLModuleIterator	iterateModules ()
	Begins iterating through the modules...
Public Member Functions inherited from XPCOM::IObject
void	add_ref ()
	Called to indicate that some code is keeping an owning reference to the object.
oneway void	release_ref ()
	Removes a reference to an object which was created by some other means (e.g.
IObject	query_interface (in utf8string id)
	Returns an IObject of the same implementation, which supports a specific interface.

Additional Inherited Members
Public Attributes inherited from XPCOM::IObject
readonly attribute string	objid
	Fetches the ID of the object.

Detailed Description

This interface is for a 'module manager': a way of managing the modules currently loaded.

Definition at line 109 of file CellML_Context.idl.

Member Function Documentation

void cellml_context::CellMLModuleManager::addMonitor ( in CellMLModuleMonitor moduleMonitor )

Parameters

moduleMonitor The CellMLModuleMonitor to add.

void cellml_context::CellMLModuleManager::deregisterModule ( in CellMLModule mod )

Deregisters a module.

Does nothing if the tool not registered.

Parameters

mod	The module to deregister.

CellMLModule cellml_context::CellMLModuleManager::findModuleByName	(	in wstring	moduleName,
		in wstring	moduleVersion
	)		raises (cellml_api::CellMLException)

Finds a module, by name, and optionally version.

Return nil of the object could not be found.

Parameters

moduleName	The name of the module.
moduleVersion	The version of the module.

CellMLModuleIterator cellml_context::CellMLModuleManager::iterateModules ( )

Begins iterating through the modules...

void cellml_context::CellMLModuleManager::registerModule ( in CellMLModule mod )

Registers a new module.

Parameters

mod	The new module.

void cellml_context::CellMLModuleManager::removeMonitor ( in CellMLModuleMonitor moduleMonitor )

Does nothing if the CellMLModuleMonitor is not registered to receive events.

Parameters

moduleMonitor The CellMLModuleMonitor to remove.

void cellml_context::CellMLModuleManager::requestModuleByName	(	in wstring	moduleName,
		in wstring	moduleVersion
	)		raises (cellml_api::CellMLException)

Requests that a module become available.

Modules which are configured as being dynamic, and are not currently available, will be launched. If the module is already loaded, does nothing.

Parameters

moduleName	The name of the module to load.
moduleVersion	The version of the module to load. CellMLException If the module is not loaded and not configured. Note that requested module may take some time to start up. The best way to know when it is ready is to use a CellMLModuleMonitor.