\hypertarget{classCliCommandMatch}{
\section{CliCommandMatch Class Reference}
\label{classCliCommandMatch}\index{CliCommandMatch@{CliCommandMatch}}
}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classCliCommandMatch_a51dd1eb631a99ca3bef84aa07ae3ce14}{
{\bfseries CliCommandMatch} (const string \&command\_\-name, const string \&help\_\-string, bool is\_\-executable, bool can\_\-pipe)}
\label{classCliCommandMatch_a51dd1eb631a99ca3bef84aa07ae3ce14}

\item 
const string \& \hyperlink{classCliCommandMatch_abd30c5d81f718fd025239611046cc804}{command\_\-name} () const 
\begin{DoxyCompactList}\small\item\em Get \hyperlink{protocolthe-p}{the} command name. \item\end{DoxyCompactList}\item 
const string \& \hyperlink{classCliCommandMatch_abed77ce0623069426d1e7b82ee4b019f}{help\_\-string} () const 
\begin{DoxyCompactList}\small\item\em Get \hyperlink{protocolthe-p}{the} help string for \hyperlink{protocolthe-p}{the} command. \item\end{DoxyCompactList}\item 
bool \hyperlink{classCliCommandMatch_aed13dcbc307ce54f0f2ce6ca8d0b0617}{is\_\-executable} () const 
\begin{DoxyCompactList}\small\item\em Test if \hyperlink{protocolthe-p}{the} command is executable. \item\end{DoxyCompactList}\item 
bool \hyperlink{classCliCommandMatch_af34e56a9d65d76d42df07b4b90463f25}{can\_\-pipe} () const 
\begin{DoxyCompactList}\small\item\em Test if \hyperlink{protocolthe-p}{the} command supports pipes. \item\end{DoxyCompactList}\item 
bool \hyperlink{classCliCommandMatch_af6e33daf725374d4d6405229e9674608}{default\_\-nomore\_\-mode} () const 
\begin{DoxyCompactList}\small\item\em Test if \char`\"{}no-\/more\char`\"{} (i.e., unpaged) is \hyperlink{protocolthe-p}{the} default output mode. \item\end{DoxyCompactList}\item 
void \hyperlink{classCliCommandMatch_a905c5ed98057f64f11f4c65b8eda4c88}{set\_\-default\_\-nomore\_\-mode} (bool v)
\begin{DoxyCompactList}\small\item\em Set \hyperlink{protocolthe-p}{the} default paging mode. \item\end{DoxyCompactList}\item 
bool \hyperlink{classCliCommandMatch_a26ad7460b04bc48dccb5d98804348a48}{is\_\-command\_\-argument} () const 
\begin{DoxyCompactList}\small\item\em Test if \hyperlink{protocolthe-p}{the} command actually represents a command argument. \item\end{DoxyCompactList}\item 
void \hyperlink{classCliCommandMatch_a705047375e4b8daa2d4782c121706c07}{set\_\-is\_\-command\_\-argument} (bool v)
\begin{DoxyCompactList}\small\item\em Set a flag whether \hyperlink{protocolthe-p}{the} command actually represents a command argument. \item\end{DoxyCompactList}\item 
bool \hyperlink{classCliCommandMatch_abf2e0c6193e3e0a8b9b573c417a243cf}{is\_\-argument\_\-expected} () const 
\begin{DoxyCompactList}\small\item\em Test if \hyperlink{protocolthe-p}{the} command expects an argument. \item\end{DoxyCompactList}\item 
void \hyperlink{classCliCommandMatch_acff218bf9e2a1329c686f2449e0450f1}{set\_\-is\_\-argument\_\-expected} (bool v)
\begin{DoxyCompactList}\small\item\em Set a flag whether \hyperlink{protocolthe-p}{the} command expects an argument. \item\end{DoxyCompactList}\item 
const CliCommand::TypeMatchCb \& \hyperlink{classCliCommandMatch_a9fef6978d35aac1136c4406da8d4a764}{type\_\-match\_\-cb} () const 
\begin{DoxyCompactList}\small\item\em Get a reference to \hyperlink{protocolthe-p}{the} type matching callback. \item\end{DoxyCompactList}\item 
void \hyperlink{classCliCommandMatch_abf1bafe46790ebc1589b2bddfb5aa4ae}{set\_\-type\_\-match\_\-cb} (const CliCommand::TypeMatchCb \&cb)
\begin{DoxyCompactList}\small\item\em Set \hyperlink{protocolthe-p}{the} type matching callback. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classCliCommandMatch_a9c0842e308fa69f0ffa4c43667cc9163}{
string {\bfseries \_\-command\_\-name}}
\label{classCliCommandMatch_a9c0842e308fa69f0ffa4c43667cc9163}

