An
activity which performs unit conversion by calling the OpenSpirit unit
service . Activity
An
activity which performs unit conversion by calling the OpenSpirit unit
service .
OpenSpirit Unit Conversion Configuration Fields
There is no need to configure this activity.
| Field | Global Var? | Optional? | Description |
| Name | No | No | User assigned name given to activity |
| Description | No | Yes | User assigned description (optional) |
| Input Item | Datatype | Description |
| Parameters | Complex | Root element for all input elements |
| TargetUnit | OspUnit | The unit that the input should be converted to. This must have the same base unit as the input unit(s). E.g. one can convert from feet to meters but not from feet to seconds. |
| FloatNullValue | float | An optional input used to specify what float value should be consider to represent a null value. Null values will NOT be unit converted. |
| FloatUnit | OspUnit
|
If FloatValues is specified then this must be provided to specify the unit of input float values. |
| FloatValues | Complex
(repeating float) |
A repeating sequence of float values to be converted. |
| DoubleNullValue | double | An optional input used to specify what double value should be consider to represent a null value. Null values will NOT be unit converted. |
| DoubleUnit | OspUnit
|
If DoubleValues is specified then this must be provided to specify the unit of input double values. |
| DoubleValues | Complex
(repeating double) |
A repeating sequence of double values to be converted. |
FloatQuantity |
OspFloatQuantity | An OpenSpirit FloatQuantity ( float value plus unit) to be converted. |
DoubleQuantity |
OspDoubleQuantity | An OpenSpirit DoubleQuantity ( float value plus unit) to be converted. |
FloatQuantitySeries |
OspFloatQuantitySeries | An OpenSpirit FloatQuantitySeries ( float values plus unit and optional null value) to be converted. |
DoubleQuantitySeries |
OspDoubleQuantitySeries | An OpenSpirit DoubleQuantitySeries ( double values plus unit and optional null value) to be converted. |
The output for this activity mirrors the input but all supplied input values have now been converted to the TargetUnit and all units are now equal to the TargetUnit.
| Output Item | Datatype | Description |
| OspOutput | Complex | Root element for all output elements |
| TargetUnit | OspUnit | The unit that all inputs have been be converted to. |
| FloatNullValue | float | Float value that is to be considered a null value (only present id supplied in input) |
| FloatValues | Complex
(repeating float elements) |
A repeating sequence of float values (if supplied in input) converted to TargetUnit |
| DoubleNullValue | double | Double value that is to be considered a null value (only present if supplied in input) |
| DoubleValues | Complex
(repeating double elements) |
A repeating sequence of double values (if supplied in input) converted to TargetUnit |
FloatQuantity |
OspFloatQuantity | An OpenSpirit FloatQuantity ( float value plus unit) that has been converted to the TargetUnit (only present if supplied in input) |
DoubleQuantity |
OspDoubleQuantity | An OpenSpirit DoubleQuantity ( double value plus unit) that has been converted to the TargetUnit (only present if supplied in input) |
FloatQuantitySeries |
OspFloatQuantitySeries | An OpenSpirit FloatQuantitySeries ( float values plus unit and optional null value )that has been converted to the TargetUnit (only present if supplied in input) |
DoubleQuantitySeries |
OspDoubleQuantitySeries | An OpenSpirit DoubleQuantitySeries ( double values plus unit and optional null value) that has been converted to the TargetUnit (only present if supplied in input) |
The Error Output tab lists the possible exceptions that can be thrown by this activity.
| Exception | Thrown When ... |
OspException msg msgCode |
The unit conversion could
not be successfully performed.
The msg element should contain some indication of the reason. The error code (see list of possible codes) |