CellML API
cellml_services::CUSES Interface Reference
cellml_services::CUSES Interface Reference
The primary interface to units processing services for a model. More...
Inheritance diagram for cellml_services::CUSES:
Collaboration diagram for cellml_services::CUSES:
Public Member Functions | |
| CanonicalUnitRepresentation | getUnitsByName (in cellml_api::CellMLElement aContext, in wstring aName) |
| Gets a units representation for a string (giving the name of the units) in a given context. | |
| CanonicalUnitRepresentation | createEmptyUnits () |
| Creates an empty CanonicalUnitRepresentation, which may be used by code which wants to compare units in the model with synthesised units. | |
 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 | modelError |
| A description of any units errors found in the model (CUSES does not perform a complete validation, but can incidentally find some errors as it performs its normal operations). | |
| Public Attributes inherited from XPCOM::IObject | |
| readonly attribute string | objid |
| Fetches the ID of the object. | |
Detailed Description
The primary interface to units processing services for a model.
Member Function Documentation
| CanonicalUnitRepresentation cellml_services::CUSES::createEmptyUnits | ( | ) |
Creates an empty CanonicalUnitRepresentation, which may be used by code which wants to compare units in the model with synthesised units.
| CanonicalUnitRepresentation cellml_services::CUSES::getUnitsByName | ( | in cellml_api::CellMLElement | aContext, |
| in wstring | aName | ||
| ) |
Gets a units representation for a string (giving the name of the units) in a given context.
- Parameters
-
context The context. This must be part of the model (or part of an imported model) for which this object was created. It can be any element in the model, but would generally be a component, units, or model element. name The units name to look up. This can be a built-in unit, or a user-defined unit.
- Returns
- The units representation, or null if the name is invalid.
Member Data Documentation
| readonly attribute wstring cellml_services::CUSES::modelError |
A description of any units errors found in the model (CUSES does not perform a complete validation, but can incidentally find some errors as it performs its normal operations).
If no error is found, this will be the empty string. The results of any other operation on this object is undefined if there is an error, and so should not be called.