\hypertarget{classFilterBase}{
\section{FilterBase Class Reference}
\label{classFilterBase}\index{FilterBase@{FilterBase}}
}


Base class for all policy filters.  




{\ttfamily \#include $<$filter\_\-base.hh$>$}

Inheritance diagram for FilterBase:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classFilterBase}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual void \hyperlink{classFilterBase_afb5726167c1530611499febf7bfc9835}{configure} (const string \&str)=0
\begin{DoxyCompactList}\small\item\em Configure \hyperlink{protocolthe-p}{the} filter. \item\end{DoxyCompactList}\item 
virtual void \hyperlink{classFilterBase_a0c8325520c41f4c475a9f8e831ca273c}{reset} ()=0
\begin{DoxyCompactList}\small\item\em Reset \hyperlink{protocolthe-p}{the} filter. \item\end{DoxyCompactList}\item 
virtual bool \hyperlink{classFilterBase_a3c2be411c10e8d42fe9ac69edd7378ff}{acceptRoute} (\hyperlink{classVarRW}{VarRW} \&varrw)=0
\begin{DoxyCompactList}\small\item\em See if a route is accepted by \hyperlink{protocolthe-p}{the} filter. \item\end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Base class for all policy filters. 

\subsection{Member Function Documentation}
\hypertarget{classFilterBase_a3c2be411c10e8d42fe9ac69edd7378ff}{
\index{FilterBase@{FilterBase}!acceptRoute@{acceptRoute}}
\index{acceptRoute@{acceptRoute}!FilterBase@{FilterBase}}
\subsubsection[{acceptRoute}]{\setlength{\rightskip}{0pt plus 5cm}virtual bool FilterBase::acceptRoute (
\begin{DoxyParamCaption}
\item[{{\bf VarRW} \&}]{varrw}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}
\label{classFilterBase_a3c2be411c10e8d42fe9ac69edd7378ff}


See if a route is accepted by \hyperlink{protocolthe-p}{the} filter. 

The route may be modified by \hyperlink{protocolthe-p}{the} filter \mbox{[}through \hyperlink{classVarRW}{VarRW}\mbox{]}.

\begin{DoxyReturn}{Returns}
true if \hyperlink{protocolthe-p}{the} route is accepted, false otherwise. 
\end{DoxyReturn}

\begin{DoxyParams}{Parameters}
{\em varrw} & \hyperlink{protocolthe-p}{the} \hyperlink{classVarRW}{VarRW} associated with \hyperlink{protocolthe-p}{the} route being filtered. \\
\hline
\end{DoxyParams}


Implemented in \hyperlink{classPolicyFilter_a34c3836c98bfb913645b9f447510d46e}{PolicyFilter}, and \hyperlink{classVersionFilter_abced89d9bb375753e185b2700def56ca}{VersionFilter}.

\hypertarget{classFilterBase_afb5726167c1530611499febf7bfc9835}{
\index{FilterBase@{FilterBase}!configure@{configure}}
\index{configure@{configure}!FilterBase@{FilterBase}}
\subsubsection[{configure}]{\setlength{\rightskip}{0pt plus 5cm}virtual void FilterBase::configure (
\begin{DoxyParamCaption}
\item[{const string \&}]{str}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}
\label{classFilterBase_afb5726167c1530611499febf7bfc9835}


Configure \hyperlink{protocolthe-p}{the} filter. 


\begin{DoxyParams}{Parameters}
{\em str} & filter configuration. \\
\hline
\end{DoxyParams}


Implemented in \hyperlink{classPolicyFilter_a992b938c2a0c1a2d15d11ea663d65824}{PolicyFilter}, and \hyperlink{classVersionFilter_a89e537f3adb6c1519e3b3e554ffb8af5}{VersionFilter}.

\hypertarget{classFilterBase_a0c8325520c41f4c475a9f8e831ca273c}{
\index{FilterBase@{FilterBase}!reset@{reset}}
\index{reset@{reset}!FilterBase@{FilterBase}}
\subsubsection[{reset}]{\setlength{\rightskip}{0pt plus 5cm}virtual void FilterBase::reset (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}
\label{classFilterBase_a0c8325520c41f4c475a9f8e831ca273c}


Reset \hyperlink{protocolthe-p}{the} filter. 

Filter becomes a NO-\/operation -\/-\/ default action should be returned everytime an acceptRoute is called. 

Implemented in \hyperlink{classPolicyFilter_a71bb7a7cc291ab70287245f05012317b}{PolicyFilter}, and \hyperlink{classVersionFilter_a02522bb1286dba1fbdd0bc46e425de4b}{VersionFilter}.



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