\hypertarget{classStaticRoutesVarRW}{
\section{StaticRoutesVarRW Class Reference}
\label{classStaticRoutesVarRW}\index{StaticRoutesVarRW@{StaticRoutesVarRW}}
}


Allows variables to be written and read from static routes.  




{\ttfamily \#include $<$static\_\-routes\_\-varrw.hh$>$}

Inheritance diagram for StaticRoutesVarRW:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=3.000000cm]{classStaticRoutesVarRW}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
enum \{ \par
{\bfseries VAR\_\-NETWORK4} =  VAR\_\-PROTOCOL, 
{\bfseries VAR\_\-NEXTHOP4}, 
{\bfseries VAR\_\-NETWORK6}, 
{\bfseries VAR\_\-NEXTHOP6}, 
\par
{\bfseries VAR\_\-METRIC}
 \}
\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{classStaticRoutesVarRW_a2bb4e11fed074c8e750e842114945b09}{StaticRoutesVarRW} (\hyperlink{classStaticRoute}{StaticRoute} \&route)
\item 
\hypertarget{classStaticRoutesVarRW_a382e821fbeb3ef4b7e1575e4b764c81d}{
void \hyperlink{classStaticRoutesVarRW_a382e821fbeb3ef4b7e1575e4b764c81d}{start\_\-read} ()}
\label{classStaticRoutesVarRW_a382e821fbeb3ef4b7e1575e4b764c81d}

\begin{DoxyCompactList}\small\item\em If any reads are performed, this is a marker which informs \hyperlink{protocolthe-p}{the} derived class that reads will now start. \item\end{DoxyCompactList}\item 
\hyperlink{classElement}{Element} $\ast$ \hyperlink{classStaticRoutesVarRW_ab5bb52b36ee7c1b92800fc0ca09dc346}{single\_\-read} (const Id \&id)
\begin{DoxyCompactList}\small\item\em Read of a variable. \item\end{DoxyCompactList}\item 
void \hyperlink{classStaticRoutesVarRW_a5c45eaec072f095a4aaa3cde40f8fe17}{single\_\-write} (const Id \&id, const \hyperlink{classElement}{Element} \&e)
\begin{DoxyCompactList}\small\item\em Write of a variable. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classStaticRoutesVarRW_a0009aa2a502eff59643df25fe8c4ffe3}{
\hyperlink{classStaticRoute}{StaticRoute} \& {\bfseries \_\-route}}
\label{classStaticRoutesVarRW_a0009aa2a502eff59643df25fe8c4ffe3}

\item 
\hypertarget{classStaticRoutesVarRW_af245fd4aed16d6e6eee27ec6414dda86}{
\hyperlink{classElementFactory}{ElementFactory} {\bfseries \_\-ef}}
\label{classStaticRoutesVarRW_af245fd4aed16d6e6eee27ec6414dda86}

\item 
\hypertarget{classStaticRoutesVarRW_a4d72fb1923abf9dd468de358660f6215}{
bool {\bfseries \_\-is\_\-ipv4}}
\label{classStaticRoutesVarRW_a4d72fb1923abf9dd468de358660f6215}

\item 
\hypertarget{classStaticRoutesVarRW_a0c57687ec1e850dc123a28b650f294f3}{
bool {\bfseries \_\-is\_\-ipv6}}
\label{classStaticRoutesVarRW_a0c57687ec1e850dc123a28b650f294f3}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
Allows variables to be written and read from static routes. 

\subsection{Constructor \& Destructor Documentation}
\hypertarget{classStaticRoutesVarRW_a2bb4e11fed074c8e750e842114945b09}{
\index{StaticRoutesVarRW@{StaticRoutesVarRW}!StaticRoutesVarRW@{StaticRoutesVarRW}}
\index{StaticRoutesVarRW@{StaticRoutesVarRW}!StaticRoutesVarRW@{StaticRoutesVarRW}}
\subsubsection[{StaticRoutesVarRW}]{\setlength{\rightskip}{0pt plus 5cm}StaticRoutesVarRW::StaticRoutesVarRW (
\begin{DoxyParamCaption}
\item[{{\bf StaticRoute} \&}]{route}
\end{DoxyParamCaption}
)}}
\label{classStaticRoutesVarRW_a2bb4e11fed074c8e750e842114945b09}

\begin{DoxyParams}{Parameters}
{\em route} & route to read/write values from. \\
\hline
\end{DoxyParams}


\subsection{Member Function Documentation}
\hypertarget{classStaticRoutesVarRW_ab5bb52b36ee7c1b92800fc0ca09dc346}{
\index{StaticRoutesVarRW@{StaticRoutesVarRW}!single\_\-read@{single\_\-read}}
\index{single\_\-read@{single\_\-read}!StaticRoutesVarRW@{StaticRoutesVarRW}}
\subsubsection[{single\_\-read}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Element} $\ast$ StaticRoutesVarRW::single\_\-read (
\begin{DoxyParamCaption}
\item[{const Id \&}]{id}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}
\label{classStaticRoutesVarRW_ab5bb52b36ee7c1b92800fc0ca09dc346}


Read of a variable. 

The \hyperlink{classVarRW}{VarRW} needs to read a particular element. This may return NULL indicating ElemNull-\/-\/-\/i.e. variable not present in THIS route.

\begin{DoxyReturn}{Returns}
variable requested. 
\end{DoxyReturn}

\begin{DoxyParams}{Parameters}
{\em id} & \hyperlink{protocolthe-p}{the} id of \hyperlink{protocolthe-p}{the} variable. \\
\hline
\end{DoxyParams}


Implements \hyperlink{classSingleVarRW_a54ef877baad0937b181563e8b5eef44a}{SingleVarRW}.

\hypertarget{classStaticRoutesVarRW_a5c45eaec072f095a4aaa3cde40f8fe17}{
\index{StaticRoutesVarRW@{StaticRoutesVarRW}!single\_\-write@{single\_\-write}}
\index{single\_\-write@{single\_\-write}!StaticRoutesVarRW@{StaticRoutesVarRW}}
\subsubsection[{single\_\-write}]{\setlength{\rightskip}{0pt plus 5cm}void StaticRoutesVarRW::single\_\-write (
\begin{DoxyParamCaption}
\item[{const Id \&}]{id, }
\item[{const {\bf Element} \&}]{e}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}
\label{classStaticRoutesVarRW_a5c45eaec072f095a4aaa3cde40f8fe17}


Write of a variable. 

The write MUST be performed now, as \hyperlink{protocolthe-p}{the} element pointer may become invalid after this call. Also, a single write will be called for each modified element.


\begin{DoxyParams}{Parameters}
{\em id} & identifier of variable to be written to. \\
\hline
{\em e} & value of variable. \\
\hline
\end{DoxyParams}


Implements \hyperlink{classSingleVarRW_a24cde180db3bac1e4554cafa1809ba7a}{SingleVarRW}.



The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
\item 
/home/greearb/git/xorp.ct.github/xorp/static\_\-routes/static\_\-routes\_\-varrw.hh\item 
/home/greearb/git/xorp.ct.github/xorp/static\_\-routes/static\_\-routes\_\-varrw.cc\end{DoxyCompactItemize}
