\hypertarget{classStaticRoute}{
\section{StaticRoute Class Reference}
\label{classStaticRoute}\index{StaticRoute@{StaticRoute}}
}


A \hyperlink{classStaticRoute}{StaticRoute} helper class.  




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

\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{classStaticRoute_ae9e11faddf939d4cff6d3b3ced222be4}{StaticRoute} (bool unicast, bool multicast, const \hyperlink{classIPNet}{IPv4Net} \&network, const \hyperlink{classIPv4}{IPv4} \&nexthop, const string \&ifname, const string \&vifname, uint32\_\-t metric, bool is\_\-backup\_\-route)
\begin{DoxyCompactList}\small\item\em Constructor for a given \hyperlink{classIPv4}{IPv4} static route. \item\end{DoxyCompactList}\item 
\hyperlink{classStaticRoute_a68c41a92cc915c5557b3e450bb12499f}{StaticRoute} (bool unicast, bool multicast, const \hyperlink{classIPNet}{IPv6Net} \&network, const \hyperlink{classIPv6}{IPv6} \&nexthop, const string \&ifname, const string \&vifname, uint32\_\-t metric, bool is\_\-backup\_\-route)
\begin{DoxyCompactList}\small\item\em Constructor for a given \hyperlink{classIPv6}{IPv6} static route. \item\end{DoxyCompactList}\item 
bool \hyperlink{classStaticRoute_ad2e36e7d5fb70919ba5f3b75c8f7b51b}{operator==} (const \hyperlink{classStaticRoute}{StaticRoute} \&other) const 
\begin{DoxyCompactList}\small\item\em Equality Operator. \item\end{DoxyCompactList}\item 
bool \hyperlink{classStaticRoute_acfdebeb73effba5c7c8f9ada9b8b20fa}{is\_\-same\_\-route} (const \hyperlink{classStaticRoute}{StaticRoute} \&other) const 
\begin{DoxyCompactList}\small\item\em Test whether both routes contain same routing information. \item\end{DoxyCompactList}\item 
bool \hyperlink{classStaticRoute_a17f955c3be880e4c6aa915882d7e9e63}{is\_\-ipv4} () const 
\begin{DoxyCompactList}\small\item\em Test if this is an \hyperlink{classIPv4}{IPv4} route. \item\end{DoxyCompactList}\item 
bool \hyperlink{classStaticRoute_a69380ca0613413fbc3ea7be7050b8c83}{is\_\-ipv6} () const 
\begin{DoxyCompactList}\small\item\em Test if this is an \hyperlink{classIPv6}{IPv6} route. \item\end{DoxyCompactList}\item 
bool \hyperlink{classStaticRoute_a74299bd8632a6c4c98e80072bac017c1}{unicast} () const 
\begin{DoxyCompactList}\small\item\em Test if this route would be used for unicast routing. \item\end{DoxyCompactList}\item 
bool \hyperlink{classStaticRoute_a4a1c7c5a674bf6f1c06c2296baf898ee}{multicast} () const 
\begin{DoxyCompactList}\small\item\em Test if this route would be used for multicast routing. \item\end{DoxyCompactList}\item 
const \hyperlink{classIPvXNet}{IPvXNet} \& \hyperlink{classStaticRoute_ad6b91d9970f8d81d3bf04d88d71d9e9f}{network} () const 
\begin{DoxyCompactList}\small\item\em Get \hyperlink{protocolthe-p}{the} network address prefix this route applies to. \item\end{DoxyCompactList}\item 
const \hyperlink{classIPvX}{IPvX} \& \hyperlink{classStaticRoute_adf551e5395598d851870f6ceee0dd7e6}{nexthop} () const 
\begin{DoxyCompactList}\small\item\em Get \hyperlink{protocolthe-p}{the} address of \hyperlink{protocolthe-p}{the} next-\/hop router for this route. \item\end{DoxyCompactList}\item 
void \hyperlink{classStaticRoute_a41e79d61e3dacafd67b92753502c7dcd}{set\_\-nexthop} (const \hyperlink{classIPvX}{IPvX} \&v)
\begin{DoxyCompactList}\small\item\em Set \hyperlink{protocolthe-p}{the} address of \hyperlink{protocolthe-p}{the} next-\/hop router for this route. \item\end{DoxyCompactList}\item 
const string \& \hyperlink{classStaticRoute_af6506d870b14aeadeb1c0270b6a90222}{ifname} () const 
\begin{DoxyCompactList}\small\item\em Get \hyperlink{protocolthe-p}{the} name of \hyperlink{protocolthe-p}{the} physical interface toward \hyperlink{protocolthe-p}{the} destination. \item\end{DoxyCompactList}\item 
void \hyperlink{classStaticRoute_a02ea9df2ea6b0e79a672ab32029791d3}{set\_\-ifname} (const string \&v)
\begin{DoxyCompactList}\small\item\em Set \hyperlink{protocolthe-p}{the} name of \hyperlink{protocolthe-p}{the} physical interface toward \hyperlink{protocolthe-p}{the} destination. \item\end{DoxyCompactList}\item 
const string \& \hyperlink{classStaticRoute_a1f4aad9ffaa60f3ffe2267f8d6c8ce08}{vifname} () const 
\begin{DoxyCompactList}\small\item\em Get \hyperlink{protocolthe-p}{the} name of \hyperlink{protocolthe-p}{the} virtual interface toward \hyperlink{protocolthe-p}{the} destination. \item\end{DoxyCompactList}\item 
void \hyperlink{classStaticRoute_a803a9ef5fc3008c5172a760cb2dfde18}{set\_\-vifname} (const string \&v)
\begin{DoxyCompactList}\small\item\em Set \hyperlink{protocolthe-p}{the} name of \hyperlink{protocolthe-p}{the} virtual interface toward \hyperlink{protocolthe-p}{the} destination. \item\end{DoxyCompactList}\item 
uint32\_\-t \hyperlink{classStaticRoute_a0aa94d376c5179100ed6954f800b8ea8}{metric} () const 
\begin{DoxyCompactList}\small\item\em Get \hyperlink{protocolthe-p}{the} metric distance for this route. \item\end{DoxyCompactList}\item 
bool \hyperlink{classStaticRoute_ac164acd0cb8cc55cbd982d29558e101e}{is\_\-backup\_\-route} () const 
\begin{DoxyCompactList}\small\item\em Test if this is a backup route. \item\end{DoxyCompactList}\item 
bool \hyperlink{classStaticRoute_ad7e667e3afb8c73a85e248bc56c03b5c}{is\_\-add\_\-route} () const 
\begin{DoxyCompactList}\small\item\em Test if this is a route to add. \item\end{DoxyCompactList}\item 
bool \hyperlink{classStaticRoute_ab43919cd225d8d21934db58d841d656e}{is\_\-replace\_\-route} () const 
\begin{DoxyCompactList}\small\item\em Test if this is a replacement route. \item\end{DoxyCompactList}\item 
bool \hyperlink{classStaticRoute_a70e8ccda2157ff35f907339b04e88827}{is\_\-delete\_\-route} () const 
\begin{DoxyCompactList}\small\item\em Test if this is a route to delete. \item\end{DoxyCompactList}\item 
\hypertarget{classStaticRoute_a32938b5164e0b6839f122c5986c82cdd}{
void \hyperlink{classStaticRoute_a32938b5164e0b6839f122c5986c82cdd}{set\_\-add\_\-route} ()}
\label{classStaticRoute_a32938b5164e0b6839f122c5986c82cdd}

