\hypertarget{classConfigParam}{
\section{ConfigParam$<$ T $>$ Class Template Reference}
\label{classConfigParam}\index{ConfigParam@{ConfigParam}}
}


A class for storing a configuration parameter.  




{\ttfamily \#include $<$config\_\-param.hh$>$}

\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classConfigParam_a89c3863f72714ed2813117022fee8c91}{
typedef XorpCallback1$<$ void, T $>$::RefPtr {\bfseries UpdateCallback}}
\label{classConfigParam_a89c3863f72714ed2813117022fee8c91}

\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{classConfigParam_a5bfd07e4ecb0b7546a3a3f7544b78bb0}{ConfigParam} (const T \&value)
\begin{DoxyCompactList}\small\item\em Constructor of a parameter with an initial value. \item\end{DoxyCompactList}\item 
\hyperlink{classConfigParam_a8639c337a3e5aa73f49ccf9debc1aa3d}{ConfigParam} (const T \&value, const UpdateCallback \&update\_\-cb)
\begin{DoxyCompactList}\small\item\em Constructor of a parameter with an initial value and a callback. \item\end{DoxyCompactList}\item 
\hypertarget{classConfigParam_a35529329e7a325ead42ebd2a378d434d}{
virtual \hyperlink{classConfigParam_a35529329e7a325ead42ebd2a378d434d}{$\sim$ConfigParam} ()}
\label{classConfigParam_a35529329e7a325ead42ebd2a378d434d}

\begin{DoxyCompactList}\small\item\em Destructor. \item\end{DoxyCompactList}\item 
const T \& \hyperlink{classConfigParam_ad6081d2a793b68211b5e8d68a50bf36a}{get} () const 
\begin{DoxyCompactList}\small\item\em Get \hyperlink{protocolthe-p}{the} current value of \hyperlink{protocolthe-p}{the} parameter. \item\end{DoxyCompactList}\item 
void \hyperlink{classConfigParam_a58d2a8f9aec859bf75b9635b93c345c4}{set} (const T \&value)
\begin{DoxyCompactList}\small\item\em Set \hyperlink{protocolthe-p}{the} current value of \hyperlink{protocolthe-p}{the} parameter. \item\end{DoxyCompactList}\item 
\hyperlink{classConfigParam}{ConfigParam} \& \hyperlink{classConfigParam_a789eef443d20bcacce3630a7ba09b80e}{operator=} (const T \&value)
\begin{DoxyCompactList}\small\item\em Assignment operator. \item\end{DoxyCompactList}\item 
const T \& \hyperlink{classConfigParam_aa07d9c52a34f99a8d24cd55334378815}{operator++} ()
\begin{DoxyCompactList}\small\item\em Increment Operator (prefix). \item\end{DoxyCompactList}\item 
T \hyperlink{classConfigParam_a82d614857f6fe37ebf7f1c0408057f13}{operator++} (int)
\begin{DoxyCompactList}\small\item\em Increment Operator (postfix). \item\end{DoxyCompactList}\item 
const T \& \hyperlink{classConfigParam_af9af0b1bf8760ed27096b1b92cdf56b1}{incr} ()
\begin{DoxyCompactList}\small\item\em Increment Operator. \item\end{DoxyCompactList}\item 
const T \& \hyperlink{classConfigParam_a1ac163e83778ff1a0cd7267fb41e4277}{operator-\/-\/} ()
\begin{DoxyCompactList}\small\item\em Decrement Operator (prefix). \item\end{DoxyCompactList}\item 
T \hyperlink{classConfigParam_a1ffeba37b9cb6627e91decd742f263f5}{operator-\/-\/} (int)
\begin{DoxyCompactList}\small\item\em Decrement Operator (postfix). \item\end{DoxyCompactList}\item 
const T \& \hyperlink{classConfigParam_a332e239209f4a50544cdfa3431fa3d2b}{decr} ()
\begin{DoxyCompactList}\small\item\em Decrement Operator. \item\end{DoxyCompactList}\item 
\hypertarget{classConfigParam_a29ab4df51e94aeec80a3de6071293fbe}{
const T \& \hyperlink{classConfigParam_a29ab4df51e94aeec80a3de6071293fbe}{get\_\-initial\_\-value} () const }
\label{classConfigParam_a29ab4df51e94aeec80a3de6071293fbe}

\begin{DoxyCompactList}\small\item\em Get \hyperlink{protocolthe-p}{the} initial value of \hyperlink{protocolthe-p}{the} parameter. \item\end{DoxyCompactList}\item 
\hypertarget{classConfigParam_a02863836589edeeabf27e39cee830b95}{
void \hyperlink{classConfigParam_a02863836589edeeabf27e39cee830b95}{reset} ()}
\label{classConfigParam_a02863836589edeeabf27e39cee830b95}

\begin{DoxyCompactList}\small\item\em Reset \hyperlink{protocolthe-p}{the} current value of \hyperlink{protocolthe-p}{the} parameter to its initial value. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classConfigParam_af788afc29ecae4978784e2682cb72306}{
T {\bfseries \_\-value}}
\label{classConfigParam_af788afc29ecae4978784e2682cb72306}