\item 
\hypertarget{classCliCommandMatch_a96b98edb2f149747d68e2c0aac2c8087}{
string {\bfseries \_\-help\_\-string}}
\label{classCliCommandMatch_a96b98edb2f149747d68e2c0aac2c8087}

\item 
\hypertarget{classCliCommandMatch_a768f38d22e88cfb0ac9b5478eb5429fb}{
bool {\bfseries \_\-is\_\-executable}}
\label{classCliCommandMatch_a768f38d22e88cfb0ac9b5478eb5429fb}

\item 
\hypertarget{classCliCommandMatch_ac0cc350c1f7372b4c461ae6c5b32a475}{
bool {\bfseries \_\-can\_\-pipe}}
\label{classCliCommandMatch_ac0cc350c1f7372b4c461ae6c5b32a475}

\item 
\hypertarget{classCliCommandMatch_a01f9d08893441bb986cd02a2c9a06218}{
bool {\bfseries \_\-default\_\-nomore\_\-mode}}
\label{classCliCommandMatch_a01f9d08893441bb986cd02a2c9a06218}

\item 
\hypertarget{classCliCommandMatch_aeeb5e5cb313704952928ebc11ff086ca}{
bool {\bfseries \_\-is\_\-command\_\-argument}}
\label{classCliCommandMatch_aeeb5e5cb313704952928ebc11ff086ca}

\item 
\hypertarget{classCliCommandMatch_ada721ad56c7142dd99d21677349410ef}{
bool {\bfseries \_\-is\_\-argument\_\-expected}}
\label{classCliCommandMatch_ada721ad56c7142dd99d21677349410ef}

\item 
\hypertarget{classCliCommandMatch_a6c0eaecbe4839b02cbb2b20231bbf8e4}{
CliCommand::TypeMatchCb {\bfseries \_\-type\_\-match\_\-cb}}
\label{classCliCommandMatch_a6c0eaecbe4839b02cbb2b20231bbf8e4}

\end{DoxyCompactItemize}


