CellML API
cellml_api::CellMLBootstrap Interface Reference
A DOM specific interface that provides everything an application needs to bootstrap the CellML API. More...
Public Member Functions | |
| Model | createModel (in wstring version) |
| Creates a new, empty, model. | |
| dom::DOMString | serialiseNode (in dom::Node node) |
| Serialises a DOM node into a string. | |
| wstring | makeURLAbsolute (in wstring relTo, in wstring relURL) |
| Tries to make a relative URL absolute, using a URL specifying what the URL is relative to. | |
 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. | |
Public Attributes | |
| readonly attribute DOMModelLoader | modelLoader |
| The model loader used to load models. | |
| readonly attribute dom::DOMImplementation | domImplementation |
| The local DOMImplementation. | |
| readonly attribute DOMURLLoader | localURLLoader |
| The local URL loader. | |
| Public Attributes inherited from XPCOM::IObject | |
| readonly attribute string | objid |
| Fetches the ID of the object. | |
| readonly attribute interface_list | supported_interfaces |
| Fetches all supported interfaces. | |
Detailed Description
A DOM specific interface that provides everything an application needs to bootstrap the CellML API.
Definition at line 2200 of file CellML_APISPEC.idl.
Member Function Documentation
| Model cellml_api::CellMLBootstrap::createModel | ( | in wstring | version | ) |
Creates a new, empty, model.
- Parameters
-
version The version of the new model. This currently must be 1.0 or 1.1.
| wstring cellml_api::CellMLBootstrap::makeURLAbsolute | ( | in wstring | relTo, |
| in wstring | relURL | ||
| ) |
Tries to make a relative URL absolute, using a URL specifying what the URL is relative to.
- Parameters
-
relTo The absolute URL to evaluate relative to. relURL A possibly relative URL to make absolute.
- Returns
- An absolute URL, if it is possible to produce one, otherwise a relative one.
| dom::DOMString cellml_api::CellMLBootstrap::serialiseNode | ( | in dom::Node | node | ) |
Serialises a DOM node into a string.
The node to serialise must have originated from the locally hosted DOM implementation.
- Parameters
-
node The DOM node to serialise.
- Returns
- The node, as a serialised string.
Member Data Documentation
| readonly attribute dom::DOMImplementation cellml_api::CellMLBootstrap::domImplementation |
The local DOMImplementation.
This may not always be available, and when it isn't, nil should be returned.
Definition at line 2212 of file CellML_APISPEC.idl.
| readonly attribute DOMURLLoader cellml_api::CellMLBootstrap::localURLLoader |
The local URL loader.
This may not always be available, and when it isn't, nil should be returned.
Definition at line 2218 of file CellML_APISPEC.idl.
| readonly attribute DOMModelLoader cellml_api::CellMLBootstrap::modelLoader |
The model loader used to load models.
Definition at line 2206 of file CellML_APISPEC.idl.