\item 
\hypertarget{classConfigParam_a41571f2485874ea4d25bb16b9cb80fa2}{
T {\bfseries \_\-initial\_\-value}}
\label{classConfigParam_a41571f2485874ea4d25bb16b9cb80fa2}

\item 
\hypertarget{classConfigParam_ae2f2bec65e2afb35503229ad660fc8f1}{
UpdateCallback {\bfseries \_\-update\_\-cb}}
\label{classConfigParam_ae2f2bec65e2afb35503229ad660fc8f1}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
\subsubsection*{template$<$class T$>$ class ConfigParam$<$ T $>$}

A class for storing a configuration parameter. This class can be used to store a configuration parameter. Such parameter has a current and a default value. 

\subsection{Constructor \& Destructor Documentation}
\hypertarget{classConfigParam_a5bfd07e4ecb0b7546a3a3f7544b78bb0}{
\index{ConfigParam@{ConfigParam}!ConfigParam@{ConfigParam}}
\index{ConfigParam@{ConfigParam}!ConfigParam@{ConfigParam}}
\subsubsection[{ConfigParam}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ {\bf ConfigParam}$<$ T $>$::{\bf ConfigParam} (
\begin{DoxyParamCaption}
\item[{const T \&}]{value}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline, explicit\mbox{]}}}}
\label{classConfigParam_a5bfd07e4ecb0b7546a3a3f7544b78bb0}


Constructor of a parameter with an initial value. 

Create a configurable parameter, and initialize its initial and current value.