\subsection{Member Function Documentation}
\hypertarget{classCliCommandMatch_af34e56a9d65d76d42df07b4b90463f25}{
\index{CliCommandMatch@{CliCommandMatch}!can\_\-pipe@{can\_\-pipe}}
\index{can\_\-pipe@{can\_\-pipe}!CliCommandMatch@{CliCommandMatch}}
\subsubsection[{can\_\-pipe}]{\setlength{\rightskip}{0pt plus 5cm}bool CliCommandMatch::can\_\-pipe (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classCliCommandMatch_af34e56a9d65d76d42df07b4b90463f25}


Test if \hyperlink{protocolthe-p}{the} command supports pipes. 

\begin{DoxyReturn}{Returns}
true if \hyperlink{protocolthe-p}{the} command supports pipes, otherwise false. 
\end{DoxyReturn}
\hypertarget{classCliCommandMatch_abd30c5d81f718fd025239611046cc804}{
\index{CliCommandMatch@{CliCommandMatch}!command\_\-name@{command\_\-name}}
\index{command\_\-name@{command\_\-name}!CliCommandMatch@{CliCommandMatch}}
\subsubsection[{command\_\-name}]{\setlength{\rightskip}{0pt plus 5cm}const string\& CliCommandMatch::command\_\-name (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classCliCommandMatch_abd30c5d81f718fd025239611046cc804}


Get \hyperlink{protocolthe-p}{the} command name. 

\begin{DoxyReturn}{Returns}
\hyperlink{protocolthe-p}{the} command name. 
\end{DoxyReturn}
\hypertarget{classCliCommandMatch_af6e33daf725374d4d6405229e9674608}{
\index{CliCommandMatch@{CliCommandMatch}!default\_\-nomore\_\-mode@{default\_\-nomore\_\-mode}}
\index{default\_\-nomore\_\-mode@{default\_\-nomore\_\-mode}!CliCommandMatch@{CliCommandMatch}}
\subsubsection[{default\_\-nomore\_\-mode}]{\setlength{\rightskip}{0pt plus 5cm}bool CliCommandMatch::default\_\-nomore\_\-mode (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classCliCommandMatch_af6e33daf725374d4d6405229e9674608}


Test if \char`\"{}no-\/more\char`\"{} (i.e., unpaged) is \hyperlink{protocolthe-p}{the} default output mode. 

\begin{DoxyReturn}{Returns}
true if \char`\"{}no-\/more\char`\"{} (i.e., unpaged) is \hyperlink{protocolthe-p}{the} default output mode, otherwise false. 
\end{DoxyReturn}
\hypertarget{classCliCommandMatch_abed77ce0623069426d1e7b82ee4b019f}{
\index{CliCommandMatch@{CliCommandMatch}!help\_\-string@{help\_\-string}}
\index{help\_\-string@{help\_\-string}!CliCommandMatch@{CliCommandMatch}}
\subsubsection[{help\_\-string}]{\setlength{\rightskip}{0pt plus 5cm}const string\& CliCommandMatch::help\_\-string (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classCliCommandMatch_abed77ce0623069426d1e7b82ee4b019f}


Get \hyperlink{protocolthe-p}{the} help string for \hyperlink{protocolthe-p}{the} command. 

\begin{DoxyReturn}{Returns}
\hyperlink{protocolthe-p}{the} help string for \hyperlink{protocolthe-p}{the} command. 
\end{DoxyReturn}
\hypertarget{classCliCommandMatch_abf2e0c6193e3e0a8b9b573c417a243cf}{
\index{CliCommandMatch@{CliCommandMatch}!is\_\-argument\_\-expected@{is\_\-argument\_\-expected}}
\index{is\_\-argument\_\-expected@{is\_\-argument\_\-expected}!CliCommandMatch@{CliCommandMatch}}
\subsubsection[{is\_\-argument\_\-expected}]{\setlength{\rightskip}{0pt plus 5cm}bool CliCommandMatch::is\_\-argument\_\-expected (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classCliCommandMatch_abf2e0c6193e3e0a8b9b573c417a243cf}


Test if \hyperlink{protocolthe-p}{the} command expects an argument. 

\begin{DoxyReturn}{Returns}
true if \hyperlink{protocolthe-p}{the} command expects an argument, otherwise false. 
\end{DoxyReturn}
\hypertarget{classCliCommandMatch_a26ad7460b04bc48dccb5d98804348a48}{
\index{CliCommandMatch@{CliCommandMatch}!is\_\-command\_\-argument@{is\_\-command\_\-argument}}
\index{is\_\-command\_\-argument@{is\_\-command\_\-argument}!CliCommandMatch@{CliCommandMatch}}
\subsubsection[{is\_\-command\_\-argument}]{\setlength{\rightskip}{0pt plus 5cm}bool CliCommandMatch::is\_\-command\_\-argument (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classCliCommandMatch_a26ad7460b04bc48dccb5d98804348a48}


Test if \hyperlink{protocolthe-p}{the} command actually represents a command argument. 

\begin{DoxyReturn}{Returns}
true if \hyperlink{protocolthe-p}{the} command actually represents a command argument. 
\end{DoxyReturn}
\hypertarget{classCliCommandMatch_aed13dcbc307ce54f0f2ce6ca8d0b0617}{
\index{CliCommandMatch@{CliCommandMatch}!is\_\-executable@{is\_\-executable}}
\index{is\_\-executable@{is\_\-executable}!CliCommandMatch@{CliCommandMatch}}
\subsubsection[{is\_\-executable}]{\setlength{\rightskip}{0pt plus 5cm}bool CliCommandMatch::is\_\-executable (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classCliCommandMatch_aed13dcbc307ce54f0f2ce6ca8d0b0617}


Test if \hyperlink{protocolthe-p}{the} command is executable. 

\begin{DoxyReturn}{Returns}
true if \hyperlink{protocolthe-p}{the} command is executable, otherwise false. 
\end{DoxyReturn}
\hypertarget{classCliCommandMatch_a905c5ed98057f64f11f4c65b8eda4c88}{
\index{CliCommandMatch@{CliCommandMatch}!set\_\-default\_\-nomore\_\-mode@{set\_\-default\_\-nomore\_\-mode}}
\index{set\_\-default\_\-nomore\_\-mode@{set\_\-default\_\-nomore\_\-mode}!CliCommandMatch@{CliCommandMatch}}
\subsubsection[{set\_\-default\_\-nomore\_\-mode}]{\setlength{\rightskip}{0pt plus 5cm}void CliCommandMatch::set\_\-default\_\-nomore\_\-mode (
\begin{DoxyParamCaption}
\item[{bool}]{v}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classCliCommandMatch_a905c5ed98057f64f11f4c65b8eda4c88}


Set \hyperlink{protocolthe-p}{the} default paging mode. 


\begin{DoxyParams}{Parameters}
{\em v} & if true, then \char`\"{}no-\/more\char`\"{} (i.e., unpaged) is \hyperlink{protocolthe-p}{the} default output mode. \\
\hline
\end{DoxyParams}
\hypertarget{classCliCommandMatch_acff218bf9e2a1329c686f2449e0450f1}{
\index{CliCommandMatch@{CliCommandMatch}!set\_\-is\_\-argument\_\-expected@{set\_\-is\_\-argument\_\-expected}}
\index{set\_\-is\_\-argument\_\-expected@{set\_\-is\_\-argument\_\-expected}!CliCommandMatch@{CliCommandMatch}}
\subsubsection[{set\_\-is\_\-argument\_\-expected}]{\setlength{\rightskip}{0pt plus 5cm}void CliCommandMatch::set\_\-is\_\-argument\_\-expected (
\begin{DoxyParamCaption}
\item[{bool}]{v}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classCliCommandMatch_acff218bf9e2a1329c686f2449e0450f1}


Set a flag whether \hyperlink{protocolthe-p}{the} command expects an argument. 


\begin{DoxyParams}{Parameters}
{\em v} & true if \hyperlink{protocolthe-p}{the} command expectes an argument, otherwise false. \\
\hline
\end{DoxyParams}
\hypertarget{classCliCommandMatch_a705047375e4b8daa2d4782c121706c07}{
\index{CliCommandMatch@{CliCommandMatch}!set\_\-is\_\-command\_\-argument@{set\_\-is\_\-command\_\-argument}}
\index{set\_\-is\_\-command\_\-argument@{set\_\-is\_\-command\_\-argument}!CliCommandMatch@{CliCommandMatch}}
\subsubsection[{set\_\-is\_\-command\_\-argument}]{\setlength{\rightskip}{0pt plus 5cm}void CliCommandMatch::set\_\-is\_\-command\_\-argument (
\begin{DoxyParamCaption}
\item[{bool}]{v}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classCliCommandMatch_a705047375e4b8daa2d4782c121706c07}


Set a flag whether \hyperlink{protocolthe-p}{the} command actually represents a command argument. 


\begin{DoxyParams}{Parameters}
{\em v} & true if \hyperlink{protocolthe-p}{the} command represents a command argument, otherwise false. \\
\hline
\end{DoxyParams}
\hypertarget{classCliCommandMatch_abf1bafe46790ebc1589b2bddfb5aa4ae}{
\index{CliCommandMatch@{CliCommandMatch}!set\_\-type\_\-match\_\-cb@{set\_\-type\_\-match\_\-cb}}
\index{set\_\-type\_\-match\_\-cb@{set\_\-type\_\-match\_\-cb}!CliCommandMatch@{CliCommandMatch}}
\subsubsection[{set\_\-type\_\-match\_\-cb}]{\setlength{\rightskip}{0pt plus 5cm}void CliCommandMatch::set\_\-type\_\-match\_\-cb (
\begin{DoxyParamCaption}
\item[{const CliCommand::TypeMatchCb \&}]{cb}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classCliCommandMatch_abf1bafe46790ebc1589b2bddfb5aa4ae}


Set \hyperlink{protocolthe-p}{the} type matching callback. 


\begin{DoxyParams}{Parameters}
{\em cb} & \hyperlink{protocolthe-p}{the} type matching callback. \\
\hline
\end{DoxyParams}
\hypertarget{classCliCommandMatch_a9fef6978d35aac1136c4406da8d4a764}{
\index{CliCommandMatch@{CliCommandMatch}!type\_\-match\_\-cb@{type\_\-match\_\-cb}}
\index{type\_\-match\_\-cb@{type\_\-match\_\-cb}!CliCommandMatch@{CliCommandMatch}}
\subsubsection[{type\_\-match\_\-cb}]{\setlength{\rightskip}{0pt plus 5cm}const CliCommand::TypeMatchCb\& CliCommandMatch::type\_\-match\_\-cb (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classCliCommandMatch_a9fef6978d35aac1136c4406da8d4a764}


Get a reference to \hyperlink{protocolthe-p}{the} type matching callback. 

\begin{DoxyReturn}{Returns}
a reference to \hyperlink{protocolthe-p}{the} type matching callback. 
\end{DoxyReturn}


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