\begin{DoxyCompactList}\small\item\em Set \hyperlink{protocolthe-p}{the} type of this route to \char`\"{}a route to add\char`\"{}. \item\end{DoxyCompactList}\item 
\hypertarget{classStaticRoute_a97ec99b54c08ea65efbd59d27638b5df}{
void \hyperlink{classStaticRoute_a97ec99b54c08ea65efbd59d27638b5df}{set\_\-replace\_\-route} ()}
\label{classStaticRoute_a97ec99b54c08ea65efbd59d27638b5df}

\begin{DoxyCompactList}\small\item\em Set \hyperlink{protocolthe-p}{the} type of this route to \char`\"{}a replacement route\char`\"{}. \item\end{DoxyCompactList}\item 
\hypertarget{classStaticRoute_ae782ac795a7fcd6dd3e3e269f2323795}{
void \hyperlink{classStaticRoute_ae782ac795a7fcd6dd3e3e269f2323795}{set\_\-delete\_\-route} ()}
\label{classStaticRoute_ae782ac795a7fcd6dd3e3e269f2323795}

\begin{DoxyCompactList}\small\item\em Set \hyperlink{protocolthe-p}{the} type of this route to \char`\"{}a route to delete\char`\"{}. \item\end{DoxyCompactList}\item 
bool \hyperlink{classStaticRoute_ac6c559d8ce8906c53bea2ca4ffd53035}{is\_\-interface\_\-route} () const 
\begin{DoxyCompactList}\small\item\em Test if \hyperlink{protocolthe-p}{the} route is interface-\/specific (e.g., if \hyperlink{protocolthe-p}{the} interface is explicitly specified). \item\end{DoxyCompactList}\item 
bool \hyperlink{classStaticRoute_ac7c699e57d9aefd138be323726829724}{is\_\-valid\_\-entry} (string \&error\_\-msg) const 
\begin{DoxyCompactList}\small\item\em Check whether \hyperlink{protocolthe-p}{the} route entry is valid. \item\end{DoxyCompactList}\item 
bool \hyperlink{classStaticRoute_abb12992a57fac409623971491b395cbe}{is\_\-ignored} () const 
\begin{DoxyCompactList}\small\item\em Test if \hyperlink{protocolthe-p}{the} route is to be ignored. \item\end{DoxyCompactList}\item 
void \hyperlink{classStaticRoute_a7d25c459b72eefed196c5037783d08c1}{set\_\-ignored} (bool v)
\begin{DoxyCompactList}\small\item\em Set whether \hyperlink{protocolthe-p}{the} route is to be ignored. \item\end{DoxyCompactList}\item 
\hyperlink{classPolicyTags}{PolicyTags} \& \hyperlink{classStaticRoute_ae62dcbc2836850de7ecfe20ae09161b7}{policytags} ()
\item 
bool \hyperlink{classStaticRoute_a97484f0ed9c2b0124ccdbb5224e5335b}{is\_\-filtered} () const 
\begin{DoxyCompactList}\small\item\em Test whether \hyperlink{protocolthe-p}{the} route has been rejected by a policy filter. \item\end{DoxyCompactList}\item 
void \hyperlink{classStaticRoute_a99e2d6b0b7b5fbf8828c760a3dcaf779}{set\_\-filtered} (bool v)
\begin{DoxyCompactList}\small\item\em Set a flag that indicates whether \hyperlink{protocolthe-p}{the} route is to be considered filtered \mbox{[}rejected by \hyperlink{protocolthe-p}{the} policy filter\mbox{]}. \item\end{DoxyCompactList}\item 
bool \hyperlink{classStaticRoute_ab81d208510e0c63b753c52f901264608}{is\_\-accepted\_\-by\_\-nexthop} () const 
\begin{DoxyCompactList}\small\item\em Test whether \hyperlink{protocolthe-p}{the} route is accepted based on its next-\/hop information. \item\end{DoxyCompactList}\item 
void \hyperlink{classStaticRoute_a76d7f9a484d1d7697b45d6897634ee96}{set\_\-accepted\_\-by\_\-nexthop} (bool v)
\begin{DoxyCompactList}\small\item\em Set a flag that indicates whether \hyperlink{protocolthe-p}{the} route is accepted based on its next-\/hop information. \item\end{DoxyCompactList}\item 
bool \hyperlink{classStaticRoute_a3888e61e364ac8ec076608d6cf00eecf}{is\_\-accepted\_\-by\_\-rib} () const 
\begin{DoxyCompactList}\small\item\em Test whether \hyperlink{protocolthe-p}{the} route is accepted for transmission to \hyperlink{protocolthe-p}{the} \hyperlink{classRIB}{RIB}. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Private Types}
\begin{DoxyCompactItemize}
\item 
enum {\bfseries RouteType} \{ {\bfseries IDLE\_\-ROUTE}, 
{\bfseries ADD\_\-ROUTE}, 
{\bfseries REPLACE\_\-ROUTE}, 
{\bfseries DELETE\_\-ROUTE}
 \}
