146 lines
5.9 KiB
TeX
146 lines
5.9 KiB
TeX
\hypertarget{class_config_builder}{}\doxysection{Config\+Builder Class Reference}
|
|
\label{class_config_builder}\index{ConfigBuilder@{ConfigBuilder}}
|
|
|
|
|
|
temporary class used to populate a \mbox{\hyperlink{struct_config_data}{Config\+Data}} object
|
|
|
|
|
|
|
|
|
|
{\ttfamily \#include $<$config\+Management.\+h$>$}
|
|
|
|
|
|
|
|
Collaboration diagram for Config\+Builder\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=277pt]{d6/d8a/class_config_builder__coll__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
void \mbox{\hyperlink{class_config_builder_a408e15906e88336cbc53f19afec65cd6}{parse\+File}} (const string \&fname)
|
|
\begin{DoxyCompactList}\small\item\em parse the file given, and put the keys/values in internal\+Values \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{class_config_builder_acd69e5a0777a3c9339aa96e8ce2e07a9}{read\+Config}} ()
|
|
\item
|
|
void \mbox{\hyperlink{class_config_builder_aab791290aa2d314788fcd9f2c44bf79e}{dump\+Internal\+Values}} () const
|
|
\begin{DoxyCompactList}\small\item\em print internal\+Values pairs in the console (in case in error reporting) \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsection*{Public Attributes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{struct_config_data}{Config\+Data}} \mbox{\hyperlink{class_config_builder_a4b4df7371d8b2544f302219631f0b77f}{collected\+Data}}
|
|
\begin{DoxyCompactList}\small\item\em Actual config data object. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
temporary class used to populate a \mbox{\hyperlink{struct_config_data}{Config\+Data}} object
|
|
|
|
Definition at line \mbox{\hyperlink{config_management_8h_source_l00024}{24}} of file \mbox{\hyperlink{config_management_8h_source}{config\+Management.\+h}}.
|
|
|
|
|
|
|
|
\doxysubsection{Member Function Documentation}
|
|
\mbox{\Hypertarget{class_config_builder_aab791290aa2d314788fcd9f2c44bf79e}\label{class_config_builder_aab791290aa2d314788fcd9f2c44bf79e}}
|
|
\index{ConfigBuilder@{ConfigBuilder}!dumpInternalValues@{dumpInternalValues}}
|
|
\index{dumpInternalValues@{dumpInternalValues}!ConfigBuilder@{ConfigBuilder}}
|
|
\doxysubsubsection{\texorpdfstring{dumpInternalValues()}{dumpInternalValues()}}
|
|
{\footnotesize\ttfamily void Config\+Builder\+::dump\+Internal\+Values (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}
|
|
|
|
|
|
|
|
print internal\+Values pairs in the console (in case in error reporting)
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{config_management_8cpp_source_l00033}{33}} of file \mbox{\hyperlink{config_management_8cpp_source}{config\+Management.\+cpp}}.
|
|
|
|
Here is the caller graph for this function\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{df/d3c/class_config_builder_aab791290aa2d314788fcd9f2c44bf79e_icgraph}
|
|
\end{center}
|
|
\end{figure}
|
|
\mbox{\Hypertarget{class_config_builder_a408e15906e88336cbc53f19afec65cd6}\label{class_config_builder_a408e15906e88336cbc53f19afec65cd6}}
|
|
\index{ConfigBuilder@{ConfigBuilder}!parseFile@{parseFile}}
|
|
\index{parseFile@{parseFile}!ConfigBuilder@{ConfigBuilder}}
|
|
\doxysubsubsection{\texorpdfstring{parseFile()}{parseFile()}}
|
|
{\footnotesize\ttfamily void Config\+Builder\+::parse\+File (\begin{DoxyParamCaption}\item[{const string \&}]{fname }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
parse the file given, and put the keys/values in internal\+Values
|
|
|
|
read the values in collected\+Data and put them in the collected\+Data object
|
|
|
|
|
|
\begin{DoxyParams}[1]{Parameters}
|
|
\mbox{\texttt{ in}} & {\em fname} & file to read from \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{config_management_8cpp_source_l00042}{42}} of file \mbox{\hyperlink{config_management_8cpp_source}{config\+Management.\+cpp}}.
|
|
|
|
Here is the call graph for this function\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{df/d3c/class_config_builder_a408e15906e88336cbc53f19afec65cd6_cgraph}
|
|
\end{center}
|
|
\end{figure}
|
|
Here is the caller graph for this function\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=335pt]{df/d3c/class_config_builder_a408e15906e88336cbc53f19afec65cd6_icgraph}
|
|
\end{center}
|
|
\end{figure}
|
|
\mbox{\Hypertarget{class_config_builder_acd69e5a0777a3c9339aa96e8ce2e07a9}\label{class_config_builder_acd69e5a0777a3c9339aa96e8ce2e07a9}}
|
|
\index{ConfigBuilder@{ConfigBuilder}!readConfig@{readConfig}}
|
|
\index{readConfig@{readConfig}!ConfigBuilder@{ConfigBuilder}}
|
|
\doxysubsubsection{\texorpdfstring{readConfig()}{readConfig()}}
|
|
{\footnotesize\ttfamily void Config\+Builder\+::read\+Config (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{config_management_8cpp_source_l00156}{156}} of file \mbox{\hyperlink{config_management_8cpp_source}{config\+Management.\+cpp}}.
|
|
|
|
Here is the caller graph for this function\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=341pt]{df/d3c/class_config_builder_acd69e5a0777a3c9339aa96e8ce2e07a9_icgraph}
|
|
\end{center}
|
|
\end{figure}
|
|
|
|
|
|
\doxysubsection{Member Data Documentation}
|
|
\mbox{\Hypertarget{class_config_builder_a4b4df7371d8b2544f302219631f0b77f}\label{class_config_builder_a4b4df7371d8b2544f302219631f0b77f}}
|
|
\index{ConfigBuilder@{ConfigBuilder}!collectedData@{collectedData}}
|
|
\index{collectedData@{collectedData}!ConfigBuilder@{ConfigBuilder}}
|
|
\doxysubsubsection{\texorpdfstring{collectedData}{collectedData}}
|
|
{\footnotesize\ttfamily \mbox{\hyperlink{struct_config_data}{Config\+Data}} Config\+Builder\+::collected\+Data}
|
|
|
|
|
|
|
|
Actual config data object.
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{config_management_8h_source_l00030}{30}} of file \mbox{\hyperlink{config_management_8h_source}{config\+Management.\+h}}.
|
|
|
|
|
|
|
|
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
headers/\mbox{\hyperlink{config_management_8h}{config\+Management.\+h}}\item
|
|
src/\mbox{\hyperlink{config_management_8cpp}{config\+Management.\+cpp}}\end{DoxyCompactItemize}
|