\hypertarget{classInternalRouteEntry}{
\section{InternalRouteEntry$<$ A $>$ Class Template Reference}
\label{classInternalRouteEntry}\index{InternalRouteEntry@{InternalRouteEntry}}
}


Internal routing entry, potentially one per area.  




{\ttfamily \#include $<$routing\_\-table.hh$>$}

\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classInternalRouteEntry_a6689c896267c1a02b416fdc9b2f01293}{
{\bfseries InternalRouteEntry} (const \hyperlink{classInternalRouteEntry}{InternalRouteEntry} \&rhs)}
\label{classInternalRouteEntry_a6689c896267c1a02b416fdc9b2f01293}

\item 
\hypertarget{classInternalRouteEntry_a9f5339ce220e152662d9dfd1202f8f20}{
\hyperlink{classInternalRouteEntry}{InternalRouteEntry} \& {\bfseries operator=} (const \hyperlink{classInternalRouteEntry}{InternalRouteEntry} \&rhs)}
\label{classInternalRouteEntry_a9f5339ce220e152662d9dfd1202f8f20}

\item 
\hypertarget{classInternalRouteEntry_a69bbd54e9e50775245d8b05861cdd4fa}{
void {\bfseries copy} (const \hyperlink{classInternalRouteEntry}{InternalRouteEntry} \&rhs)}
\label{classInternalRouteEntry_a69bbd54e9e50775245d8b05861cdd4fa}

\item 
bool \hyperlink{classInternalRouteEntry_a0cd4528aeb1ba074072c507de1c8e04f}{add\_\-entry} (\hyperlink{structOspfTypes_a8276e5e81192074d7c95e445995d18c6}{OspfTypes::AreaID} area, const \hyperlink{classRouteEntry}{RouteEntry}$<$ A $>$ \&rt)
\begin{DoxyCompactList}\small\item\em Add entry indexed by area. \item\end{DoxyCompactList}\item 
\hypertarget{classInternalRouteEntry_abe1a61bc83d98961bdc9d6e496f4113a}{
bool {\bfseries replace\_\-entry} (\hyperlink{structOspfTypes_a8276e5e81192074d7c95e445995d18c6}{OspfTypes::AreaID} area, const \hyperlink{classRouteEntry}{RouteEntry}$<$ A $>$ \&rt)}
\label{classInternalRouteEntry_abe1a61bc83d98961bdc9d6e496f4113a}

\item 
bool \hyperlink{classInternalRouteEntry_adb9ebcf09955e6a57b95d0e1114ca4ec}{delete\_\-entry} (\hyperlink{structOspfTypes_a8276e5e81192074d7c95e445995d18c6}{OspfTypes::AreaID}, bool \&winner\_\-changed)
\begin{DoxyCompactList}\small\item\em Delete entry. \item\end{DoxyCompactList}\item 
\hypertarget{classInternalRouteEntry_ab638202d90bd1e69d48dcb5065f6475f}{
\hyperlink{classRouteEntry}{RouteEntry}$<$ A $>$ \& \hyperlink{classInternalRouteEntry_ab638202d90bd1e69d48dcb5065f6475f}{get\_\-entry} () const }
\label{classInternalRouteEntry_ab638202d90bd1e69d48dcb5065f6475f}

\begin{DoxyCompactList}\small\item\em Get \hyperlink{protocolthe-p}{the} winning entry. \item\end{DoxyCompactList}\item 
bool \hyperlink{classInternalRouteEntry_ab115c6bb517238d8938c8d36a79a887c}{get\_\-entry} (\hyperlink{structOspfTypes_a8276e5e81192074d7c95e445995d18c6}{OspfTypes::AreaID} area, \hyperlink{classRouteEntry}{RouteEntry}$<$ A $>$ \&rt) const 
\begin{DoxyCompactList}\small\item\em Look from an entry for this specific area. \item\end{DoxyCompactList}\item 
\hypertarget{classInternalRouteEntry_a74c046e739df933ff16489500eac913d}{
bool \hyperlink{classInternalRouteEntry_a74c046e739df933ff16489500eac913d}{empty} () const }
\label{classInternalRouteEntry_a74c046e739df933ff16489500eac913d}

\begin{DoxyCompactList}\small\item\em Are there any entries? \item\end{DoxyCompactList}\item 
\hypertarget{classInternalRouteEntry_af9d1f97b86f80051ab2489bf670d6358}{
string {\bfseries str} ()}
\label{classInternalRouteEntry_af9d1f97b86f80051ab2489bf670d6358}