\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classStaticRoute_a1b4be48eb29a8f06c8fb8243ae8e594f}{
bool {\bfseries \_\-unicast}}
\label{classStaticRoute_a1b4be48eb29a8f06c8fb8243ae8e594f}

\item 
\hypertarget{classStaticRoute_aec5e93282e8503d8a735975dd3338b1b}{
bool {\bfseries \_\-multicast}}
\label{classStaticRoute_aec5e93282e8503d8a735975dd3338b1b}

\item 
\hypertarget{classStaticRoute_ac4b4f01d13bd10a876a0693dc0fceed7}{
\hyperlink{classIPvXNet}{IPvXNet} {\bfseries \_\-network}}
\label{classStaticRoute_ac4b4f01d13bd10a876a0693dc0fceed7}

\item 
\hypertarget{classStaticRoute_a8a2d265f73d922a527f2a6f9418842b8}{
\hyperlink{classIPvX}{IPvX} {\bfseries \_\-nexthop}}
\label{classStaticRoute_a8a2d265f73d922a527f2a6f9418842b8}

\item 
\hypertarget{classStaticRoute_a22b80aa372dcafcd13ca9acc91451d2b}{
string {\bfseries \_\-ifname}}
\label{classStaticRoute_a22b80aa372dcafcd13ca9acc91451d2b}

\item 
\hypertarget{classStaticRoute_ae794890264c9e652d99ec4a8dbb09399}{
string {\bfseries \_\-vifname}}
\label{classStaticRoute_ae794890264c9e652d99ec4a8dbb09399}

\item 
\hypertarget{classStaticRoute_a078c201fe6772103427f4faec4171273}{
uint32\_\-t {\bfseries \_\-metric}}
\label{classStaticRoute_a078c201fe6772103427f4faec4171273}

\item 
\hypertarget{classStaticRoute_a2c5408915970a6500dddbc752ba50ef9}{
bool {\bfseries \_\-is\_\-backup\_\-route}}
\label{classStaticRoute_a2c5408915970a6500dddbc752ba50ef9}

\item 
\hypertarget{classStaticRoute_a8c0aa4ebf5701eb9afe969bd9291f9c5}{
RouteType {\bfseries \_\-route\_\-type}}
\label{classStaticRoute_a8c0aa4ebf5701eb9afe969bd9291f9c5}

\item 
\hypertarget{classStaticRoute_a7def62dee1cd35480c0b5e014f9cf8f4}{
bool {\bfseries \_\-is\_\-ignored}}
\label{classStaticRoute_a7def62dee1cd35480c0b5e014f9cf8f4}

\item 
\hypertarget{classStaticRoute_aaa26fab6309f87b0fe7dccaa0c610fe4}{
bool {\bfseries \_\-is\_\-filtered}}
\label{classStaticRoute_aaa26fab6309f87b0fe7dccaa0c610fe4}

\item 
\hypertarget{classStaticRoute_a8f15b9533ee4468c66df342b018ef08e}{
bool {\bfseries \_\-is\_\-accepted\_\-by\_\-nexthop}}
\label{classStaticRoute_a8f15b9533ee4468c66df342b018ef08e}

\item 
\hypertarget{classStaticRoute_a09ad5f6531f1ea57657be441da38eb26}{
\hyperlink{classPolicyTags}{PolicyTags} {\bfseries \_\-policytags}}
\label{classStaticRoute_a09ad5f6531f1ea57657be441da38eb26}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
A \hyperlink{classStaticRoute}{StaticRoute} helper class. This class is used to store a routing entry. 

