CellML API
SRuS::SEDMLProcessor Interface Reference
This interface represents the SEDMLProcessor. More...
Public Member Functions | |
| boolean | supportsModellingLanguage (in wstring aNSURI) |
| Queries whether or not this SEDMLProcessor supports the specified modelling language. | |
| TransformedModel | buildOneModel (in SProS::Model aModel) |
| Takes a SED-ML model reference, and produces a transformed model in accordance with the instructions in the SED-ML model element. | |
| TransformedModelSet | buildAllModels (in SProS::SEDMLElement aElement) |
| Produces a set of all transformed models from a SEDML Element. | |
| void | generateData (in TransformedModelSet aSet, in SProS::SEDMLElement aElement, in GeneratedDataMonitor aMonitor) |
| Runs all the tasks described in the SED-ML description, and applies the DataGenerators described to them to produce a set of generated data. | |
 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 represents the SEDMLProcessor.
A SEDMLProcessor holds a registry of modelling languages, but presents a consistent interface to the user regardless of the underlying languages being used. Future versions are likely to allow new modelling languages to be added to the registry by the user.
Member Function Documentation
| TransformedModelSet SRuS::SEDMLProcessor::buildAllModels | ( | in SProS::SEDMLElement | aElement | ) |
Produces a set of all transformed models from a SEDML Element.
| TransformedModel SRuS::SEDMLProcessor::buildOneModel | ( | in SProS::Model | aModel | ) |
Takes a SED-ML model reference, and produces a transformed model in accordance with the instructions in the SED-ML model element.
| void SRuS::SEDMLProcessor::generateData | ( | in TransformedModelSet | aSet, |
| in SProS::SEDMLElement | aElement, | ||
| in GeneratedDataMonitor | aMonitor | ||
| ) |
Runs all the tasks described in the SED-ML description, and applies the DataGenerators described to them to produce a set of generated data.
Will optionally generates data asynchronously. Implementations which do not have the capability for asynchronous computation may simply invoke progress() and done() on the monitor when the computation is complete (or failure if there was an error), and then return from generateData. Implementations which support asynchronous computation should return from this function immediately, and start streaming results back to the caller via aMonitor.
| boolean SRuS::SEDMLProcessor::supportsModellingLanguage | ( | in wstring | aNSURI | ) |
Queries whether or not this SEDMLProcessor supports the specified modelling language.
The URI aNSURI should be unique to the language, and for XML-based languages that use unique namespaces, will be the main XML namespace associated with the language.