CellML API
cellml_services::CustomGenerator Interface Reference
cellml_services::CustomGenerator Interface Reference
Inheritance diagram for cellml_services::CustomGenerator:
Collaboration diagram for cellml_services::CustomGenerator:
Public Member Functions | |
| ComputationTargetIterator | iterateTargets () |
| Iterates through all computation targets. | |
| void | requestComputation (in ComputationTarget wanted) raises (cellml_api::CellMLException) |
| Requests computation of a particular computation target, if computation is possible. | |
| void | markAsKnown (in ComputationTarget known) |
| Sets a particular computation target as being 'known' (for example, this can be used to set independent variables, or variables which are computed elsewhere in the code). | |
| void | markAsUnwanted (in ComputationTarget unwanted) |
| Sets a particular computation target as being 'unwanted', meaning that it will not be considered as a potential intermediate to compute the requested variables. | |
| CustomCodeInformation | generateCode () |
| Generate the custom code for computing the requested variables. | |
 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
Member Function Documentation
| CustomCodeInformation cellml_services::CustomGenerator::generateCode | ( | ) |
Generate the custom code for computing the requested variables.
| ComputationTargetIterator cellml_services::CustomGenerator::iterateTargets | ( | ) |
Iterates through all computation targets.
| void cellml_services::CustomGenerator::markAsKnown | ( | in ComputationTarget | known | ) |
Sets a particular computation target as being 'known' (for example, this can be used to set independent variables, or variables which are computed elsewhere in the code).
CellMLException if ComputationTarget not in target set.
| void cellml_services::CustomGenerator::markAsUnwanted | ( | in ComputationTarget | unwanted | ) |
Sets a particular computation target as being 'unwanted', meaning that it will not be considered as a potential intermediate to compute the requested variables.
CellMLException if ComputationTarget not in target set.
| void cellml_services::CustomGenerator::requestComputation | ( | in ComputationTarget | wanted | ) | raises (cellml_api::CellMLException) |
Requests computation of a particular computation target, if computation is possible.
CellMLException if ComputationTarget not in target set.