RealParameterUnit Property

Gets and sets the dimensional unit for the parameter.

Definition

Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
C#Request Example
[BrowsableAttribute(true)]
public string Unit { get; set; }

Property Value

String
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

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

See Also