#include <AAX_CParameter.h>

Inheritance diagram for AAX_CParameter< T >:

[legend]

Collaboration diagram for AAX_CParameter< T >:

[legend]

Description

template<typename T>
class AAX_CParameter< T >

Generic implementation of an AAX_IParameter.

This is a concrete, templatized implementation of AAX_IParameter for parameters with standard types such as float, uint32, bool, etc.

Many different behaviors can be composited into this class as delegates. AAX_ITaperDelegate and AAX_IDisplayDelegate are two examples of delegates that this class uses in order to apply custom behaviors to the AAX_IParameter interface.

Plug-in developers can subclass these delegates to create adaptable, reusable parameter behaviors, which can then be "mixed in" to individual AAX_CParameter objects without the need to modify the objects themselves.

Note: Because AAX_CParameter is a C++ template, each AAX_CParameter template parameter that is used creates a new subclass that adheres to the AAX_IParameter interface.

Public Types
enum	Type { eParameterTypeUndefined = 0, eParameterTypeBool = 1, eParameterTypeInt32 = 2, eParameterTypeFloat = 3, eParameterTypeCustom = 4 }

enum	Defaults { eParameterDefaultNumStepsDiscrete = 2, eParameterDefaultNumStepsContinuous = 128, eParemeterDefaultMaxIdentifierSize = 32, eParameterDefaultMaxIdentifierLength = eParemeterDefaultMaxIdentifierSize - 1 }

Public Member Functions
	AAX_CParameter (AAX_CParamID identifier, const AAX_CString &name, T defaultValue, const AAX_ITaperDelegate< T > &taperDelegate, const AAX_IDisplayDelegate< T > &displayDelegate, bool automatable=false)
	Constructs an AAX_CParameter object using the specified taper and display delegates. More...

virtual	~AAX_CParameter ()
	Virtual destructor used to delete all locally allocated pointers. More...

template<>
bool	GetValueAsBool (bool *value) const
	Retrieves the parameter's value as a bool. More...

template<>
bool	GetValueAsInt32 (int32_t *value) const
	Retrieves the parameter's value as an int32_t. More...

template<>
bool	GetValueAsFloat (float *value) const
	Retrieves the parameter's value as a float. More...

template<>
bool	GetValueAsDouble (double *value) const
	Retrieves the parameter's value as a double. More...

template<>
bool	GetValueAsString (AAX_IString *value) const
	Retrieves the parameter's value as a string. More...

template<>
bool	SetValueWithBool (bool value)
	Sets the parameter's value as a bool. More...

template<>
bool	SetValueWithInt32 (int32_t value)
	Sets the parameter's value as an int32_t. More...

template<>
bool	SetValueWithFloat (float value)
	Sets the parameter's value as a float. More...

template<>
bool	SetValueWithDouble (double value)
	Sets the parameter's value as a double. More...

template<>
bool	SetValueWithString (const AAX_IString &value)
	Sets the parameter's value as a string. More...

Identification methods
AAX_CParamID	Identifier () const
	Returns the parameter's unique identifier. More...

void	SetName (const AAX_CString &name)
	Sets the parameter's display name. More...

const AAX_CString &	Name () const
	Returns the parameter's display name. More...

void	AddShortenedName (const AAX_CString &name)
	Sets the parameter's shortened display name. More...

const AAX_CString &	ShortenedName (int32_t iNumCharacters) const
	Returns the parameter's shortened display name. More...

void	ClearShortenedNames ()
	Clears the internal list of shortened display names. More...

Taper methods
void	SetNormalizedDefaultValue (double normalizedDefault)
	Sets the parameter's default value using its normalized representation. More...

double	GetNormalizedDefaultValue () const
	Returns the normalized representation of the parameter's real default value. More...

void	SetToDefaultValue ()
	Restores the state of this parameter to its default value. More...

void	SetNormalizedValue (double normalizedNewValue)
	Sets a parameter value using it's normalized representation. More...

double	GetNormalizedValue () const
	Returns the normalized representation of the parameter's current real value. More...

void	SetNumberOfSteps (uint32_t numSteps)
	Sets the number of discrete steps for this parameter. More...

uint32_t	GetNumberOfSteps () const
	Returns the number of discrete steps used by the parameter. More...

uint32_t	GetStepValue () const
	Returns the current step for the current value of the parameter. More...

void	SetStepValue (uint32_t iStep)
	Returns the current step for the current value of the parameter. More...

void	SetType (AAX_EParameterType iControlType)
	Sets the type of this parameter. More...

