Library | Module

Class pfcParamValue



Description

This class describes the value of the parameter.

This determines the type of parameter.



Union Discriminant

/* readonly */ pfcParamValueTypediscr
Returns the union discriminant value.





Property Summary

booleanBoolValue
If the parameter type is PARAM_BOOLEAN, this is a Boolean value.
numberDoubleValue
If the parameter type is PARAM_DOUBLE, this is a double value.
numberIntValue
If the parameter type is PARAM_INTEGER, this is an integer value.
numberNoteId
If the parameter type is PARAM_NOTE, this is a note identifier.
stringStringValue
If the parameter type is PARAM_STRING, this is a string value.



Union Discriminant


/* readonly */ pfcParamValueTypediscr

Returns the union discriminant value.




Property Detail


booleanBoolValue

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

Exceptions thrown (but not limited to):

pfcXBadGetParamValue - Parameter value is not boolean






numberDoubleValue

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

Exceptions thrown (but not limited to):

pfcXBadGetParamValue - Parameter value is not double






numberIntValue

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

Exceptions thrown (but not limited to):

pfcXBadGetParamValue - Parameter value is not an integer






numberNoteId

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

Exceptions thrown (but not limited to):

pfcXBadGetParamValue - Parameter value is not a note identifier






stringStringValue

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

Exceptions thrown (but not limited to):

pfcXBadGetParamValue - Parameter value is not string