\begin{DoxyParams}{Parameters}
{\em value} & \hyperlink{protocolthe-p}{the} initial and current value to initialize \hyperlink{protocolthe-p}{the} parameter to. \\
\hline
\end{DoxyParams}
\hypertarget{classConfigParam_a8639c337a3e5aa73f49ccf9debc1aa3d}{
\index{ConfigParam@{ConfigParam}!ConfigParam@{ConfigParam}}
\index{ConfigParam@{ConfigParam}!ConfigParam@{ConfigParam}}
\subsubsection[{ConfigParam}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ {\bf ConfigParam}$<$ T $>$::{\bf ConfigParam} (
\begin{DoxyParamCaption}
\item[{const T \&}]{value, }
\item[{const UpdateCallback \&}]{update\_\-cb}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classConfigParam_a8639c337a3e5aa73f49ccf9debc1aa3d}


Constructor of a parameter with an initial value and a callback. 

Create a configurable parameter, initialize it, and assign a callback method that will be invoked when \hyperlink{protocolthe-p}{the} value changes.


\begin{DoxyParams}{Parameters}
{\em value} & \hyperlink{protocolthe-p}{the} initial and current value to initialize \hyperlink{protocolthe-p}{the} parameter to.\\
\hline
{\em update\_\-cb} & \hyperlink{protocolthe-p}{the} callback method that will be invoked when \hyperlink{protocolthe-p}{the} value changes. \\
\hline
\end{DoxyParams}


\subsection{Member Function Documentation}
\hypertarget{classConfigParam_a332e239209f4a50544cdfa3431fa3d2b}{
\index{ConfigParam@{ConfigParam}!decr@{decr}}
\index{decr@{decr}!ConfigParam@{ConfigParam}}
\subsubsection[{decr}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ const T\& {\bf ConfigParam}$<$ T $>$::decr (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classConfigParam_a332e239209f4a50544cdfa3431fa3d2b}


Decrement Operator. 

The numerical value of this configuration parameter is decremented by one.

\begin{DoxyReturn}{Returns}
a reference to this configuration parameter after it was decremented by one. 
\end{DoxyReturn}
\hypertarget{classConfigParam_ad6081d2a793b68211b5e8d68a50bf36a}{
\index{ConfigParam@{ConfigParam}!get@{get}}
\index{get@{get}!ConfigParam@{ConfigParam}}
\subsubsection[{get}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ const T\& {\bf ConfigParam}$<$ T $>$::get (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classConfigParam_ad6081d2a793b68211b5e8d68a50bf36a}


Get \hyperlink{protocolthe-p}{the} current value of \hyperlink{protocolthe-p}{the} parameter. 

\begin{DoxyReturn}{Returns}
\hyperlink{protocolthe-p}{the} current value of \hyperlink{protocolthe-p}{the} parameter. 
\end{DoxyReturn}
\hypertarget{classConfigParam_af9af0b1bf8760ed27096b1b92cdf56b1}{
\index{ConfigParam@{ConfigParam}!incr@{incr}}
\index{incr@{incr}!ConfigParam@{ConfigParam}}
\subsubsection[{incr}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ const T\& {\bf ConfigParam}$<$ T $>$::incr (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classConfigParam_af9af0b1bf8760ed27096b1b92cdf56b1}


Increment Operator. 

The numerical value of this configuration parameter is incremented by one.

\begin{DoxyReturn}{Returns}
a reference to this configuration parameter after it was incremented by one. 
\end{DoxyReturn}
\hypertarget{classConfigParam_aa07d9c52a34f99a8d24cd55334378815}{
\index{ConfigParam@{ConfigParam}!operator++@{operator++}}
\index{operator++@{operator++}!ConfigParam@{ConfigParam}}
\subsubsection[{operator++}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ const T\& {\bf ConfigParam}$<$ T $>$::operator++ (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classConfigParam_aa07d9c52a34f99a8d24cd55334378815}


Increment Operator (prefix). 

The numerical value of this configuration parameter is incremented by one.

\begin{DoxyReturn}{Returns}
a reference to this configuration parameter after it was incremented by one. 
\end{DoxyReturn}
\hypertarget{classConfigParam_a82d614857f6fe37ebf7f1c0408057f13}{
\index{ConfigParam@{ConfigParam}!operator++@{operator++}}
\index{operator++@{operator++}!ConfigParam@{ConfigParam}}
\subsubsection[{operator++}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ T {\bf ConfigParam}$<$ T $>$::operator++ (
\begin{DoxyParamCaption}
\item[{int}]{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classConfigParam_a82d614857f6fe37ebf7f1c0408057f13}


Increment Operator (postfix). 

The numerical value of this configuration parameter is incremented by one.

\begin{DoxyReturn}{Returns}
\hyperlink{protocolthe-p}{the} value of this configuration parameter before it was incremented by one. 
\end{DoxyReturn}
\hypertarget{classConfigParam_a1ffeba37b9cb6627e91decd742f263f5}{
\index{ConfigParam@{ConfigParam}!operator-\/-\/@{operator-\/-\/}}
\index{operator-\/-\/@{operator-\/-\/}!ConfigParam@{ConfigParam}}
\subsubsection[{operator-\/-\/}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ T {\bf ConfigParam}$<$ T $>$::operator-\/-\/ (
\begin{DoxyParamCaption}
\item[{int}]{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classConfigParam_a1ffeba37b9cb6627e91decd742f263f5}


Decrement Operator (postfix). 

The numerical value of this configuration parameter is decremented by one.

\begin{DoxyReturn}{Returns}
\hyperlink{protocolthe-p}{the} value of this configuration parameter before it was decremented by one. 
\end{DoxyReturn}
\hypertarget{classConfigParam_a1ac163e83778ff1a0cd7267fb41e4277}{
\index{ConfigParam@{ConfigParam}!operator-\/-\/@{operator-\/-\/}}
\index{operator-\/-\/@{operator-\/-\/}!ConfigParam@{ConfigParam}}
\subsubsection[{operator-\/-\/}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ const T\& {\bf ConfigParam}$<$ T $>$::operator-\/-\/ (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classConfigParam_a1ac163e83778ff1a0cd7267fb41e4277}


Decrement Operator (prefix). 

The numerical value of this configuration parameter is decremented by one.

\begin{DoxyReturn}{Returns}
a reference to this configuration parameter after it was decremented by one. 
\end{DoxyReturn}
\hypertarget{classConfigParam_a789eef443d20bcacce3630a7ba09b80e}{
\index{ConfigParam@{ConfigParam}!operator=@{operator=}}
\index{operator=@{operator=}!ConfigParam@{ConfigParam}}
\subsubsection[{operator=}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ {\bf ConfigParam}\& {\bf ConfigParam}$<$ T $>$::operator= (
\begin{DoxyParamCaption}
\item[{const T \&}]{value}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classConfigParam_a789eef443d20bcacce3630a7ba09b80e}


Assignment operator. 


\begin{DoxyParams}{Parameters}
{\em value} & \hyperlink{protocolthe-p}{the} value to assign to \hyperlink{protocolthe-p}{the} parameter. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
\hyperlink{protocolthe-p}{the} parameter with \hyperlink{protocolthe-p}{the} new value assigned. 
\end{DoxyReturn}
\hypertarget{classConfigParam_a58d2a8f9aec859bf75b9635b93c345c4}{
\index{ConfigParam@{ConfigParam}!set@{set}}
\index{set@{set}!ConfigParam@{ConfigParam}}
\subsubsection[{set}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ void {\bf ConfigParam}$<$ T $>$::set (
\begin{DoxyParamCaption}
\item[{const T \&}]{value}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classConfigParam_a58d2a8f9aec859bf75b9635b93c345c4}


Set \hyperlink{protocolthe-p}{the} current value of \hyperlink{protocolthe-p}{the} parameter. 


\begin{DoxyParams}{Parameters}
{\em value} & \hyperlink{protocolthe-p}{the} current value to set \hyperlink{protocolthe-p}{the} parameter to. \\
\hline
\end{DoxyParams}


The documentation for this class was generated from the following file:\begin{DoxyCompactItemize}
\item 
/home/greearb/git/xorp.ct.github/xorp/libxorp/config\_\-param.hh\end{DoxyCompactItemize}