AAX_EParameterType	GetType () const
	Returns the type of this parameter as an AAX_EParameterType. More...

void	SetOrientation (AAX_EParameterOrientation iOrientation)
	Sets the orientation of this parameter. More...

AAX_EParameterOrientation	GetOrientation () const
	Returns the orientation of this parameter. More...

Display methods
bool	GetValueString (AAX_CString *valueString) const
	Serializes the parameter value into a string. More...

bool	GetValueString (int32_t iMaxNumChars, AAX_CString *valueString) const
	Serializes the parameter value into a string, size hint included. More...

bool	GetNormalizedValueFromString (const AAX_CString &valueString, double *normalizedValue) const
	Converts a given string to a normalized parameter value. More...

bool	GetStringFromNormalizedValue (double normalizedValue, AAX_CString &valueString) const
	Converts a normalized parameter value to a string representing the corresponding real value. More...

bool	GetStringFromNormalizedValue (double normalizedValue, int32_t iMaxNumChars, AAX_CString &valueString) const
	Converts a normalized parameter value to a string representing the corresponding real, size hint included. value. More...

bool	SetValueFromString (const AAX_CString &newValueString)
	Converts a string to a real parameter value and sets the parameter to this value. More...

Automation methods
void	SetAutomationDelegate (AAX_IAutomationDelegate *iAutomationDelegate)
	Sets the automation delegate (if one is required) More...

bool	Automatable () const
	Returns true if the parameter is automatable, false if it is not. More...

void	Touch ()
	Signals the automation system that a control has been touched. More...

void	Release ()
	Signals the automation system that a control has been released. More...

Typed accessors
bool	GetValueAsBool (bool *value) const
	Retrieves the parameter's value as a bool. More...

bool	GetValueAsInt32 (int32_t *value) const
	Retrieves the parameter's value as an int32_t. More...

bool	GetValueAsFloat (float *value) const
	Retrieves the parameter's value as a float. More...

bool	GetValueAsDouble (double *value) const
	Retrieves the parameter's value as a double. More...

bool	GetValueAsString (AAX_IString *value) const
	Retrieves the parameter's value as a string. More...

bool	SetValueWithBool (bool value)
	Sets the parameter's value as a bool. More...

bool	SetValueWithInt32 (int32_t value)
	Sets the parameter's value as an int32_t. More...

bool	SetValueWithFloat (float value)
	Sets the parameter's value as a float. More...

bool	SetValueWithDouble (double value)
	Sets the parameter's value as a double. More...

bool	SetValueWithString (const AAX_IString &value)
	Sets the parameter's value as a string. More...

Direct methods on AAX_CParameter
These methods can be used to access the parameter's state and properties. These methods are specific to the concrete AAX_CParameter class and are not part of the AAX_IParameter interface.
void	SetValue (T newValue)
	Initiates a host request to set the parameter's value. More...

T	GetValue () const
	Returns the parameter's value. More...

void	SetDefaultValue (T newDefaultValue)
	Set the parameter's default value. More...

T	GetDefaultValue () const
	Returns the parameter's default value. More...

void	SetTaperDelegate (AAX_ITaperDelegateBase &taperDelegate, bool iPreserveValue=true)
	Set the parameter's taper delegate. More...

void	SetDisplayDelegate (AAX_IDisplayDelegateBase &displayDelegate)
	Set the parameter's display delegate. More...

const AAX_ITaperDelegate< T > *	TaperDelegate () const
	Returns a reference to the parameter's taper delegate. More...

const AAX_IDisplayDelegate< T > *	DisplayDelegate () const
	Returns a reference to the parameter's display delegate. More...

Host interface methods
void	UpdateNormalizedValue (double newNormalizedValue)
	Sets the parameter's state given a normalized value. More...

Public Member Functions inherited from AAX_IParameter
virtual	~AAX_IParameter ()
	Virtual destructor. More...

Protected Attributes
char	mIdentifier [eParemeterDefaultMaxIdentifierSize]

AAX_CString	mName

std::map< uint32_t, AAX_CString >	mShortenedNames

bool	mAutomatable

uint32_t	mNumSteps

AAX_EParameterType	mControlType

AAX_EParameterOrientation	mOrientation

AAX_ITaperDelegate< T > *	mTaperDelegate

AAX_IDisplayDelegate< T > *	mDisplayDelegate

AAX_IAutomationDelegate *	mAutomationDelegate

bool	mNeedNotify

T	mValue

