\hypertarget{a01962}{}\doxysection{AAX\+\_\+\+CString\+Display\+Delegate\texorpdfstring{$<$}{<} T \texorpdfstring{$>$}{>} Class Template Reference}
\label{a01962}\index{AAX\_CStringDisplayDelegate$<$ T $>$@{AAX\_CStringDisplayDelegate$<$ T $>$}}


{\ttfamily \#include $<$AAX\+\_\+\+CString\+Display\+Delegate.\+h$>$}



Inheritance diagram for AAX\+\_\+\+CString\+Display\+Delegate\texorpdfstring{$<$}{<} T \texorpdfstring{$>$}{>}\+:
% FIG 0


Collaboration diagram for AAX\+\_\+\+CString\+Display\+Delegate\texorpdfstring{$<$}{<} T \texorpdfstring{$>$}{>}\+:
% FIG 1


\doxysubsection{Description}
\subsubsection*{template$<$typename T$>$\newline
class AAX\+\_\+\+CString\+Display\+Delegate$<$ T $>$}
A string, or list, display format conforming to \mbox{\hyperlink{a02242}{AAX\+\_\+\+IDisplay\+Delegate}}. 

This display delegate uses a string map to associate parameter values with specific strings. This kind of display delegate is most often used for control string or list parameters, which would internally use an integer parameter type. The int value would then be used as a lookup into this delegate, which would return a string for each valid int value. \doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{a01962_a675d5d95e04e023b0650c621ddaf4972}{AAX\+\_\+\+CString\+Display\+Delegate}} (const std\+::map$<$ T, \mbox{\hyperlink{a01946}{AAX\+\_\+\+CString}} $>$ \&string\+Map)
\begin{DoxyCompactList}\small\item\em Constructor. \end{DoxyCompactList}\item 
\mbox{\hyperlink{a01962}{AAX\+\_\+\+CString\+Display\+Delegate}}$<$ T $>$ $\ast$ \mbox{\hyperlink{a01962_a011fc2e134ffa0469ee995232922bcb2}{Clone}} () const \mbox{\hyperlink{a00542_ac2f24a5172689ae684344abdcce55463}{AAX\+\_\+\+OVERRIDE}}
\begin{DoxyCompactList}\small\item\em Constructs and returns a copy of the display delegate. \end{DoxyCompactList}\item 
bool \mbox{\hyperlink{a01962_a96ae6bc68f2a2df5224539b4b07f914b}{Value\+To\+String}} (T value, \mbox{\hyperlink{a01946}{AAX\+\_\+\+CString}} $\ast$value\+String) const \mbox{\hyperlink{a00542_ac2f24a5172689ae684344abdcce55463}{AAX\+\_\+\+OVERRIDE}}
\begin{DoxyCompactList}\small\item\em Converts a real parameter value to a string representation. \end{DoxyCompactList}\item 
bool \mbox{\hyperlink{a01962_a5b5af0bb407230879e3cf7f952ad4de9}{Value\+To\+String}} (T value, int32\+\_\+t max\+Num\+Chars, \mbox{\hyperlink{a01946}{AAX\+\_\+\+CString}} $\ast$value\+String) const \mbox{\hyperlink{a00542_ac2f24a5172689ae684344abdcce55463}{AAX\+\_\+\+OVERRIDE}}
\begin{DoxyCompactList}\small\item\em Converts a real parameter value to a string representation using a size hint, useful for control surfaces and other character limited displays. \end{DoxyCompactList}\item 
bool \mbox{\hyperlink{a01962_a465943be762c4c273eb19f2272800ed0}{String\+To\+Value}} (const \mbox{\hyperlink{a01946}{AAX\+\_\+\+CString}} \&value\+String, T $\ast$value) const \mbox{\hyperlink{a00542_ac2f24a5172689ae684344abdcce55463}{AAX\+\_\+\+OVERRIDE}}
\begin{DoxyCompactList}\small\item\em Converts a string to a real parameter value. \end{DoxyCompactList}\end{DoxyCompactItemize}
\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a02242}{AAX\+\_\+\+IDisplay\+Delegate}} $\ast$ \mbox{\hyperlink{a02242_abc5378e497b2586aeb223bc3bb59154f}{Clone}} () const =0
\begin{DoxyCompactList}\small\item\em Constructs and returns a copy of the display delegate. \end{DoxyCompactList}\item 
virtual bool \mbox{\hyperlink{a02242_a7fd1e2f55055c817937bbfa66b73b2fd}{Value\+To\+String}} (T value, \mbox{\hyperlink{a01946}{AAX\+\_\+\+CString}} $\ast$value\+String) const =0
\begin{DoxyCompactList}\small\item\em Converts a real parameter value to a string representation. \end{DoxyCompactList}\item 
virtual bool \mbox{\hyperlink{a02242_a471c7381db773683b69216a9c3f5eda7}{Value\+To\+String}} (T value, int32\+\_\+t max\+Num\+Chars, \mbox{\hyperlink{a01946}{AAX\+\_\+\+CString}} $\ast$value\+String) const =0
\begin{DoxyCompactList}\small\item\em Converts a real parameter value to a string representation using a size hint, useful for control surfaces and other character limited displays. \end{DoxyCompactList}\item 
virtual bool \mbox{\hyperlink{a02242_aed5224775c9f733f091afddfba057d5e}{String\+To\+Value}} (const \mbox{\hyperlink{a01946}{AAX\+\_\+\+CString}} \&value\+String, T $\ast$value) const =0
\begin{DoxyCompactList}\small\item\em Converts a string to a real parameter value. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Public Member Functions inherited from \mbox{\hyperlink{a02238}{AAX\+\_\+\+IDisplay\+Delegate\+Base}}}
\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a02238_a0fdaa922b4356fb4a246053bb441a840}{$\sim$\+AAX\+\_\+\+IDisplay\+Delegate\+Base}} ()
\begin{DoxyCompactList}\small\item\em Virtual destructor. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Protected Attributes}
\begin{DoxyCompactItemize}
\item 
std\+::map$<$ T, \mbox{\hyperlink{a01946}{AAX\+\_\+\+CString}} $>$ \mbox{\hyperlink{a01962_aba142c61f06272adbaed051751d96123}{m\+String\+Map}}
\item 
std\+::map$<$ \mbox{\hyperlink{a01946}{AAX\+\_\+\+CString}}, T $>$ \mbox{\hyperlink{a01962_a388606665c60b57c16152b0424c54e2e}{m\+Inverse\+String\+Map}}
\end{DoxyCompactItemize}


