\hypertarget{classPimScopeZoneTable}{
\section{PimScopeZoneTable Class Reference}
\label{classPimScopeZoneTable}\index{PimScopeZoneTable@{PimScopeZoneTable}}
}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{classPimScopeZoneTable_a39157bf156534303d271df60d4b48840}{PimScopeZoneTable} (\hyperlink{classPimNode}{PimNode} \&pim\_\-node)
\begin{DoxyCompactList}\small\item\em \hyperlink{classPimScopeZoneTable_a39157bf156534303d271df60d4b48840}{PimScopeZoneTable::PimScopeZoneTable}: : The associated PIM node. \item\end{DoxyCompactList}\item 
virtual \hyperlink{classPimScopeZoneTable_a0906b7e687680e097a0e189537369630}{$\sim$PimScopeZoneTable} ()
\begin{DoxyCompactList}\small\item\em \hyperlink{classPimScopeZoneTable_a0906b7e687680e097a0e189537369630}{PimScopeZoneTable::$\sim$PimScopeZoneTable}: @: \item\end{DoxyCompactList}\item 
\hypertarget{classPimScopeZoneTable_a0d8ae2ad86aa50f91babdd5d8edab2b7}{
list$<$ \hyperlink{classPimScopeZone}{PimScopeZone} $>$ \& {\bfseries pim\_\-scope\_\-zone\_\-list} ()}
\label{classPimScopeZoneTable_a0d8ae2ad86aa50f91babdd5d8edab2b7}

\item 
void \hyperlink{classPimScopeZoneTable_a4060a0adf3e60f8427c288d35fcc6d61}{add\_\-scope\_\-zone} (const \hyperlink{classIPvXNet}{IPvXNet} \&scope\_\-zone\_\-prefix, uint32\_\-t vif\_\-index)
\begin{DoxyCompactList}\small\item\em \hyperlink{classPimScopeZoneTable_a4060a0adf3e60f8427c288d35fcc6d61}{PimScopeZoneTable::add\_\-scope\_\-zone}: : The prefix address of \hyperlink{protocolthe-p}{the} zone to add. \item\end{DoxyCompactList}\item 
void \hyperlink{classPimScopeZoneTable_a8407bb21abaf83ab781eb06a6f1aaef4}{delete\_\-scope\_\-zone} (const \hyperlink{classIPvXNet}{IPvXNet} \&scope\_\-zone\_\-prefix, uint32\_\-t vif\_\-index)
\begin{DoxyCompactList}\small\item\em \hyperlink{classPimScopeZoneTable_a8407bb21abaf83ab781eb06a6f1aaef4}{PimScopeZoneTable::delete\_\-scope\_\-zone}: : The prefix address of \hyperlink{protocolthe-p}{the} zone to delete. \item\end{DoxyCompactList}\item 
bool \hyperlink{classPimScopeZoneTable_a96aa4423b40a8566199611375cf0cf75}{is\_\-scoped} (const \hyperlink{classIPvX}{IPvX} \&addr, uint32\_\-t vif\_\-index) const 
\begin{DoxyCompactList}\small\item\em \hyperlink{classPimScopeZoneTable_a96aa4423b40a8566199611375cf0cf75}{PimScopeZoneTable::is\_\-scoped}: : The address to test whether it is scoped. \item\end{DoxyCompactList}\item 
bool \hyperlink{classPimScopeZoneTable_afaadbcf40426d5ab31ca3d4811012f54}{is\_\-scoped} (const \hyperlink{classPimScopeZoneId}{PimScopeZoneId} \&zone\_\-id, uint32\_\-t vif\_\-index) const 
\begin{DoxyCompactList}\small\item\em \hyperlink{classPimScopeZoneTable_a96aa4423b40a8566199611375cf0cf75}{PimScopeZoneTable::is\_\-scoped}: : The zone ID to test whether it is scoped. \item\end{DoxyCompactList}\item 
bool \hyperlink{classPimScopeZoneTable_a0b91db632b986714cf43b5559ab1b883}{is\_\-zone\_\-border\_\-router} (const \hyperlink{classIPvXNet}{IPvXNet} \&group\_\-prefix) const 
\begin{DoxyCompactList}\small\item\em \hyperlink{classPimScopeZoneTable_a0b91db632b986714cf43b5559ab1b883}{PimScopeZoneTable::is\_\-zone\_\-border\_\-router}: : The group prefix to test. \item\end{DoxyCompactList}\item 
\hypertarget{classPimScopeZoneTable_a431fafe6fee3840ee99b1ece67569229}{
\hyperlink{classPimNode}{PimNode} \& {\bfseries pim\_\-node} () const }
\label{classPimScopeZoneTable_a431fafe6fee3840ee99b1ece67569229}