T	mDefaultValue

Member Enumeration Documentation

template<typename T >

enum AAX_CParameter::Type

Enumerator
eParameterTypeUndefined
eParameterTypeBool
eParameterTypeInt32
eParameterTypeFloat
eParameterTypeCustom

template<typename T >

enum AAX_CParameter::Defaults

Enumerator
eParameterDefaultNumStepsDiscrete
eParameterDefaultNumStepsContinuous
eParemeterDefaultMaxIdentifierSize
eParameterDefaultMaxIdentifierLength

Constructor & Destructor Documentation

template<typename T >

AAX_CParameter< T >::AAX_CParameter	(	AAX_CParamID	identifier,
		const AAX_CString &	name,
		T	defaultValue,
		const AAX_ITaperDelegate< T > &	taperDelegate,
		const AAX_IDisplayDelegate< T > &	displayDelegate,
		bool	automatable = `false`
	)

Constructs an AAX_CParameter object using the specified taper and display delegates.

The delegates are passed in by reference to prevent ambiguities of object ownership. For more information about identifer and name, please consult the base AAX_IParameter interface.

Parameters

[in]	identifier	Unique ID for the parameter, these can only be 31 characters long at most. (the fixed length is a requirement for some optimizations in the host)
[in]	name	The parameter's unabbreviated display name
[in]	defaultValue	The parameter's default value
[in]	taperDelegate	A delegate representing the parameter's taper behavior
[in]	displayDelegate	A delegate representing the parameter's display conversion behavior
[in]	automatable	A flag to set whether the parameter will be visible to the host's automation system

Note: Upon construction, the state (value) of the parameter will be the default value, as established by the provided taperDelegate.

Host Compatibility Notes:

As of Pro Tools 10.2, DAE will check for a matching parameter NAME and not an ID when reading in automation data from a session saved with an AAX plug-ins RTAS/TDM counter part.

As of Pro Tools 11.1, AAE will first try to match ID. If that fails, AAE will fall back to matching by Name.

References AAX_ASSERT, AAX_eParameterType_Continuous, AAX_eParameterType_Discrete, AAX_CParameter< T >::eParameterDefaultMaxIdentifierLength, AAX_CParameter< T >::eParameterDefaultNumStepsContinuous, AAX_CParameter< T >::eParameterDefaultNumStepsDiscrete, AAX_CParameter< T >::eParemeterDefaultMaxIdentifierSize, AAX_CParameter< T >::mControlType, AAX_CParameter< T >::mIdentifier, AAX_CParameter< T >::mNumSteps, AAX_CParameter< T >::SetNumberOfSteps(), and AAX_CParameter< T >::SetToDefaultValue().

Here is the call graph for this function:

template<typename T >

AAX_CParameter< T >::~AAX_CParameter ( )

virtual

Virtual destructor used to delete all locally allocated pointers.

Member Function Documentation

template<typename T >

AAX_CParamID AAX_CParameter< T >::Identifier ( ) const

virtual

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.

true	The string conversion was successful
false	The string conversion was unsuccessful

[in]	iMaxNumChars	A size hint for the size of the string being requested. Useful for control surfaces and other limited area text fields. (make sure that size of desired string also has room for null termination)
[out]	valueString	A string representing the parameter's real value

[in]	valueString	A string representing a possible real value for the parameter
[out]	normalizedValue	The normalized parameter value associated with valueString

[in]	normalizedValue	A normalized parameter value
[out]	valueString	A string representing the parameter value associated with normalizedValue

true	The conversion to bool was successful
false	The conversion to bool was unsuccessful

true	The conversion to int32_t was successful
false	The conversion to int32_t was unsuccessful

true	The conversion to float was successful
false	The conversion to float was unsuccessful

true	The conversion to double was successful
false	The conversion to double was unsuccessful

true	The conversion to string was successful
false	The conversion to string was unsuccessful

true	The conversion from bool was successful
false	The conversion from bool was unsuccessful

true	The conversion from int32_t was successful
false	The conversion from int32_t was unsuccessful

true	The conversion from float was successful
false	The conversion from float was unsuccessful

true	The conversion from double was successful
false	The conversion from double was unsuccessful

true	The conversion from string was successful
false	The conversion from string was unsuccessful

[in]	taperDelegate	A reference to the parameter's new taper delegate
[in]	iPreserveValue

Description

template<typename T> class AAX_CParameter< T >

Public Types

Public Member Functions

Protected Attributes

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename T>
class AAX_CParameter< T >