\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{a01962_a675d5d95e04e023b0650c621ddaf4972}\label{a01962_a675d5d95e04e023b0650c621ddaf4972}} 
\index{AAX\_CStringDisplayDelegate$<$ T $>$@{AAX\_CStringDisplayDelegate$<$ T $>$}!AAX\_CStringDisplayDelegate@{AAX\_CStringDisplayDelegate}}
\index{AAX\_CStringDisplayDelegate@{AAX\_CStringDisplayDelegate}!AAX\_CStringDisplayDelegate$<$ T $>$@{AAX\_CStringDisplayDelegate$<$ T $>$}}
\doxysubsubsection{\texorpdfstring{AAX\_CStringDisplayDelegate()}{AAX\_CStringDisplayDelegate()}}
{\footnotesize\ttfamily template$<$typename T $>$ \\
\mbox{\hyperlink{a01962}{AAX\+\_\+\+CString\+Display\+Delegate}}$<$ T $>$\mbox{\hyperlink{a01962}{\+::\+AAX\+\_\+\+CString\+Display\+Delegate}} (\begin{DoxyParamCaption}\item[{const std\+::map$<$ T, \mbox{\hyperlink{a01946}{AAX\+\_\+\+CString}} $>$ \&}]{string\+Map }\end{DoxyParamCaption})}



Constructor. 

Constructs a String Display Delegate with a provided string map.

\begin{DoxyNote}{Note}
The string map should already be populated with value-\/string pairs, as this constructor will copy the provided map into the delegate object\textquotesingle{}s own memory.
\end{DoxyNote}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em string\+Map} & A populated map of value-\/string pairs \\
\hline
\end{DoxyParams}


References \mbox{\hyperlink{a01962_a388606665c60b57c16152b0424c54e2e}{AAX\+\_\+\+CString\+Display\+Delegate$<$ T $>$\+::m\+Inverse\+String\+Map}}, and \mbox{\hyperlink{a01962_aba142c61f06272adbaed051751d96123}{AAX\+\_\+\+CString\+Display\+Delegate$<$ T $>$\+::m\+String\+Map}}.



\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{a01962_a011fc2e134ffa0469ee995232922bcb2}\label{a01962_a011fc2e134ffa0469ee995232922bcb2}} 
\index{AAX\_CStringDisplayDelegate$<$ T $>$@{AAX\_CStringDisplayDelegate$<$ T $>$}!Clone@{Clone}}
\index{Clone@{Clone}!AAX\_CStringDisplayDelegate$<$ T $>$@{AAX\_CStringDisplayDelegate$<$ T $>$}}
\doxysubsubsection{\texorpdfstring{Clone()}{Clone()}}
{\footnotesize\ttfamily template$<$typename T $>$ \\
\mbox{\hyperlink{a01962}{AAX\+\_\+\+CString\+Display\+Delegate}}$<$ T $>$ $\ast$ \mbox{\hyperlink{a01962}{AAX\+\_\+\+CString\+Display\+Delegate}}$<$ T $>$\+::\+Clone (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}}



