| AAX SDK 2.8.0 Avid Audio Extensions Development Kit

- Welcome
- Manual
- Classes
- Files
- Lists
- Support

Loading...
Searching...
No Matches
Classes | Documents
Display delegates
AAX SDK Manual » AAX Library features » Parameter Manager

##

Classes for parameter value string conversion.

Display delegates are used to convert real parameter values to and from their formatted string representations. All display delegates implement the AAX_IDisplayDelegate interface, which contains two conversion functions:

virtual bool ValueToString(T value, std::string& valueString) const = 0;
virtual bool StringToValue(const std::string& valueString, T& value) const = 0;

# Display delegate decorators

The AAX SDK utilizes a decorator pattern in order to provide code re-use while accounting for a wide variety of possible parameter display formats. The SDK includes a number of sample display delegate decorator classes.

Each concrete display delegate decorator implements AAX_IDisplayDelegateDecorator and adheres to the decorator pattern. The decorator pattern allows multiple display behaviors to be composited or wrapped together at run time. For instance it is possible to implement a dBV (dB Volts) decorator, by wrapping an AAX_CDecibelDisplayDelegateDecorator with an AAX_CUnitDisplayDelegateDecorator.

## Display delegate decorator implementation

By implementing AAX_IDisplayDelegateDecorator, each concrete display delegate decorator class implements the full AAX_IDisplayDelegate interface. In addition, it retains a pointer to the AAX_IDisplayDelegateDecorator that it wraps. When the decorator performs a conversion, it calls into its wrapped class so that the wrapped decorator may apply its own conversion formatting. By repeating this pattern in each decorator, all of the decorator subclasses call into their "wrapper" in turn, resulting in a final string to which all of the decorators' conversions have been applied in sequence.

Here is the relevant implementation from AAX_IDisplayDelegateDecorator :

template <typename T>
AAX_IDisplayDelegateDecorator<T>::AAX_IDisplayDelegateDecorator(const AAX_IDisplayDelegate<T>& displayDelegate) :
AAX_IDisplayDelegate<T>(),
mWrappedDisplayDelegate(displayDelegate.Clone())
{
}
template <typename T>
bool AAX_IDisplayDelegateDecorator<T>::ValueToString(T value, AAX_CString* valueString) const
{
return mWrappedDisplayDelegate->ValueToString(value, valueString);
}
template <typename T>
bool AAX_IDisplayDelegateDecorator<T>::StringToValue(const AAX_CString& valueString, T* value) const
{
return mWrappedDisplayDelegate->StringToValue(valueString, value);
}
AAX_CString
A generic AAX string class with similar functionality to std::string
Definition: AAX_CString.h:57
AAX_IDisplayDelegate
Definition: AAX_IDisplayDelegate.h:79
AAX_IDisplayDelegateDecorator
The base class for all concrete display delegate decorators.
Definition: AAX_IDisplayDelegateDecorator.h:54
AAX_IDisplayDelegateDecorator::StringToValue
bool StringToValue(const AAX_CString &valueString, T *value) const AAX_OVERRIDE
Converts a string to a real parameter value.
Definition: AAX_IDisplayDelegateDecorator.h:207
AAX_IDisplayDelegateDecorator::ValueToString
bool ValueToString(T value, AAX_CString *valueString) const AAX_OVERRIDE
Converts a string to a real parameter value.
Definition: AAX_IDisplayDelegateDecorator.h:195

## Decibel decorator example

Here is a concrete example of how a decibel decorator might be implemented

template <typename T>
bool AAX_CDecibelDisplayDelegateDecorator<T>::ValueToString(T value, AAX_CString* valueString) const
{
if (value <= 0)
{
*valueString = AAX_CString("--- dB");
return true;
}
value = 20*log10(value);
bool succeeded = AAX_IDisplayDelegateDecorator<T>::ValueToString(value, valueString);
*valueString += AAX_CString("dB");
return succeeded;
}
AAX_CDecibelDisplayDelegateDecorator::ValueToString
bool ValueToString(T value, AAX_CString *valueString) const AAX_OVERRIDE
Converts a real parameter value to a string representation.
Definition: AAX_CDecibelDisplayDelegateDecorator.h:97

Notice in this example that the ValueToString() method is called in the parent class, AAX_IDisplayDelegateDecorator. This results in a call into the wrapped class' implementation of ValueToString(), which converts the decorated value to a redecorated string, and so forth for additional decorators.

## Classes
class | AAX_IDisplayDelegateBase
| Defines the display behavior for a parameter. More...
class | AAX_IDisplayDelegate< T >

## Documents
| Display delegate decorators
| Classes for adapting parameter value strings.

Collaboration diagram for Display delegates: