Cape Thermo Material WrapperGet Universal Constant Method
Retrieves the value of a Universal Constant.
Definition
Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
Value of Universal Constant. This could be a numeric or a string value. For numeric values the units of measurement are specified in section 7.5.1.
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
C#
private double GetUniversalConstant(
string constantId
)VB
Private Function GetUniversalConstant (
constantId As String
) As DoubleParameters
- constantId String
- Identifier of Universal Constant. The list of constants supported should be obtained by using the GetUniversalConstList method.
Return Value
DoubleValue of Universal Constant. This could be a numeric or a string value. For numeric values the units of measurement are specified in section 7.5.1.
Remarks
Universal Constants (often called fundamental constants) are
quantities like the gas constant, or the Avogadro constant.
Exceptions
| ECapeNoImpl | The operation GetUniversalConstant is “not” implemented even if this method can be called for reasons of compatibility with the CAPE-OPEN standards. That is to say that the operation exists, but it is not supported by the current implementation. |
| ECapeInvalidArgument | For example, UNDEFINED for constantId argument is used, or value for constantId argument does not belong to the list of recognised values. |
| ECapeUnknown | The error to be raised when other error(s), specified for the GetUniversalConstant operation, are not suitable. |