Constructs and returns a copy of the display delegate. 

In general, this method\textquotesingle{}s implementation can use a simple copy constructor\+:


\begin{DoxyCode}{0}
\DoxyCodeLine{\textcolor{keyword}{template}\ <\textcolor{keyword}{typename}\ T>}
\DoxyCodeLine{AAX\_CSubclassDisplayDelegate<T>*\ \ \ \ AAX\_CSubclassDisplayDelegate<T>::Clone()\textcolor{keyword}{\ const}}
\DoxyCodeLine{\textcolor{keyword}{}\{}
\DoxyCodeLine{\ \ \ \ \textcolor{keywordflow}{return}\ \textcolor{keyword}{new}\ AAX\_CSubclassDisplayDelegate(*\textcolor{keyword}{this});}
\DoxyCodeLine{\}}

\end{DoxyCode}
 

Implements \mbox{\hyperlink{a02242_abc5378e497b2586aeb223bc3bb59154f}{AAX\+\_\+\+IDisplay\+Delegate$<$ T $>$}}.

\mbox{\Hypertarget{a01962_a96ae6bc68f2a2df5224539b4b07f914b}\label{a01962_a96ae6bc68f2a2df5224539b4b07f914b}} 
\index{AAX\_CStringDisplayDelegate$<$ T $>$@{AAX\_CStringDisplayDelegate$<$ T $>$}!ValueToString@{ValueToString}}
\index{ValueToString@{ValueToString}!AAX\_CStringDisplayDelegate$<$ T $>$@{AAX\_CStringDisplayDelegate$<$ T $>$}}
\doxysubsubsection{\texorpdfstring{ValueToString()}{ValueToString()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily template$<$typename T $>$ \\
bool \mbox{\hyperlink{a01962}{AAX\+\_\+\+CString\+Display\+Delegate}}$<$ T $>$\+::\+Value\+To\+String (\begin{DoxyParamCaption}\item[{T}]{value,  }\item[{\mbox{\hyperlink{a01946}{AAX\+\_\+\+CString}} $\ast$}]{value\+String }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}}



Converts a real parameter value to a string representation. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em value} & The real parameter value that will be converted \\
\hline
\mbox{\texttt{ out}}  & {\em value\+String} & A string corresponding to value\\
\hline
\end{DoxyParams}

\begin{DoxyRetVals}{Return values}
{\em true} & The string conversion was successful \\
\hline
{\em false} & The string conversion was unsuccessful \\
\hline
\end{DoxyRetVals}


Implements \mbox{\hyperlink{a02242_a7fd1e2f55055c817937bbfa66b73b2fd}{AAX\+\_\+\+IDisplay\+Delegate$<$ T $>$}}.

\mbox{\Hypertarget{a01962_a5b5af0bb407230879e3cf7f952ad4de9}\label{a01962_a5b5af0bb407230879e3cf7f952ad4de9}} 
\index{AAX\_CStringDisplayDelegate$<$ T $>$@{AAX\_CStringDisplayDelegate$<$ T $>$}!ValueToString@{ValueToString}}
\index{ValueToString@{ValueToString}!AAX\_CStringDisplayDelegate$<$ T $>$@{AAX\_CStringDisplayDelegate$<$ T $>$}}
\doxysubsubsection{\texorpdfstring{ValueToString()}{ValueToString()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily template$<$typename T $>$ \\
bool \mbox{\hyperlink{a01962}{AAX\+\_\+\+CString\+Display\+Delegate}}$<$ T $>$\+::\+Value\+To\+String (\begin{DoxyParamCaption}\item[{T}]{value,  }\item[{int32\+\_\+t}]{max\+Num\+Chars,  }\item[{\mbox{\hyperlink{a01946}{AAX\+\_\+\+CString}} $\ast$}]{value\+String }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}}



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


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em value} & The real parameter value that will be converted \\
\hline
\mbox{\texttt{ in}}  & {\em max\+Num\+Chars} & Size hint for the desired maximum number of characters in the string (not including null termination) \\
\hline
\mbox{\texttt{ out}}  & {\em value\+String} & A string corresponding to value\\
\hline
\end{DoxyParams}

