#include <AAX_CNumberDisplayDelegate.h>

Inheritance diagram for AAX_CNumberDisplayDelegate< T, Precision, SpaceAfter >:

Collaboration diagram for AAX_CNumberDisplayDelegate< T, Precision, SpaceAfter >:

Description

template<typename T, uint32_t Precision = 2, uint32_t SpaceAfter = 0>
class AAX_CNumberDisplayDelegate< T, Precision, SpaceAfter >

A numeric display format conforming to AAX_IDisplayDelegate.

This display delegate converts a parameter value to a numeric string using a specified precision.

Public Member Functions
AAX_CNumberDisplayDelegate *	Clone () const AAX_OVERRIDE
	Constructs and returns a copy of the display delegate.

bool	ValueToString (T value, AAX_CString *valueString) const AAX_OVERRIDE
	Converts a real parameter value to a string representation.

bool	ValueToString (T value, int32_t maxNumChars, AAX_CString *valueString) const AAX_OVERRIDE
	Converts a real parameter value to a string representation using a size hint, useful for control surfaces and other character limited displays.

bool	StringToValue (const AAX_CString &valueString, T *value) const AAX_OVERRIDE
	Converts a string to a real parameter value.

virtual AAX_IDisplayDelegate *	Clone () const =0
	Constructs and returns a copy of the display delegate.

virtual bool	ValueToString (T value, AAX_CString *valueString) const =0
	Converts a real parameter value to a string representation.

virtual bool	ValueToString (T value, int32_t maxNumChars, AAX_CString *valueString) const =0
	Converts a real parameter value to a string representation using a size hint, useful for control surfaces and other character limited displays.

virtual bool	StringToValue (const AAX_CString &valueString, T *value) const =0
	Converts a string to a real parameter value.

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

Member Function Documentation

◆ Clone()

template<typename T , uint32_t Precision, uint32_t SpaceAfter>

AAX_CNumberDisplayDelegate< T, Precision, SpaceAfter > * AAX_CNumberDisplayDelegate< T, Precision, SpaceAfter >::Clone ( ) const

virtual

Constructs and returns a copy of the display delegate.

In general, this method's implementation can use a simple copy constructor:

template <typename T>
AAX_CSubclassDisplayDelegate<T>*    AAX_CSubclassDisplayDelegate<T>::Clone() const
{
    return new AAX_CSubclassDisplayDelegate(*this);
}

Implements AAX_IDisplayDelegate< T >.

◆ ValueToString() [1/2]

template<typename T , uint32_t Precision, uint32_t SpaceAfter>

bool AAX_CNumberDisplayDelegate< T, Precision, SpaceAfter >::ValueToString	(	T	value,
		AAX_CString *	valueString
	)		const

virtual

Converts a real parameter value to a string representation.

Parameters

[in]	value	The real parameter value that will be converted
[out]	valueString	A string corresponding to value

Return values

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

Implements AAX_IDisplayDelegate< T >.

References AAX_CString::Append(), AAX_CString::AppendNumber(), and AAX_CString::Clear().

Here is the call graph for this function:

◆ ValueToString() [2/2]

template<typename T , uint32_t Precision, uint32_t SpaceAfter>

bool AAX_CNumberDisplayDelegate< T, Precision, SpaceAfter >::ValueToString	(	T	value,
		int32_t	maxNumChars,
		AAX_CString *	valueString
	)		const

virtual

Converts a real parameter value to a string representation using a size hint, useful for control surfaces and other character limited displays.

Parameters

[in]	value	The real parameter value that will be converted
[in]	maxNumChars	Size hint for the desired maximum number of characters in the string (not including null termination)
[out]	valueString	A string corresponding to value

Return values