\hypertarget{classPimScopeZone}{
\section{PimScopeZone Class Reference}
\label{classPimScopeZone}\index{PimScopeZone@{PimScopeZone}}
}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{classPimScopeZone_ae972f40e3889d5c4dccce42913a23aec}{PimScopeZone} (const \hyperlink{classIPvXNet}{IPvXNet} \&scope\_\-zone\_\-prefix, const Mifset \&scoped\_\-vifs)
\begin{DoxyCompactList}\small\item\em \hyperlink{classPimScopeZone_ae972f40e3889d5c4dccce42913a23aec}{PimScopeZone::PimScopeZone}: : The scope zone address prefix. \item\end{DoxyCompactList}\item 
virtual \hyperlink{classPimScopeZone_a36857103e2e1c2f123e48927e17c175a}{$\sim$PimScopeZone} ()
\begin{DoxyCompactList}\small\item\em \hyperlink{classPimScopeZone_a36857103e2e1c2f123e48927e17c175a}{PimScopeZone::$\sim$PimScopeZone}: @: \item\end{DoxyCompactList}\item 
\hypertarget{classPimScopeZone_a1820d0bf50790661da784e104a305ce8}{
const \hyperlink{classIPvXNet}{IPvXNet} \& {\bfseries scope\_\-zone\_\-prefix} () const }
\label{classPimScopeZone_a1820d0bf50790661da784e104a305ce8}

\item 
void \hyperlink{classPimScopeZone_aa34d98fe4d4110a62ca7c44f64e0f3a0}{set\_\-scoped\_\-vif} (uint32\_\-t vif\_\-index, bool v)
\begin{DoxyCompactList}\small\item\em \hyperlink{classPimScopeZone_aa34d98fe4d4110a62ca7c44f64e0f3a0}{PimScopeZone::set\_\-scoped\_\-vif}: : The vif index of \hyperlink{protocolthe-p}{the} interface to set or reset. \item\end{DoxyCompactList}\item 
\hypertarget{classPimScopeZone_a4da51179ad5f5b403f37ef6013919183}{
bool {\bfseries is\_\-empty} () const }
\label{classPimScopeZone_a4da51179ad5f5b403f37ef6013919183}

\item 
bool \hyperlink{classPimScopeZone_a5f25d6e678911a2a47e35bd74ef672c6}{is\_\-set} (uint32\_\-t vif\_\-index) const 
\begin{DoxyCompactList}\small\item\em \hyperlink{classPimScopeZone_a5f25d6e678911a2a47e35bd74ef672c6}{PimScopeZone::is\_\-set}: : The vif index of \hyperlink{protocolthe-p}{the} interface to test. \item\end{DoxyCompactList}\item 
bool \hyperlink{classPimScopeZone_a3a2859335f79c40ec70851942701f20c}{is\_\-scoped} (const \hyperlink{classIPvX}{IPvX} \&addr, uint32\_\-t vif\_\-index) const 
\begin{DoxyCompactList}\small\item\em \hyperlink{classPimScopeZone_a3a2859335f79c40ec70851942701f20c}{PimScopeZone::is\_\-scoped}: : The address to test whether it is scoped. \item\end{DoxyCompactList}\item 
bool \hyperlink{classPimScopeZone_a510d804da8f1e668aa9b22671de422b6}{is\_\-scoped} (const \hyperlink{classPimScopeZoneId}{PimScopeZoneId} \&zone\_\-id, uint32\_\-t vif\_\-index) const 
\begin{DoxyCompactList}\small\item\em \hyperlink{classPimScopeZone_a3a2859335f79c40ec70851942701f20c}{PimScopeZone::is\_\-scoped}: : The zone ID to test whether it is scoped. \item\end{DoxyCompactList}\item 
bool \hyperlink{classPimScopeZone_a398f12d2daa4052035211e3f273cab0c}{is\_\-same\_\-scope\_\-zone} (const \hyperlink{classIPvXNet}{IPvXNet} \&scope\_\-zone\_\-prefix) const 
\begin{DoxyCompactList}\small\item\em \hyperlink{classPimScopeZone_a398f12d2daa4052035211e3f273cab0c}{PimScopeZone::is\_\-same\_\-scope\_\-zone}: : The prefix address to test if it is \hyperlink{protocolthe-p}{the} prefix address of this scope zone. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classPimScopeZone_a4bd3f023a8deaef0c6d7c0a69c554787}{
\hyperlink{classIPvXNet}{IPvXNet} {\bfseries \_\-scope\_\-zone\_\-prefix}}
\label{classPimScopeZone_a4bd3f023a8deaef0c6d7c0a69c554787}

\item 
\hypertarget{classPimScopeZone_a9fe590f8b9ca0ac54ed75bb674e88891}{
Mifset {\bfseries \_\-scoped\_\-vifs}}
\label{classPimScopeZone_a9fe590f8b9ca0ac54ed75bb674e88891}

\end{DoxyCompactItemize}