\begin{DoxyRetVals}{Return values}
{\em true} & The string conversion was successful \\
\hline
{\em false} & The string conversion was unsuccessful \\
\hline
\end{DoxyRetVals}


Implements \mbox{\hyperlink{a02242_a471c7381db773683b69216a9c3f5eda7}{AAX\+\_\+\+IDisplay\+Delegate$<$ T $>$}}.

\mbox{\Hypertarget{a01962_a465943be762c4c273eb19f2272800ed0}\label{a01962_a465943be762c4c273eb19f2272800ed0}} 
\index{AAX\_CStringDisplayDelegate$<$ T $>$@{AAX\_CStringDisplayDelegate$<$ T $>$}!StringToValue@{StringToValue}}
\index{StringToValue@{StringToValue}!AAX\_CStringDisplayDelegate$<$ T $>$@{AAX\_CStringDisplayDelegate$<$ T $>$}}
\doxysubsubsection{\texorpdfstring{StringToValue()}{StringToValue()}}
{\footnotesize\ttfamily template$<$typename T $>$ \\
bool \mbox{\hyperlink{a01962}{AAX\+\_\+\+CString\+Display\+Delegate}}$<$ T $>$\+::\+String\+To\+Value (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{a01946}{AAX\+\_\+\+CString}} \&}]{value\+String,  }\item[{T $\ast$}]{value }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}}



Converts a string to a real parameter value. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em value\+String} & The string that will be converted \\
\hline
\mbox{\texttt{ out}}  & {\em value} & The real parameter value corresponding to value\+String\\
\hline
\end{DoxyParams}

\begin{DoxyRetVals}{Return values}
{\em true} & The string conversion was successful \\
\hline
{\em false} & The string conversion was unsuccessful \\
\hline
\end{DoxyRetVals}


Implements \mbox{\hyperlink{a02242_aed5224775c9f733f091afddfba057d5e}{AAX\+\_\+\+IDisplay\+Delegate$<$ T $>$}}.



\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{a01962_aba142c61f06272adbaed051751d96123}\label{a01962_aba142c61f06272adbaed051751d96123}} 
\index{AAX\_CStringDisplayDelegate$<$ T $>$@{AAX\_CStringDisplayDelegate$<$ T $>$}!mStringMap@{mStringMap}}
\index{mStringMap@{mStringMap}!AAX\_CStringDisplayDelegate$<$ T $>$@{AAX\_CStringDisplayDelegate$<$ T $>$}}
\doxysubsubsection{\texorpdfstring{mStringMap}{mStringMap}}
{\footnotesize\ttfamily template$<$typename T $>$ \\
std\+::map$<$T, \mbox{\hyperlink{a01946}{AAX\+\_\+\+CString}}$>$ \mbox{\hyperlink{a01962}{AAX\+\_\+\+CString\+Display\+Delegate}}$<$ T $>$\+::m\+String\+Map\hspace{0.3cm}{\ttfamily [protected]}}



Referenced by \mbox{\hyperlink{a01962_a675d5d95e04e023b0650c621ddaf4972}{AAX\+\_\+\+CString\+Display\+Delegate$<$ T $>$\+::\+AAX\+\_\+\+CString\+Display\+Delegate()}}.

\mbox{\Hypertarget{a01962_a388606665c60b57c16152b0424c54e2e}\label{a01962_a388606665c60b57c16152b0424c54e2e}} 
\index{AAX\_CStringDisplayDelegate$<$ T $>$@{AAX\_CStringDisplayDelegate$<$ T $>$}!mInverseStringMap@{mInverseStringMap}}
\index{mInverseStringMap@{mInverseStringMap}!AAX\_CStringDisplayDelegate$<$ T $>$@{AAX\_CStringDisplayDelegate$<$ T $>$}}
\doxysubsubsection{\texorpdfstring{mInverseStringMap}{mInverseStringMap}}
{\footnotesize\ttfamily template$<$typename T $>$ \\
std\+::map$<$\mbox{\hyperlink{a01946}{AAX\+\_\+\+CString}}, T$>$ \mbox{\hyperlink{a01962}{AAX\+\_\+\+CString\+Display\+Delegate}}$<$ T $>$\+::m\+Inverse\+String\+Map\hspace{0.3cm}{\ttfamily [protected]}}



Referenced by \mbox{\hyperlink{a01962_a675d5d95e04e023b0650c621ddaf4972}{AAX\+\_\+\+CString\+Display\+Delegate$<$ T $>$\+::\+AAX\+\_\+\+CString\+Display\+Delegate()}}.



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{a00425}{AAX\+\_\+\+CString\+Display\+Delegate.\+h}}\end{DoxyCompactItemize}