\subsection{Constructor \& Destructor Documentation}
\hypertarget{classStaticRoute_ae9e11faddf939d4cff6d3b3ced222be4}{
\index{StaticRoute@{StaticRoute}!StaticRoute@{StaticRoute}}
\index{StaticRoute@{StaticRoute}!StaticRoute@{StaticRoute}}
\subsubsection[{StaticRoute}]{\setlength{\rightskip}{0pt plus 5cm}StaticRoute::StaticRoute (
\begin{DoxyParamCaption}
\item[{bool}]{unicast, }
\item[{bool}]{multicast, }
\item[{const {\bf IPv4Net} \&}]{network, }
\item[{const {\bf IPv4} \&}]{nexthop, }
\item[{const string \&}]{ifname, }
\item[{const string \&}]{vifname, }
\item[{uint32\_\-t}]{metric, }
\item[{bool}]{is\_\-backup\_\-route}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_ae9e11faddf939d4cff6d3b3ced222be4}


Constructor for a given \hyperlink{classIPv4}{IPv4} static route. 


\begin{DoxyParams}{Parameters}
{\em unicast} & if true, then \hyperlink{protocolthe-p}{the} route would be used for unicast routing. \\
\hline
{\em multicast} & if true, then \hyperlink{protocolthe-p}{the} route would be used in \hyperlink{protocolthe-p}{the} MRIB (Multicast \hyperlink{classRouting}{Routing} Information Base) for multicast purpose (e.g., computing \hyperlink{protocolthe-p}{the} Reverse-\/Path Forwarding information). \\
\hline
{\em network} & \hyperlink{protocolthe-p}{the} network address prefix this route applies to. \\
\hline
{\em nexthop} & \hyperlink{protocolthe-p}{the} address of \hyperlink{protocolthe-p}{the} next-\/hop router for this route. \\
\hline
{\em ifname} & of \hyperlink{protocolthe-p}{the} name of \hyperlink{protocolthe-p}{the} physical interface toward \hyperlink{protocolthe-p}{the} destination. \\
\hline
{\em vifname} & of \hyperlink{protocolthe-p}{the} name of \hyperlink{protocolthe-p}{the} virtual interface toward \hyperlink{protocolthe-p}{the} destination. \\
\hline
{\em metric} & \hyperlink{protocolthe-p}{the} metric distance for this route. \\
\hline
{\em is\_\-backup\_\-route} & if true, then this is a backup route. \\
\hline
\end{DoxyParams}
\hypertarget{classStaticRoute_a68c41a92cc915c5557b3e450bb12499f}{
\index{StaticRoute@{StaticRoute}!StaticRoute@{StaticRoute}}
\index{StaticRoute@{StaticRoute}!StaticRoute@{StaticRoute}}
\subsubsection[{StaticRoute}]{\setlength{\rightskip}{0pt plus 5cm}StaticRoute::StaticRoute (
\begin{DoxyParamCaption}
\item[{bool}]{unicast, }
\item[{bool}]{multicast, }
\item[{const {\bf IPv6Net} \&}]{network, }
\item[{const {\bf IPv6} \&}]{nexthop, }
\item[{const string \&}]{ifname, }
\item[{const string \&}]{vifname, }
\item[{uint32\_\-t}]{metric, }
\item[{bool}]{is\_\-backup\_\-route}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_a68c41a92cc915c5557b3e450bb12499f}


Constructor for a given \hyperlink{classIPv6}{IPv6} static route. 


\begin{DoxyParams}{Parameters}
{\em unicast} & if true, then \hyperlink{protocolthe-p}{the} route would be used for unicast routing. \\
\hline
{\em multicast} & if true, then \hyperlink{protocolthe-p}{the} route would be used in \hyperlink{protocolthe-p}{the} MRIB (Multicast \hyperlink{classRouting}{Routing} Information Base) for multicast purpose (e.g., computing \hyperlink{protocolthe-p}{the} Reverse-\/Path Forwarding information). \\
\hline
{\em network} & \hyperlink{protocolthe-p}{the} network address prefix this route applies to. \\
\hline
{\em nexthop} & \hyperlink{protocolthe-p}{the} address of \hyperlink{protocolthe-p}{the} next-\/hop router for this route. \\
\hline
{\em ifname} & of \hyperlink{protocolthe-p}{the} name of \hyperlink{protocolthe-p}{the} physical interface toward \hyperlink{protocolthe-p}{the} destination. \\
\hline
{\em vifname} & of \hyperlink{protocolthe-p}{the} name of \hyperlink{protocolthe-p}{the} virtual interface toward \hyperlink{protocolthe-p}{the} destination. \\
\hline
{\em metric} & \hyperlink{protocolthe-p}{the} metric distance for this route. \\
\hline
{\em is\_\-backup\_\-route} & if true, then this is a backup route. \\
\hline
\end{DoxyParams}


\subsection{Member Function Documentation}
\hypertarget{classStaticRoute_af6506d870b14aeadeb1c0270b6a90222}{
\index{StaticRoute@{StaticRoute}!ifname@{ifname}}
\index{ifname@{ifname}!StaticRoute@{StaticRoute}}
\subsubsection[{ifname}]{\setlength{\rightskip}{0pt plus 5cm}const string\& StaticRoute::ifname (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_af6506d870b14aeadeb1c0270b6a90222}


Get \hyperlink{protocolthe-p}{the} name of \hyperlink{protocolthe-p}{the} physical interface toward \hyperlink{protocolthe-p}{the} destination. 

\begin{DoxyReturn}{Returns}
\hyperlink{protocolthe-p}{the} name of \hyperlink{protocolthe-p}{the} physical interface toward \hyperlink{protocolthe-p}{the} destination. 
\end{DoxyReturn}
\hypertarget{classStaticRoute_ab81d208510e0c63b753c52f901264608}{
\index{StaticRoute@{StaticRoute}!is\_\-accepted\_\-by\_\-nexthop@{is\_\-accepted\_\-by\_\-nexthop}}
\index{is\_\-accepted\_\-by\_\-nexthop@{is\_\-accepted\_\-by\_\-nexthop}!StaticRoute@{StaticRoute}}
\subsubsection[{is\_\-accepted\_\-by\_\-nexthop}]{\setlength{\rightskip}{0pt plus 5cm}bool StaticRoute::is\_\-accepted\_\-by\_\-nexthop (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_ab81d208510e0c63b753c52f901264608}


Test whether \hyperlink{protocolthe-p}{the} route is accepted based on its next-\/hop information. 

\begin{DoxyReturn}{Returns}
true if \hyperlink{protocolthe-p}{the} route is accepted based on its next-\/hop information, otherwise false. 
\end{DoxyReturn}
\hypertarget{classStaticRoute_a3888e61e364ac8ec076608d6cf00eecf}{
\index{StaticRoute@{StaticRoute}!is\_\-accepted\_\-by\_\-rib@{is\_\-accepted\_\-by\_\-rib}}
\index{is\_\-accepted\_\-by\_\-rib@{is\_\-accepted\_\-by\_\-rib}!StaticRoute@{StaticRoute}}
\subsubsection[{is\_\-accepted\_\-by\_\-rib}]{\setlength{\rightskip}{0pt plus 5cm}bool StaticRoute::is\_\-accepted\_\-by\_\-rib (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}
\label{classStaticRoute_a3888e61e364ac8ec076608d6cf00eecf}


Test whether \hyperlink{protocolthe-p}{the} route is accepted for transmission to \hyperlink{protocolthe-p}{the} \hyperlink{classRIB}{RIB}. 

\begin{DoxyReturn}{Returns}
true if route is accepted for transmission to \hyperlink{protocolthe-p}{the} \hyperlink{classRIB}{RIB}, otherwise false. 
\end{DoxyReturn}
\hypertarget{classStaticRoute_ad7e667e3afb8c73a85e248bc56c03b5c}{
\index{StaticRoute@{StaticRoute}!is\_\-add\_\-route@{is\_\-add\_\-route}}
\index{is\_\-add\_\-route@{is\_\-add\_\-route}!StaticRoute@{StaticRoute}}
\subsubsection[{is\_\-add\_\-route}]{\setlength{\rightskip}{0pt plus 5cm}bool StaticRoute::is\_\-add\_\-route (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_ad7e667e3afb8c73a85e248bc56c03b5c}


Test if this is a route to add. 

\begin{DoxyReturn}{Returns}
true if this is a route to add, otherwise false. 
\end{DoxyReturn}
\hypertarget{classStaticRoute_ac164acd0cb8cc55cbd982d29558e101e}{
\index{StaticRoute@{StaticRoute}!is\_\-backup\_\-route@{is\_\-backup\_\-route}}
\index{is\_\-backup\_\-route@{is\_\-backup\_\-route}!StaticRoute@{StaticRoute}}
\subsubsection[{is\_\-backup\_\-route}]{\setlength{\rightskip}{0pt plus 5cm}bool StaticRoute::is\_\-backup\_\-route (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_ac164acd0cb8cc55cbd982d29558e101e}


Test if this is a backup route. 

\begin{DoxyReturn}{Returns}
truf if this is a backup route, otherwise false. 
\end{DoxyReturn}
\hypertarget{classStaticRoute_a70e8ccda2157ff35f907339b04e88827}{
\index{StaticRoute@{StaticRoute}!is\_\-delete\_\-route@{is\_\-delete\_\-route}}
\index{is\_\-delete\_\-route@{is\_\-delete\_\-route}!StaticRoute@{StaticRoute}}
\subsubsection[{is\_\-delete\_\-route}]{\setlength{\rightskip}{0pt plus 5cm}bool StaticRoute::is\_\-delete\_\-route (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_a70e8ccda2157ff35f907339b04e88827}


Test if this is a route to delete. 

\begin{DoxyReturn}{Returns}
true if this is a route to delete, otherwise false. 
\end{DoxyReturn}
\hypertarget{classStaticRoute_a97484f0ed9c2b0124ccdbb5224e5335b}{
\index{StaticRoute@{StaticRoute}!is\_\-filtered@{is\_\-filtered}}
\index{is\_\-filtered@{is\_\-filtered}!StaticRoute@{StaticRoute}}
\subsubsection[{is\_\-filtered}]{\setlength{\rightskip}{0pt plus 5cm}bool StaticRoute::is\_\-filtered (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_a97484f0ed9c2b0124ccdbb5224e5335b}


Test whether \hyperlink{protocolthe-p}{the} route has been rejected by a policy filter. 

\begin{DoxyReturn}{Returns}
true if route has been rejected by a policy filter, otherwise false. 
\end{DoxyReturn}
\hypertarget{classStaticRoute_abb12992a57fac409623971491b395cbe}{
\index{StaticRoute@{StaticRoute}!is\_\-ignored@{is\_\-ignored}}
\index{is\_\-ignored@{is\_\-ignored}!StaticRoute@{StaticRoute}}
\subsubsection[{is\_\-ignored}]{\setlength{\rightskip}{0pt plus 5cm}bool StaticRoute::is\_\-ignored (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_abb12992a57fac409623971491b395cbe}


Test if \hyperlink{protocolthe-p}{the} route is to be ignored. 

This method is used only for internal purpose when passing \hyperlink{protocolthe-p}{the} route around.

\begin{DoxyReturn}{Returns}
true if \hyperlink{protocolthe-p}{the} route is to be ignored, otherwise false. 
\end{DoxyReturn}
\hypertarget{classStaticRoute_ac6c559d8ce8906c53bea2ca4ffd53035}{
\index{StaticRoute@{StaticRoute}!is\_\-interface\_\-route@{is\_\-interface\_\-route}}
\index{is\_\-interface\_\-route@{is\_\-interface\_\-route}!StaticRoute@{StaticRoute}}
\subsubsection[{is\_\-interface\_\-route}]{\setlength{\rightskip}{0pt plus 5cm}bool StaticRoute::is\_\-interface\_\-route (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_ac6c559d8ce8906c53bea2ca4ffd53035}


Test if \hyperlink{protocolthe-p}{the} route is interface-\/specific (e.g., if \hyperlink{protocolthe-p}{the} interface is explicitly specified). 

\begin{DoxyReturn}{Returns}
true if \hyperlink{protocolthe-p}{the} route is interface-\/specific, otherwise false. 
\end{DoxyReturn}
\hypertarget{classStaticRoute_a17f955c3be880e4c6aa915882d7e9e63}{
\index{StaticRoute@{StaticRoute}!is\_\-ipv4@{is\_\-ipv4}}
\index{is\_\-ipv4@{is\_\-ipv4}!StaticRoute@{StaticRoute}}
\subsubsection[{is\_\-ipv4}]{\setlength{\rightskip}{0pt plus 5cm}bool StaticRoute::is\_\-ipv4 (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_a17f955c3be880e4c6aa915882d7e9e63}


Test if this is an \hyperlink{classIPv4}{IPv4} route. 

\begin{DoxyReturn}{Returns}
true if this is an \hyperlink{classIPv4}{IPv4} route, otherwise false. 
\end{DoxyReturn}
\hypertarget{classStaticRoute_a69380ca0613413fbc3ea7be7050b8c83}{
\index{StaticRoute@{StaticRoute}!is\_\-ipv6@{is\_\-ipv6}}
\index{is\_\-ipv6@{is\_\-ipv6}!StaticRoute@{StaticRoute}}
\subsubsection[{is\_\-ipv6}]{\setlength{\rightskip}{0pt plus 5cm}bool StaticRoute::is\_\-ipv6 (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_a69380ca0613413fbc3ea7be7050b8c83}


Test if this is an \hyperlink{classIPv6}{IPv6} route. 

\begin{DoxyReturn}{Returns}
true if this is an \hyperlink{classIPv6}{IPv6} route, otherwise false. 
\end{DoxyReturn}
\hypertarget{classStaticRoute_ab43919cd225d8d21934db58d841d656e}{
\index{StaticRoute@{StaticRoute}!is\_\-replace\_\-route@{is\_\-replace\_\-route}}
\index{is\_\-replace\_\-route@{is\_\-replace\_\-route}!StaticRoute@{StaticRoute}}
\subsubsection[{is\_\-replace\_\-route}]{\setlength{\rightskip}{0pt plus 5cm}bool StaticRoute::is\_\-replace\_\-route (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_ab43919cd225d8d21934db58d841d656e}


Test if this is a replacement route. 

\begin{DoxyReturn}{Returns}
true if this is a replacement route, otherwise false. 
\end{DoxyReturn}
\hypertarget{classStaticRoute_acfdebeb73effba5c7c8f9ada9b8b20fa}{
\index{StaticRoute@{StaticRoute}!is\_\-same\_\-route@{is\_\-same\_\-route}}
\index{is\_\-same\_\-route@{is\_\-same\_\-route}!StaticRoute@{StaticRoute}}
\subsubsection[{is\_\-same\_\-route}]{\setlength{\rightskip}{0pt plus 5cm}bool StaticRoute::is\_\-same\_\-route (
\begin{DoxyParamCaption}
\item[{const {\bf StaticRoute} \&}]{other}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_acfdebeb73effba5c7c8f9ada9b8b20fa}


Test whether both routes contain same routing information. 


\begin{DoxyParams}{Parameters}
{\em other} & \hyperlink{protocolthe-p}{the} route to compare against. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if both routes contain same routing information, otherwise false. 
\end{DoxyReturn}
\hypertarget{classStaticRoute_ac7c699e57d9aefd138be323726829724}{
\index{StaticRoute@{StaticRoute}!is\_\-valid\_\-entry@{is\_\-valid\_\-entry}}
\index{is\_\-valid\_\-entry@{is\_\-valid\_\-entry}!StaticRoute@{StaticRoute}}
\subsubsection[{is\_\-valid\_\-entry}]{\setlength{\rightskip}{0pt plus 5cm}bool StaticRoute::is\_\-valid\_\-entry (
\begin{DoxyParamCaption}
\item[{string \&}]{error\_\-msg}
\end{DoxyParamCaption}
) const}}
\label{classStaticRoute_ac7c699e57d9aefd138be323726829724}


Check whether \hyperlink{protocolthe-p}{the} route entry is valid. 


\begin{DoxyParams}{Parameters}
{\em error\_\-msg} & \hyperlink{protocolthe-p}{the} error message (if error). \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if \hyperlink{protocolthe-p}{the} route entry is valid, otherwise false. 
\end{DoxyReturn}
\hypertarget{classStaticRoute_a0aa94d376c5179100ed6954f800b8ea8}{
\index{StaticRoute@{StaticRoute}!metric@{metric}}
\index{metric@{metric}!StaticRoute@{StaticRoute}}
\subsubsection[{metric}]{\setlength{\rightskip}{0pt plus 5cm}uint32\_\-t StaticRoute::metric (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_a0aa94d376c5179100ed6954f800b8ea8}


Get \hyperlink{protocolthe-p}{the} metric distance for this route. 

\begin{DoxyReturn}{Returns}
\hyperlink{protocolthe-p}{the} metric distance for this route. 
\end{DoxyReturn}
\hypertarget{classStaticRoute_a4a1c7c5a674bf6f1c06c2296baf898ee}{
\index{StaticRoute@{StaticRoute}!multicast@{multicast}}
\index{multicast@{multicast}!StaticRoute@{StaticRoute}}
\subsubsection[{multicast}]{\setlength{\rightskip}{0pt plus 5cm}bool StaticRoute::multicast (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_a4a1c7c5a674bf6f1c06c2296baf898ee}


Test if this route would be used for multicast routing. 

\begin{DoxyReturn}{Returns}
true if this route would be used for multicast routing, otherwise false. 
\end{DoxyReturn}
\hypertarget{classStaticRoute_ad6b91d9970f8d81d3bf04d88d71d9e9f}{
\index{StaticRoute@{StaticRoute}!network@{network}}
\index{network@{network}!StaticRoute@{StaticRoute}}
\subsubsection[{network}]{\setlength{\rightskip}{0pt plus 5cm}const {\bf IPvXNet}\& StaticRoute::network (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_ad6b91d9970f8d81d3bf04d88d71d9e9f}


Get \hyperlink{protocolthe-p}{the} network address prefix this route applies to. 

\begin{DoxyReturn}{Returns}
\hyperlink{protocolthe-p}{the} network address prefix this route appies to. 
\end{DoxyReturn}
\hypertarget{classStaticRoute_adf551e5395598d851870f6ceee0dd7e6}{
\index{StaticRoute@{StaticRoute}!nexthop@{nexthop}}
\index{nexthop@{nexthop}!StaticRoute@{StaticRoute}}
\subsubsection[{nexthop}]{\setlength{\rightskip}{0pt plus 5cm}const {\bf IPvX}\& StaticRoute::nexthop (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_adf551e5395598d851870f6ceee0dd7e6}


Get \hyperlink{protocolthe-p}{the} address of \hyperlink{protocolthe-p}{the} next-\/hop router for this route. 

\begin{DoxyReturn}{Returns}
\hyperlink{protocolthe-p}{the} address of \hyperlink{protocolthe-p}{the} next-\/hop router for this route. 
\end{DoxyReturn}
\hypertarget{classStaticRoute_ad2e36e7d5fb70919ba5f3b75c8f7b51b}{
\index{StaticRoute@{StaticRoute}!operator==@{operator==}}
\index{operator==@{operator==}!StaticRoute@{StaticRoute}}
\subsubsection[{operator==}]{\setlength{\rightskip}{0pt plus 5cm}bool StaticRoute::operator== (
\begin{DoxyParamCaption}
\item[{const {\bf StaticRoute} \&}]{other}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_ad2e36e7d5fb70919ba5f3b75c8f7b51b}


Equality Operator. 


\begin{DoxyParams}{Parameters}
{\em other} & \hyperlink{protocolthe-p}{the} right-\/hand operand to compare against. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if \hyperlink{protocolthe-p}{the} left-\/hand operand is numerically same as \hyperlink{protocolthe-p}{the} right-\/hand operand. 
\end{DoxyReturn}
\hypertarget{classStaticRoute_ae62dcbc2836850de7ecfe20ae09161b7}{
\index{StaticRoute@{StaticRoute}!policytags@{policytags}}
\index{policytags@{policytags}!StaticRoute@{StaticRoute}}
\subsubsection[{policytags}]{\setlength{\rightskip}{0pt plus 5cm}{\bf PolicyTags}\& StaticRoute::policytags (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_ae62dcbc2836850de7ecfe20ae09161b7}
\begin{DoxyReturn}{Returns}
policy-\/tags for this route. 
\end{DoxyReturn}
\hypertarget{classStaticRoute_a76d7f9a484d1d7697b45d6897634ee96}{
\index{StaticRoute@{StaticRoute}!set\_\-accepted\_\-by\_\-nexthop@{set\_\-accepted\_\-by\_\-nexthop}}
\index{set\_\-accepted\_\-by\_\-nexthop@{set\_\-accepted\_\-by\_\-nexthop}!StaticRoute@{StaticRoute}}
\subsubsection[{set\_\-accepted\_\-by\_\-nexthop}]{\setlength{\rightskip}{0pt plus 5cm}void StaticRoute::set\_\-accepted\_\-by\_\-nexthop (
\begin{DoxyParamCaption}
\item[{bool}]{v}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_a76d7f9a484d1d7697b45d6897634ee96}


Set a flag that indicates whether \hyperlink{protocolthe-p}{the} route is accepted based on its next-\/hop information. 


\begin{DoxyParams}{Parameters}
{\em v} & true if \hyperlink{protocolthe-p}{the} route is accepted based on its next-\/hop information, otherwise false. \\
\hline
\end{DoxyParams}
\hypertarget{classStaticRoute_a99e2d6b0b7b5fbf8828c760a3dcaf779}{
\index{StaticRoute@{StaticRoute}!set\_\-filtered@{set\_\-filtered}}
\index{set\_\-filtered@{set\_\-filtered}!StaticRoute@{StaticRoute}}
\subsubsection[{set\_\-filtered}]{\setlength{\rightskip}{0pt plus 5cm}void StaticRoute::set\_\-filtered (
\begin{DoxyParamCaption}
\item[{bool}]{v}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_a99e2d6b0b7b5fbf8828c760a3dcaf779}


Set a flag that indicates whether \hyperlink{protocolthe-p}{the} route is to be considered filtered \mbox{[}rejected by \hyperlink{protocolthe-p}{the} policy filter\mbox{]}. 


\begin{DoxyParams}{Parameters}
{\em v} & true if \hyperlink{protocolthe-p}{the} route should be considered filtered, otherwise false. \\
\hline
\end{DoxyParams}
\hypertarget{classStaticRoute_a02ea9df2ea6b0e79a672ab32029791d3}{
\index{StaticRoute@{StaticRoute}!set\_\-ifname@{set\_\-ifname}}
\index{set\_\-ifname@{set\_\-ifname}!StaticRoute@{StaticRoute}}
\subsubsection[{set\_\-ifname}]{\setlength{\rightskip}{0pt plus 5cm}void StaticRoute::set\_\-ifname (
\begin{DoxyParamCaption}
\item[{const string \&}]{v}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_a02ea9df2ea6b0e79a672ab32029791d3}


Set \hyperlink{protocolthe-p}{the} name of \hyperlink{protocolthe-p}{the} physical interface toward \hyperlink{protocolthe-p}{the} destination. 


\begin{DoxyParams}{Parameters}
{\em v} & \hyperlink{protocolthe-p}{the} name of \hyperlink{protocolthe-p}{the} physical interface toward \hyperlink{protocolthe-p}{the} destination. \\
\hline
\end{DoxyParams}
\hypertarget{classStaticRoute_a7d25c459b72eefed196c5037783d08c1}{
\index{StaticRoute@{StaticRoute}!set\_\-ignored@{set\_\-ignored}}
\index{set\_\-ignored@{set\_\-ignored}!StaticRoute@{StaticRoute}}
\subsubsection[{set\_\-ignored}]{\setlength{\rightskip}{0pt plus 5cm}void StaticRoute::set\_\-ignored (
\begin{DoxyParamCaption}
\item[{bool}]{v}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_a7d25c459b72eefed196c5037783d08c1}


Set whether \hyperlink{protocolthe-p}{the} route is to be ignored. 

This method is used only for internal purpose when passing \hyperlink{protocolthe-p}{the} route around.


\begin{DoxyParams}{Parameters}
{\em v} & true if \hyperlink{protocolthe-p}{the} route is to be ignored, otherwise false. \\
\hline
\end{DoxyParams}
\hypertarget{classStaticRoute_a41e79d61e3dacafd67b92753502c7dcd}{
\index{StaticRoute@{StaticRoute}!set\_\-nexthop@{set\_\-nexthop}}
\index{set\_\-nexthop@{set\_\-nexthop}!StaticRoute@{StaticRoute}}
\subsubsection[{set\_\-nexthop}]{\setlength{\rightskip}{0pt plus 5cm}void StaticRoute::set\_\-nexthop (
\begin{DoxyParamCaption}
\item[{const {\bf IPvX} \&}]{v}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_a41e79d61e3dacafd67b92753502c7dcd}


Set \hyperlink{protocolthe-p}{the} address of \hyperlink{protocolthe-p}{the} next-\/hop router for this route. 


\begin{DoxyParams}{Parameters}
{\em v} & \hyperlink{protocolthe-p}{the} address of \hyperlink{protocolthe-p}{the} next-\/hop router for this route. \\
\hline
\end{DoxyParams}
\hypertarget{classStaticRoute_a803a9ef5fc3008c5172a760cb2dfde18}{
\index{StaticRoute@{StaticRoute}!set\_\-vifname@{set\_\-vifname}}
\index{set\_\-vifname@{set\_\-vifname}!StaticRoute@{StaticRoute}}
\subsubsection[{set\_\-vifname}]{\setlength{\rightskip}{0pt plus 5cm}void StaticRoute::set\_\-vifname (
\begin{DoxyParamCaption}
\item[{const string \&}]{v}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_a803a9ef5fc3008c5172a760cb2dfde18}


Set \hyperlink{protocolthe-p}{the} name of \hyperlink{protocolthe-p}{the} virtual interface toward \hyperlink{protocolthe-p}{the} destination. 


\begin{DoxyParams}{Parameters}
{\em v} & \hyperlink{protocolthe-p}{the} name of \hyperlink{protocolthe-p}{the} virtual interface toward \hyperlink{protocolthe-p}{the} destination. \\
\hline
\end{DoxyParams}
\hypertarget{classStaticRoute_a74299bd8632a6c4c98e80072bac017c1}{
\index{StaticRoute@{StaticRoute}!unicast@{unicast}}
\index{unicast@{unicast}!StaticRoute@{StaticRoute}}
\subsubsection[{unicast}]{\setlength{\rightskip}{0pt plus 5cm}bool StaticRoute::unicast (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_a74299bd8632a6c4c98e80072bac017c1}


Test if this route would be used for unicast routing. 

\begin{DoxyReturn}{Returns}
true if this route would be used for unicast routing, otherwise false. 
\end{DoxyReturn}
\hypertarget{classStaticRoute_a1f4aad9ffaa60f3ffe2267f8d6c8ce08}{
\index{StaticRoute@{StaticRoute}!vifname@{vifname}}
\index{vifname@{vifname}!StaticRoute@{StaticRoute}}
\subsubsection[{vifname}]{\setlength{\rightskip}{0pt plus 5cm}const string\& StaticRoute::vifname (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classStaticRoute_a1f4aad9ffaa60f3ffe2267f8d6c8ce08}


Get \hyperlink{protocolthe-p}{the} name of \hyperlink{protocolthe-p}{the} virtual interface toward \hyperlink{protocolthe-p}{the} destination. 

\begin{DoxyReturn}{Returns}
\hyperlink{protocolthe-p}{the} name of \hyperlink{protocolthe-p}{the} virtual interface toward \hyperlink{protocolthe-p}{the} destination. 
\end{DoxyReturn}


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\_\-node.hh\item 
/home/greearb/git/xorp.ct.github/xorp/static\_\-routes/static\_\-routes\_\-node.cc\end{DoxyCompactItemize}
