\hypertarget{class_ogre_1_1_param_dictionary}{}\section{Ogre\+:\+:Param\+Dictionary Class Reference}
\label{class_ogre_1_1_param_dictionary}\index{Ogre\+::\+Param\+Dictionary@{Ogre\+::\+Param\+Dictionary}}


Class to hold a dictionary of parameters for a single class.  




{\ttfamily \#include $<$Ogre\+String\+Interface.\+h$>$}

\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_ogre_1_1_param_dictionary_af3f46fdeacdb40c4dc234cd3540cd701}{Param\+Dictionary} ()
\item 
void \hyperlink{class_ogre_1_1_param_dictionary_a411fa9cc6ca47ea388307fdd7841f547}{add\+Parameter} (const \hyperlink{class_ogre_1_1_parameter_def}{Parameter\+Def} \&param\+Def, \hyperlink{class_ogre_1_1_param_command}{Param\+Command} $\ast$param\+Cmd)
\begin{DoxyCompactList}\small\item\em Method for adding a parameter definition for this class. \end{DoxyCompactList}\item 
const \hyperlink{group___general_ga1838c2b0619ade1f5e29767062212872}{Parameter\+List} \& \hyperlink{class_ogre_1_1_param_dictionary_a8daf849b675d97176b60034630fcd445}{get\+Parameters} (void) const
\begin{DoxyCompactList}\small\item\em Retrieves a list of parameters valid for this object. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Friends}
\begin{DoxyCompactItemize}
\item 
class \hyperlink{class_ogre_1_1_param_dictionary_af1037345f6c7a90f967a44cb1eb6dadc}{String\+Interface}
\end{DoxyCompactItemize}


\subsection{Detailed Description}
Class to hold a dictionary of parameters for a single class. 



\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_param_dictionary_af3f46fdeacdb40c4dc234cd3540cd701}\label{class_ogre_1_1_param_dictionary_af3f46fdeacdb40c4dc234cd3540cd701}} 
\index{Ogre\+::\+Param\+Dictionary@{Ogre\+::\+Param\+Dictionary}!Param\+Dictionary@{Param\+Dictionary}}
\index{Param\+Dictionary@{Param\+Dictionary}!Ogre\+::\+Param\+Dictionary@{Ogre\+::\+Param\+Dictionary}}
\subsubsection{\texorpdfstring{Param\+Dictionary()}{ParamDictionary()}}
{\footnotesize\ttfamily Ogre\+::\+Param\+Dictionary\+::\+Param\+Dictionary (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



\subsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_param_dictionary_a411fa9cc6ca47ea388307fdd7841f547}\label{class_ogre_1_1_param_dictionary_a411fa9cc6ca47ea388307fdd7841f547}} 
\index{Ogre\+::\+Param\+Dictionary@{Ogre\+::\+Param\+Dictionary}!add\+Parameter@{add\+Parameter}}
\index{add\+Parameter@{add\+Parameter}!Ogre\+::\+Param\+Dictionary@{Ogre\+::\+Param\+Dictionary}}
\subsubsection{\texorpdfstring{add\+Parameter()}{addParameter()}}
{\footnotesize\ttfamily void Ogre\+::\+Param\+Dictionary\+::add\+Parameter (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_parameter_def}{Parameter\+Def} \&}]{param\+Def,  }\item[{\hyperlink{class_ogre_1_1_param_command}{Param\+Command} $\ast$}]{param\+Cmd }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Method for adding a parameter definition for this class. 


\begin{DoxyParams}{Parameters}
{\em param\+Def} & A \hyperlink{class_ogre_1_1_parameter_def}{Parameter\+Def} object defining the parameter \\
\hline
{\em param\+Cmd} & Pointer to a \hyperlink{class_ogre_1_1_param_command}{Param\+Command} subclass to handle the getting / setting of this parameter. NB this class will not destroy this on shutdown, please ensure you do \\
\hline
\end{DoxyParams}


References Ogre\+::\+Parameter\+Def\+::name.

\mbox{\Hypertarget{class_ogre_1_1_param_dictionary_a8daf849b675d97176b60034630fcd445}\label{class_ogre_1_1_param_dictionary_a8daf849b675d97176b60034630fcd445}} 
\index{Ogre\+::\+Param\+Dictionary@{Ogre\+::\+Param\+Dictionary}!get\+Parameters@{get\+Parameters}}
\index{get\+Parameters@{get\+Parameters}!Ogre\+::\+Param\+Dictionary@{Ogre\+::\+Param\+Dictionary}}
\subsubsection{\texorpdfstring{get\+Parameters()}{getParameters()}}
{\footnotesize\ttfamily const \hyperlink{group___general_ga1838c2b0619ade1f5e29767062212872}{Parameter\+List}\& Ogre\+::\+Param\+Dictionary\+::get\+Parameters (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Retrieves a list of parameters valid for this object. 

\begin{DoxyReturn}{Returns}
A reference to a static list of \hyperlink{class_ogre_1_1_parameter_def}{Parameter\+Def} objects. 
\end{DoxyReturn}


\subsection{Friends And Related Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_param_dictionary_af1037345f6c7a90f967a44cb1eb6dadc}\label{class_ogre_1_1_param_dictionary_af1037345f6c7a90f967a44cb1eb6dadc}} 
\index{Ogre\+::\+Param\+Dictionary@{Ogre\+::\+Param\+Dictionary}!String\+Interface@{String\+Interface}}
\index{String\+Interface@{String\+Interface}!Ogre\+::\+Param\+Dictionary@{Ogre\+::\+Param\+Dictionary}}
\subsubsection{\texorpdfstring{String\+Interface}{StringInterface}}
{\footnotesize\ttfamily friend class \hyperlink{class_ogre_1_1_string_interface}{String\+Interface}\hspace{0.3cm}{\ttfamily [friend]}}



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\hyperlink{_ogre_string_interface_8h}{Ogre\+String\+Interface.\+h}\end{DoxyCompactItemize}
