RealParameterConvertToSI Method

Returns the value in the SI unit of the specified unit.

Definition

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

public double ConvertToSI(
	double value,
	string unit
)

VBRequest Example

Public Function ConvertToSI ( 
	value As Double,
	unit As String
) As Double

Parameters

value Double: Reference to a string that will conain a message regarding the validation of the parameter.
unit String: Reference to a string that will conain a message regarding the validation of the parameter.

Field Value

Double
The value of the parameter in SI units.

Remarks

The value is returned in the SI units for the dimensionality of the parameter. For example, if the parameter was set as 1 atm, the return value would be 101325 (the value of 1 atm in the SI pressure unit of Pascals, Pa).

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.