\subsection{Constructor \& Destructor Documentation}
\hypertarget{classPimScopeZone_ae972f40e3889d5c4dccce42913a23aec}{
\index{PimScopeZone@{PimScopeZone}!PimScopeZone@{PimScopeZone}}
\index{PimScopeZone@{PimScopeZone}!PimScopeZone@{PimScopeZone}}
\subsubsection[{PimScopeZone}]{\setlength{\rightskip}{0pt plus 5cm}PimScopeZone::PimScopeZone (
\begin{DoxyParamCaption}
\item[{const {\bf IPvXNet} \&}]{scope\_\-zone\_\-prefix, }
\item[{const Mifset \&}]{scoped\_\-vifs}
\end{DoxyParamCaption}
)}}
\label{classPimScopeZone_ae972f40e3889d5c4dccce42913a23aec}


\hyperlink{classPimScopeZone_ae972f40e3889d5c4dccce42913a23aec}{PimScopeZone::PimScopeZone}: : The scope zone address prefix. 

: The bitmask with \hyperlink{protocolthe-p}{the} vifs that are zone boundary.

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


\hyperlink{classPimScopeZone_a36857103e2e1c2f123e48927e17c175a}{PimScopeZone::$\sim$PimScopeZone}: @: 

\hyperlink{classPimScopeZone}{PimScopeZone} destructor. 

\subsection{Member Function Documentation}
\hypertarget{classPimScopeZone_a398f12d2daa4052035211e3f273cab0c}{
\index{PimScopeZone@{PimScopeZone}!is\_\-same\_\-scope\_\-zone@{is\_\-same\_\-scope\_\-zone}}
\index{is\_\-same\_\-scope\_\-zone@{is\_\-same\_\-scope\_\-zone}!PimScopeZone@{PimScopeZone}}
\subsubsection[{is\_\-same\_\-scope\_\-zone}]{\setlength{\rightskip}{0pt plus 5cm}bool PimScopeZone::is\_\-same\_\-scope\_\-zone (
\begin{DoxyParamCaption}
\item[{const {\bf IPvXNet} \&}]{scope\_\-zone\_\-prefix}
\end{DoxyParamCaption}
) const}}
\label{classPimScopeZone_a398f12d2daa4052035211e3f273cab0c}


\hyperlink{classPimScopeZone_a398f12d2daa4052035211e3f273cab0c}{PimScopeZone::is\_\-same\_\-scope\_\-zone}: : The prefix address to test if it is \hyperlink{protocolthe-p}{the} prefix address of this scope zone. 

Test if this scope zone prefix address is same as .

Return value: True if  is same prefix address as \hyperlink{protocolthe-p}{the} prefix address of this scope zone, otherwise false. \hypertarget{classPimScopeZone_a3a2859335f79c40ec70851942701f20c}{
\index{PimScopeZone@{PimScopeZone}!is\_\-scoped@{is\_\-scoped}}
\index{is\_\-scoped@{is\_\-scoped}!PimScopeZone@{PimScopeZone}}
\subsubsection[{is\_\-scoped}]{\setlength{\rightskip}{0pt plus 5cm}bool PimScopeZone::is\_\-scoped (
\begin{DoxyParamCaption}
\item[{const {\bf IPvX} \&}]{addr, }
\item[{uint32\_\-t}]{vif\_\-index}
\end{DoxyParamCaption}
) const}}
\label{classPimScopeZone_a3a2859335f79c40ec70851942701f20c}


\hyperlink{classPimScopeZone_a3a2859335f79c40ec70851942701f20c}{PimScopeZone::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 .

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


\hyperlink{classPimScopeZone_a3a2859335f79c40ec70851942701f20c}{PimScopeZone::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 .

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


\hyperlink{classPimScopeZone_a5f25d6e678911a2a47e35bd74ef672c6}{PimScopeZone::is\_\-set}: : The vif index of \hyperlink{protocolthe-p}{the} interface to test. 

Test if an interface is a boundary for this scope zone.

Return value: True if \hyperlink{protocolthe-p}{the} tested interface is a boundary for this scope zone, otherwise false. \hypertarget{classPimScopeZone_aa34d98fe4d4110a62ca7c44f64e0f3a0}{
\index{PimScopeZone@{PimScopeZone}!set\_\-scoped\_\-vif@{set\_\-scoped\_\-vif}}
\index{set\_\-scoped\_\-vif@{set\_\-scoped\_\-vif}!PimScopeZone@{PimScopeZone}}
\subsubsection[{set\_\-scoped\_\-vif}]{\setlength{\rightskip}{0pt plus 5cm}void PimScopeZone::set\_\-scoped\_\-vif (
\begin{DoxyParamCaption}
\item[{uint32\_\-t}]{vif\_\-index, }
\item[{bool}]{v}
\end{DoxyParamCaption}
)}}
\label{classPimScopeZone_aa34d98fe4d4110a62ca7c44f64e0f3a0}


\hyperlink{classPimScopeZone_aa34d98fe4d4110a62ca7c44f64e0f3a0}{PimScopeZone::set\_\-scoped\_\-vif}: : The vif index of \hyperlink{protocolthe-p}{the} interface to set or reset. 

: If true, set \hyperlink{protocolthe-p}{the} interface as a boundary for this scope zone, otherwise reset it.

Set or reset an interface as a boundary for this scope zone. 

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}
