RealParameterConvertTo Method

Returns the current value of the parameter in the dimensional unit specified.

Definition

Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)

public double ConvertTo(
	string desiredUnit
)

VBRequest Example

Public Function ConvertTo ( 
	desiredUnit As String
) As Double

Parameters

desiredUnit String: The unit that the parameter is desired to be reported in.

Field Value

Double
The value of the parameter in the requested unit of measurement.

Remarks

The value of the parameter in the unit requested. The unit must be a valid parameter. For example, if the parameter was set as 101325 Pa, if the desiredUnit was "atm" the return value would be 1 (the value of 101325 Pa in atmospheres).

Exceptions

ECapeUnknown	The error to be raised when other error(s), specified for this operation, are not suitable.
ECapeInvalidArgument	To be used when an invalid argument value is passed, for example, an unrecognised unit identifier.