\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classPimScopeZoneTable_a1e05c07142fc3b69c6d2e765c84e86c8}{
\hyperlink{classPimNode}{PimNode} \& {\bfseries \_\-pim\_\-node}}
\label{classPimScopeZoneTable_a1e05c07142fc3b69c6d2e765c84e86c8}

\item 
\hypertarget{classPimScopeZoneTable_a7f697461afd7a00d6cd69a175b496b3a}{
list$<$ \hyperlink{classPimScopeZone}{PimScopeZone} $>$ {\bfseries \_\-pim\_\-scope\_\-zone\_\-list}}
\label{classPimScopeZoneTable_a7f697461afd7a00d6cd69a175b496b3a}

\end{DoxyCompactItemize}


\subsection{Constructor \& Destructor Documentation}
\hypertarget{classPimScopeZoneTable_a39157bf156534303d271df60d4b48840}{
\index{PimScopeZoneTable@{PimScopeZoneTable}!PimScopeZoneTable@{PimScopeZoneTable}}
\index{PimScopeZoneTable@{PimScopeZoneTable}!PimScopeZoneTable@{PimScopeZoneTable}}
\subsubsection[{PimScopeZoneTable}]{\setlength{\rightskip}{0pt plus 5cm}PimScopeZoneTable::PimScopeZoneTable (
\begin{DoxyParamCaption}
\item[{{\bf PimNode} \&}]{pim\_\-node}
\end{DoxyParamCaption}
)}}
\label{classPimScopeZoneTable_a39157bf156534303d271df60d4b48840}


\hyperlink{classPimScopeZoneTable_a39157bf156534303d271df60d4b48840}{PimScopeZoneTable::PimScopeZoneTable}: : The associated PIM node. 

