CellML API
cellml_services::MaLaESResult Interface Reference
An interface allowing transformation results to be described. More...
Public Member Functions | |
| wstring | getSupplementary (in unsigned long index) raises (cellml_api::CellMLException) |
| Fetches a supplementary block by the index. | |
| cellml_api::CellMLVariableIterator | iterateInvolvedVariables () |
| Iterates through the list of 'source' variables which are involved in this result. | |
| DegreeVariableIterator | iterateInvolvedVariablesByDegree () |
| Iterates through the list of 'source' variables annotated by their degree (0 = used as a non-derivative, 1 = used as a first order derivative, ...)... | |
| cellml_api::CellMLVariableIterator | iterateBoundVariables () |
| Iterates through the list of 'source' variables which are used as a globally bound variable in this result. | |
| cellml_api::CellMLVariableIterator | iterateLocallyBoundVariables () |
| Iterates through the list of 'source' variables which are used as a locally bound variable in this result. | |
| unsigned long | getDiffDegree (in cellml_api::CellMLVariable aVar) |
| Retrieves the highest degree on any diff application / binding. | |
 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 wstring | compileErrors |
| A string listing any errors that occurred. | |
| readonly attribute wstring | expression |
| The primary expression, in the transformed to language. | |
| readonly attribute unsigned long | supplementariesLength |
| The number of supplementary blocks defined. | |
| readonly attribute boolean | involvesExternalCode |
| True if the expression concerned involves external code. | |
| Public Attributes inherited from XPCOM::IObject | |
| readonly attribute string | objid |
| Fetches the ID of the object. | |
Detailed Description
An interface allowing transformation results to be described.
Definition at line 66 of file MaLaES.idl.
Member Function Documentation
| unsigned long cellml_services::MaLaESResult::getDiffDegree | ( | in cellml_api::CellMLVariable | aVar | ) |
Retrieves the highest degree on any diff application / binding.
- Parameters
-
aVar The variable to look up.
| wstring cellml_services::MaLaESResult::getSupplementary | ( | in unsigned long | index | ) | raises (cellml_api::CellMLException) |
Fetches a supplementary block by the index.
- Parameters
-
index The zero based index of the block to fetch. CellMLException if the index is out of range.
| cellml_api::CellMLVariableIterator cellml_services::MaLaESResult::iterateBoundVariables | ( | ) |
Iterates through the list of 'source' variables which are used as a globally bound variable in this result.
Globally bound variables are those which are bound across the entire model (e.g. time). Locally bound variables, such as those used inside definite integrals, are not included in this set. Be aware that this only works if the lookupDiffVariable command is used in the MAL specification.
| cellml_api::CellMLVariableIterator cellml_services::MaLaESResult::iterateInvolvedVariables | ( | ) |
Iterates through the list of 'source' variables which are involved in this result.
| DegreeVariableIterator cellml_services::MaLaESResult::iterateInvolvedVariablesByDegree | ( | ) |
Iterates through the list of 'source' variables annotated by their degree (0 = used as a non-derivative, 1 = used as a first order derivative, ...)...
| cellml_api::CellMLVariableIterator cellml_services::MaLaESResult::iterateLocallyBoundVariables | ( | ) |
Iterates through the list of 'source' variables which are used as a locally bound variable in this result.
Locally bound variables are those which are bound within a single expression (e.g. definite integrals). Globally bound variables, e.g. time in a time-varying model, are not included in this set. Be aware that this only works if the bvarIndex command is used in the MAL specification.
Member Data Documentation
| readonly attribute wstring cellml_services::MaLaESResult::compileErrors |
A string listing any errors that occurred.
Applications should always check this attribute, and if it is set to a non-empty string, should not attempt to use any other operations or attributes on this interface.
Definition at line 74 of file MaLaES.idl.
| readonly attribute wstring cellml_services::MaLaESResult::expression |
The primary expression, in the transformed to language.
Definition at line 79 of file MaLaES.idl.
| readonly attribute boolean cellml_services::MaLaESResult::involvesExternalCode |
True if the expression concerned involves external code.
Definition at line 138 of file MaLaES.idl.
| readonly attribute unsigned long cellml_services::MaLaESResult::supplementariesLength |
The number of supplementary blocks defined.
Definition at line 84 of file MaLaES.idl.