cellml_services::BaseUnitInstance Interface Reference

cellml_services::BaseUnitInstance Interface Reference

A reference to a base unit, optionally with a multiplier, offset, and exponent set. More...

Inheritance diagram for cellml_services::BaseUnitInstance:
Collaboration diagram for cellml_services::BaseUnitInstance:

Public Attributes

readonly attribute BaseUnit unit
 The unit being referenced.
readonly attribute double prefix
 The multiplier (including prefix derived multiplier) on the unit.
readonly attribute double offset
 The offset on the unit.
readonly attribute double exponent
 The exponent on the unit.
- Public Attributes inherited from XPCOM::IObject
readonly attribute string objid
 Fetches the ID of the object.

Additional Inherited Members

- 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.

Detailed Description

A reference to a base unit, optionally with a multiplier, offset, and exponent set.

The canonical representation for a units definition (see CanonicalUnitRepresentation) is built from a set of such references.

Definition at line 37 of file CUSES.idl.

Member Data Documentation

readonly attribute double cellml_services::BaseUnitInstance::exponent

The exponent on the unit.

Definition at line 60 of file CUSES.idl.

readonly attribute double cellml_services::BaseUnitInstance::offset

The offset on the unit.

Definition at line 55 of file CUSES.idl.

readonly attribute double cellml_services::BaseUnitInstance::prefix

The multiplier (including prefix derived multiplier) on the unit.

Note: This already takes into account the exponent, no need to raise it to the power of the exponent.

Definition at line 50 of file CUSES.idl.

readonly attribute BaseUnit cellml_services::BaseUnitInstance::unit

The unit being referenced.

Definition at line 43 of file CUSES.idl.