\end{DoxyCompactItemize}
\subsection*{Private Member Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classInternalRouteEntry_a3ae948857a94f900eae5b8235f5b7764}{
bool {\bfseries reset\_\-winner} ()}
\label{classInternalRouteEntry_a3ae948857a94f900eae5b8235f5b7764}

\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classInternalRouteEntry_a9567b6b58766913b54dc649abba6b4cc}{
\hyperlink{classRouteEntry}{RouteEntry}$<$ A $>$ $\ast$ {\bfseries \_\-winner}}
\label{classInternalRouteEntry_a9567b6b58766913b54dc649abba6b4cc}

\item 
\hypertarget{classInternalRouteEntry_a044d869296478b425ffb7506ba11f9ae}{
map$<$ \hyperlink{structOspfTypes_a8276e5e81192074d7c95e445995d18c6}{OspfTypes::AreaID}, \hyperlink{classRouteEntry}{RouteEntry}$<$ A $>$ $>$ {\bfseries \_\-entries}}
\label{classInternalRouteEntry_a044d869296478b425ffb7506ba11f9ae}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
\subsubsection*{template$<$typename A$>$ class InternalRouteEntry$<$ A $>$}

Internal routing entry, potentially one per area. 

\subsection{Member Function Documentation}
\hypertarget{classInternalRouteEntry_a0cd4528aeb1ba074072c507de1c8e04f}{
\index{InternalRouteEntry@{InternalRouteEntry}!add\_\-entry@{add\_\-entry}}
\index{add\_\-entry@{add\_\-entry}!InternalRouteEntry@{InternalRouteEntry}}
\subsubsection[{add\_\-entry}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename A $>$ bool {\bf InternalRouteEntry}$<$ A $>$::add\_\-entry (
\begin{DoxyParamCaption}
\item[{{\bf OspfTypes::AreaID}}]{area, }
\item[{const {\bf RouteEntry}$<$ A $>$ \&}]{rt}
\end{DoxyParamCaption}
)}}
\label{classInternalRouteEntry_a0cd4528aeb1ba074072c507de1c8e04f}


Add entry indexed by area. 

\begin{DoxyReturn}{Returns}
true on sucess. 
\end{DoxyReturn}
\hypertarget{classInternalRouteEntry_adb9ebcf09955e6a57b95d0e1114ca4ec}{
\index{InternalRouteEntry@{InternalRouteEntry}!delete\_\-entry@{delete\_\-entry}}
\index{delete\_\-entry@{delete\_\-entry}!InternalRouteEntry@{InternalRouteEntry}}
\subsubsection[{delete\_\-entry}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename A $>$ bool {\bf InternalRouteEntry}$<$ A $>$::delete\_\-entry (
\begin{DoxyParamCaption}
\item[{{\bf OspfTypes::AreaID}}]{area, }
\item[{bool \&}]{winner\_\-changed}
\end{DoxyParamCaption}
)}}
\label{classInternalRouteEntry_adb9ebcf09955e6a57b95d0e1114ca4ec}


Delete entry. 

Perfectly safe to attempt to delete an entry for an area even if no entry exists.


\begin{DoxyParams}{Parameters}
{\em area} & area ID. \\
\hline
{\em winner\_\-changed} & out parameter set to true if this entry was \hyperlink{protocolthe-p}{the} winner. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if an entry was deleted. 
\end{DoxyReturn}
\hypertarget{classInternalRouteEntry_ab115c6bb517238d8938c8d36a79a887c}{
\index{InternalRouteEntry@{InternalRouteEntry}!get\_\-entry@{get\_\-entry}}
\index{get\_\-entry@{get\_\-entry}!InternalRouteEntry@{InternalRouteEntry}}
\subsubsection[{get\_\-entry}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename A $>$ bool {\bf InternalRouteEntry}$<$ A $>$::get\_\-entry (
\begin{DoxyParamCaption}
\item[{{\bf OspfTypes::AreaID}}]{area, }
\item[{{\bf RouteEntry}$<$ A $>$ \&}]{rt}
\end{DoxyParamCaption}
) const}}
\label{classInternalRouteEntry_ab115c6bb517238d8938c8d36a79a887c}


Look from an entry for this specific area. 


\begin{DoxyParams}{Parameters}
{\em area} & area ID. \\
\hline
{\em rt} & if a match is found this is filled in with \hyperlink{protocolthe-p}{the} route.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if an entry for this area was found. 
\end{DoxyReturn}


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