cellml_api::DOMModelLoader Interface Reference

cellml_api::DOMModelLoader Interface Reference

A DOM specific interface for loading a CellML model with more control. More...

Inheritance diagram for cellml_api::DOMModelLoader:
Collaboration diagram for cellml_api::DOMModelLoader:

Public Member Functions

Model createFromDOM (in dom::DOMString url, in DOMURLLoader loader) raises (CellMLException)
 Loads the DOM for the model from the specified URL using the supplied DOMURLLoader.
Model createFromDOMDocument (in dom::Document doc) raises (CellMLException)
 Creates a model around an existing DOM document.
void asyncCreateFromDOM (in dom::DOMString url, in DOMURLLoader loader, in ModelLoadedListener listener) raises (CellMLException)
 Loads the DOM for the model from the specified URL using the supplied DOMURLLoader.
- Public Member Functions inherited from cellml_api::ModelLoader
Model loadFromURL (in dom::DOMString URL) raises (CellMLException)
 Loads a model from the given URL, using the local URL loader.
void asyncLoadFromURL (in dom::DOMString URL, in ModelLoadedListener listener)
 Loads a model from the given URL asynchronously, using the local URL loader.
Model createFromText (in dom::DOMString xmlText) raises (CellMLException)
 Loads a model from a serialised XML document.
- 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 cellml_api::ModelLoader
readonly attribute dom::DOMString lastErrorMessage
 An error message describing the cause of the last CellMLException.

Detailed Description

A DOM specific interface for loading a CellML model with more control.

Definition at line 2111 of file CellML_APISPEC.idl.

Member Function Documentation

void cellml_api::DOMModelLoader::asyncCreateFromDOM ( in dom::DOMString  url,
in DOMURLLoader  loader,
in ModelLoadedListener  listener 
) raises (CellMLException)

Loads the DOM for the model from the specified URL using the supplied DOMURLLoader.

If further URLs need to be loaded (for example, to satisfy imports), the supplied loader will be used.

Parameters
urlThe URL from which to load.
loaderThe URL loader to load the model and any imports needed.
listenerA listener to notify when the model is fully loaded. CellMLException if there is an error loading the model or the DOM document.
Model cellml_api::DOMModelLoader::createFromDOM ( in dom::DOMString  url,
in DOMURLLoader  loader 
) raises (CellMLException)

Loads the DOM for the model from the specified URL using the supplied DOMURLLoader.

If further URLs need to be loaded (for example, to satisfy imports), the supplied loader will be used.

Parameters
urlThe URL from which to load.
loaderThe URL loader to load the model and any imports needed.
Returns
The loaded model. CellMLException if there is an error loading the model or the DOM document.
Model cellml_api::DOMModelLoader::createFromDOMDocument ( in dom::Document  doc) raises (CellMLException)

Creates a model around an existing DOM document.

Parameters
docThe DOM document.
Returns
The model. CellMLException if there is an error creating the model from the DOM document.
Back to Top