#include <AAX_CParameter.h>
template<typename T>
class AAX_CParameterValue< T >
Concrete implementation of AAX_IParameterValue.
Used by AAX_CParameter
◆ Defaults
Enumerator |
---|
eParemeterDefaultMaxIdentifierSize | |
eParameterDefaultMaxIdentifierLength | |
◆ AAX_CParameterValue() [1/3]
Constructs an AAX_CParameterValue object.
- Parameters
-
[in] | identifier | Unique ID for the parameter value, these can only be 31 characters long at most. (the fixed length is a requirement for some optimizations in the host) |
- Note
- The initial state of the parameter value is undefined
◆ AAX_CParameterValue() [2/3]
Constructs an AAX_CParameterValue object with a defined initial state.
- Parameters
-
[in] | identifier | Unique ID for the parameter value, these can only be 31 characters long at most. (the fixed length is a requirement for some optimizations in the host) |
[in] | value | Initial state of the parameter value |
◆ AAX_CParameterValue() [3/3]
◆ AAX_DEFAULT_DTOR_OVERRIDE()
◆ AAX_DEFAULT_MOVE_CTOR()
◆ AAX_DEFAULT_MOVE_OPER()
◆ AAX_DELETE()
◆ Get()
Direct access to the template instance's value.
◆ Set()
Direct access to the template instance's value.
◆ Clone()
Clones the parameter object.
- Note
- Does NOT set the automation delegate on the clone; ownership of the automation delegate and parameter registration/unregistration stays with the original parameter
Implements AAX_IParameterValue.
◆ Identifier()
Returns the parameter's unique identifier.
This unique ID is used by the Parameter Manager and by outside applications to uniquely identify and target control messages. This value may not be changed after the parameter has been constructed.
Implements AAX_IParameterValue.
◆ GetValueAsBool() [1/2]
Retrieves the parameter's value as a bool.
- Parameters
-
[out] | value | The parameter's real value. Set only if conversion is successful. |
- Return values
-
true | The conversion to bool was successful |
false | The conversion to bool was unsuccessful |
Implements AAX_IParameterValue.
◆ GetValueAsInt32() [1/2]
Retrieves the parameter's value as an int32_t.
- Parameters
-
[out] | value | The parameter's real value. Set only if conversion is successful. |
- Return values
-
true | The conversion to int32_t was successful |
false | The conversion to int32_t was unsuccessful |
Implements AAX_IParameterValue.
◆ GetValueAsFloat() [1/2]
Retrieves the parameter's value as a float.
- Parameters
-
[out] | value | The parameter's real value. Set only if conversion is successful. |
- Return values
-
true | The conversion to float was successful |
false | The conversion to float was unsuccessful |
Implements AAX_IParameterValue.
◆ GetValueAsDouble() [1/2]
Retrieves the parameter's value as a double.
- Parameters
-
[out] | value | The parameter's real value. Set only if conversion is successful. |
- Return values
-
true | The conversion to double was successful |
false | The conversion to double was unsuccessful |
Implements AAX_IParameterValue.
◆ GetValueAsString() [1/2]
Retrieves the parameter's value as a string.
- Parameters
-
[out] | value | The parameter's real value. Set only if conversion is successful. |
- Return values
-
true | The conversion to string was successful |
false | The conversion to string was unsuccessful |
Implements AAX_IParameterValue.
◆ GetValueAsBool() [2/2]
Retrieves the parameter's value as a bool.
- Parameters
-
[out] | value | The parameter's real value. Set only if conversion is successful. |
- Return values
-
true | The conversion to bool was successful |
false | The conversion to bool was unsuccessful |
Implements AAX_IParameterValue.
◆ GetValueAsInt32() [2/2]
Retrieves the parameter's value as an int32_t.
- Parameters
-
[out] | value | The parameter's real value. Set only if conversion is successful. |
- Return values
-
true | The conversion to int32_t was successful |
false | The conversion to int32_t was unsuccessful |
Implements AAX_IParameterValue.
◆ GetValueAsFloat() [2/2]
Retrieves the parameter's value as a float.
- Parameters
-
[out] | value | The parameter's real value. Set only if conversion is successful. |
- Return values
-
true | The conversion to float was successful |
false | The conversion to float was unsuccessful |
Implements AAX_IParameterValue.
◆ GetValueAsDouble() [2/2]
Retrieves the parameter's value as a double.
- Parameters
-
[out] | value | The parameter's real value. Set only if conversion is successful. |
- Return values
-
true | The conversion to double was successful |
false | The conversion to double was unsuccessful |
Implements AAX_IParameterValue.
◆ GetValueAsString() [2/2]
Retrieves the parameter's value as a string.
- Parameters
-
[out] | value | The parameter's real value. Set only if conversion is successful. |
- Return values
-
true | The conversion to string was successful |
false | The conversion to string was unsuccessful |
Implements AAX_IParameterValue.
The documentation for this class was generated from the following file: