Library | Module

Interface IpfcParamValue



Description

This class describes the value of the parameter.

This determines the type of parameter.



Union Discriminant

Propertydiscras IpfcParamValueType [readonly] 
Returns the union discriminant value.





Property Summary

PropertyBoolValueas Boolean
If the parameter type is PARAM_BOOLEAN, this is a Boolean value.
PropertyDoubleValueas Double
If the parameter type is PARAM_DOUBLE, this is a double value.
PropertyIntValueas Long
If the parameter type is PARAM_INTEGER, this is an integer value.
PropertyNoteIdas Long
If the parameter type is PARAM_NOTE, this is a note identifier.
PropertyStringValueas String
If the parameter type is PARAM_STRING, this is a string value.



Union Discriminant


Propertydiscras IpfcParamValueType [readonly] 

Returns the union discriminant value.




Property Detail


PropertyBoolValueas Boolean

If the parameter type is PARAM_BOOLEAN, this is a Boolean value.

Exceptions thrown (but not limited to):

IpfcXBadGetParamValue - Parameter value is not boolean






PropertyDoubleValueas Double

If the parameter type is PARAM_DOUBLE, this is a double value.

Exceptions thrown (but not limited to):

IpfcXBadGetParamValue - Parameter value is not double






PropertyIntValueas Long

If the parameter type is PARAM_INTEGER, this is an integer value.

Exceptions thrown (but not limited to):

IpfcXBadGetParamValue - Parameter value is not an integer






PropertyNoteIdas Long

If the parameter type is PARAM_NOTE, this is a note identifier.

Exceptions thrown (but not limited to):

IpfcXBadGetParamValue - Parameter value is not a note identifier






PropertyStringValueas String

If the parameter type is PARAM_STRING, this is a string value.

Exceptions thrown (but not limited to):

IpfcXBadGetParamValue - Parameter value is not string