\hyperlink{classPimScopeZoneTable}{PimScopeZoneTable} constructor. \hypertarget{classPimScopeZoneTable_a0906b7e687680e097a0e189537369630}{
\index{PimScopeZoneTable@{PimScopeZoneTable}!$\sim$PimScopeZoneTable@{$\sim$PimScopeZoneTable}}
\index{$\sim$PimScopeZoneTable@{$\sim$PimScopeZoneTable}!PimScopeZoneTable@{PimScopeZoneTable}}
\subsubsection[{$\sim$PimScopeZoneTable}]{\setlength{\rightskip}{0pt plus 5cm}PimScopeZoneTable::$\sim$PimScopeZoneTable (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}
\label{classPimScopeZoneTable_a0906b7e687680e097a0e189537369630}


\hyperlink{classPimScopeZoneTable_a0906b7e687680e097a0e189537369630}{PimScopeZoneTable::$\sim$PimScopeZoneTable}: @: 

\hyperlink{classPimScopeZoneTable}{PimScopeZoneTable} destructor. 

\subsection{Member Function Documentation}
\hypertarget{classPimScopeZoneTable_a4060a0adf3e60f8427c288d35fcc6d61}{
\index{PimScopeZoneTable@{PimScopeZoneTable}!add\_\-scope\_\-zone@{add\_\-scope\_\-zone}}
\index{add\_\-scope\_\-zone@{add\_\-scope\_\-zone}!PimScopeZoneTable@{PimScopeZoneTable}}
\subsubsection[{add\_\-scope\_\-zone}]{\setlength{\rightskip}{0pt plus 5cm}void PimScopeZoneTable::add\_\-scope\_\-zone (
\begin{DoxyParamCaption}
\item[{const {\bf IPvXNet} \&}]{scope\_\-zone\_\-prefix, }
\item[{uint32\_\-t}]{vif\_\-index}
\end{DoxyParamCaption}
)}}
\label{classPimScopeZoneTable_a4060a0adf3e60f8427c288d35fcc6d61}


\hyperlink{classPimScopeZoneTable_a4060a0adf3e60f8427c288d35fcc6d61}{PimScopeZoneTable::add\_\-scope\_\-zone}: : The prefix address of \hyperlink{protocolthe-p}{the} zone to add. 

: The vif index of \hyperlink{protocolthe-p}{the} interface to add as zone boundary.

Add a scope zone. \hypertarget{classPimScopeZoneTable_a8407bb21abaf83ab781eb06a6f1aaef4}{
\index{PimScopeZoneTable@{PimScopeZoneTable}!delete\_\-scope\_\-zone@{delete\_\-scope\_\-zone}}
\index{delete\_\-scope\_\-zone@{delete\_\-scope\_\-zone}!PimScopeZoneTable@{PimScopeZoneTable}}
\subsubsection[{delete\_\-scope\_\-zone}]{\setlength{\rightskip}{0pt plus 5cm}void PimScopeZoneTable::delete\_\-scope\_\-zone (
\begin{DoxyParamCaption}
\item[{const {\bf IPvXNet} \&}]{scope\_\-zone\_\-prefix, }
\item[{uint32\_\-t}]{vif\_\-index}
\end{DoxyParamCaption}
)}}
\label{classPimScopeZoneTable_a8407bb21abaf83ab781eb06a6f1aaef4}


\hyperlink{classPimScopeZoneTable_a8407bb21abaf83ab781eb06a6f1aaef4}{PimScopeZoneTable::delete\_\-scope\_\-zone}: : The prefix address of \hyperlink{protocolthe-p}{the} zone to delete. 

: The vif index of \hyperlink{protocolthe-p}{the} interface to delete as zone boundary.

Delete a scope zone. \hypertarget{classPimScopeZoneTable_a96aa4423b40a8566199611375cf0cf75}{
\index{PimScopeZoneTable@{PimScopeZoneTable}!is\_\-scoped@{is\_\-scoped}}
\index{is\_\-scoped@{is\_\-scoped}!PimScopeZoneTable@{PimScopeZoneTable}}
\subsubsection[{is\_\-scoped}]{\setlength{\rightskip}{0pt plus 5cm}bool PimScopeZoneTable::is\_\-scoped (
\begin{DoxyParamCaption}
\item[{const {\bf IPvX} \&}]{addr, }
\item[{uint32\_\-t}]{vif\_\-index}
\end{DoxyParamCaption}
) const}}
\label{classPimScopeZoneTable_a96aa4423b40a8566199611375cf0cf75}


\hyperlink{classPimScopeZoneTable_a96aa4423b40a8566199611375cf0cf75}{PimScopeZoneTable::is\_\-scoped}: : The address to test whether it is scoped. 

: The vif index of \hyperlink{protocolthe-p}{the} interface to test.

Test if address  is scoped on interface with vif index of . Note that we test against all scope zones until a scoping one is found.

Return value: True if  is scoped on , otherwise false. \hypertarget{classPimScopeZoneTable_afaadbcf40426d5ab31ca3d4811012f54}{
\index{PimScopeZoneTable@{PimScopeZoneTable}!is\_\-scoped@{is\_\-scoped}}
\index{is\_\-scoped@{is\_\-scoped}!PimScopeZoneTable@{PimScopeZoneTable}}
\subsubsection[{is\_\-scoped}]{\setlength{\rightskip}{0pt plus 5cm}bool PimScopeZoneTable::is\_\-scoped (
\begin{DoxyParamCaption}
\item[{const {\bf PimScopeZoneId} \&}]{zone\_\-id, }
\item[{uint32\_\-t}]{vif\_\-index}
\end{DoxyParamCaption}
) const}}
\label{classPimScopeZoneTable_afaadbcf40426d5ab31ca3d4811012f54}


\hyperlink{classPimScopeZoneTable_a96aa4423b40a8566199611375cf0cf75}{PimScopeZoneTable::is\_\-scoped}: : The zone ID to test whether it is scoped. 

: The vif index of \hyperlink{protocolthe-p}{the} interface to test.

Test if zone with zone ID of  is scoped on interface with vif index of . Note that we test against all scope zones until a scoping one is found.

Return value: True if  is scoped on , otherwise false. \hypertarget{classPimScopeZoneTable_a0b91db632b986714cf43b5559ab1b883}{
\index{PimScopeZoneTable@{PimScopeZoneTable}!is\_\-zone\_\-border\_\-router@{is\_\-zone\_\-border\_\-router}}
\index{is\_\-zone\_\-border\_\-router@{is\_\-zone\_\-border\_\-router}!PimScopeZoneTable@{PimScopeZoneTable}}
\subsubsection[{is\_\-zone\_\-border\_\-router}]{\setlength{\rightskip}{0pt plus 5cm}bool PimScopeZoneTable::is\_\-zone\_\-border\_\-router (
\begin{DoxyParamCaption}
\item[{const {\bf IPvXNet} \&}]{group\_\-prefix}
\end{DoxyParamCaption}
) const}}
\label{classPimScopeZoneTable_a0b91db632b986714cf43b5559ab1b883}


\hyperlink{classPimScopeZoneTable_a0b91db632b986714cf43b5559ab1b883}{PimScopeZoneTable::is\_\-zone\_\-border\_\-router}: : The group prefix to test. 

Test if \hyperlink{protocolthe-p}{the} router is a Zone Border Router (ZBR) for .

Return value: True if \hyperlink{protocolthe-p}{the} router is a ZBR for , otherwise false. 

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