ParserView Class Reference

ParserView handles and manipulates parser views. More...

Public Member Functions
void	setSecret (string)
	Sets the secret. More...
string	getSecret ()
	Returns the secret. More...
bool	addCommand (string, string, bool, CommandSet::EViewCommandAction)
	Adds the specified command to the view. More...
bool	removeCommand (string, string, CommandSet::EViewCommandAction)
	Removes the specified command from the view. More...
int	getModeCount ()
	Returns the number of modes. More...
string	getModeAt (int)
	Returns the mode at the specified index. More...
int	getIncludeCommandForModeCount (string)
	Returns the number of include commands for the specified mode. More...
pair< string, bool >	getIncludeCommandForModeAt (string, int)
	Returns the include command in the specified mode at the specified index. More...
pair< string, bool >	getIncludeCommandForMode (string, string)
	Returns the include command in the specified mode with the specified command. More...
void	incrementUserCount ()
	Increments the number of users. More...
void	decrementUserCount ()
	Decrements the number of users. More...
int	getUserCount ()
	Returns the number of users. More...
bool	isCommandAdded (string)
	Returns true if the specified command is already added to this view, otherwise false. More...

Detailed Description

ParserView handles and manipulates parser views.

Member Function Documentation

addCommand()

bool ParserView::addCommand	(	string	,
		string	,
		bool	,
		CommandSet::EViewCommandAction
	)

Adds the specified command to the view.

Parameters

mode,the	mode to add the command to. Valid modes: user, enable, global.
command,the	command of interest.
bAll,true	to include all, false to not include all.
action,the	view command action. Actions: eViewCommandInclude = 0, eViewCommandExclude = 1, eViewCommandIncludeExclusive = 2

Returns

bool, true if successful, otherwise false.

decrementUserCount()

void ParserView::decrementUserCount

(

)

Decrements the number of users.

getIncludeCommandForMode()

pair< string, bool > ParserView::getIncludeCommandForMode	(	string	,
		string
	)

Returns the include command in the specified mode with the specified command.

Parameters

mode,the	mode of interest. Valid modes: user, enable, global.
command,the	command of interest.

Returns

pair<string, bool>, the include command and a boolean value that is true if included in all, otherwise false.

getIncludeCommandForModeAt()

pair< string, bool > ParserView::getIncludeCommandForModeAt	(	string	,
		int
	)

Returns the include command in the specified mode at the specified index.

Parameters

mode,the	mode of interest. Valid modes: user, enable, global.
index,the	index of the include command of interest.

Returns

pair<string, bool>, the include command and a boolean value that is true if included in all, otherwise false.

getIncludeCommandForModeCount()

int ParserView::getIncludeCommandForModeCount

(

string

)

Returns the number of include commands for the specified mode.

Parameters

mode,the

mode of interest. Valid modes: user, enable, global.

Returns

int, the number of include commands for the specified mode.

getModeAt()

string ParserView::getModeAt

(

int

)

Returns the mode at the specified index.

Parameters

index,the

index of the mode of interest.

Returns

string, mode at the specified index.

getModeCount()

int ParserView::getModeCount

(

)

Returns the number of modes.

Returns

int, the number of modes.

getSecret()

string ParserView::getSecret

(

)

Returns the secret.

Returns

string, the secret.

getUserCount()

int ParserView::getUserCount

(

)

Returns the number of users.

Returns

int, the number of users.

incrementUserCount()

void ParserView::incrementUserCount

(

)

Increments the number of users.

isCommandAdded()

bool ParserView::isCommandAdded

(

string

)

Returns true if the specified command is already added to this view, otherwise false.

Parameters

commandStr,the

command string to use.

Returns

bool, true if the specified command is already added to this view, otherwise false.

removeCommand()

bool ParserView::removeCommand	(	string	,
		string	,
		CommandSet::EViewCommandAction
	)

Removes the specified command from the view.

Parameters

mode,the	mode to remove the command from. Valid modes: user, enable, global.
command,the	command of interest.
action,the	view command action. Actions: eViewCommandInclude = 0, eViewCommandExclude = 1, eViewCommandIncludeExclusive = 2

Returns

bool, true if successful, otherwise false.

setSecret()

void ParserView::setSecret

(

string

)

Sets the secret.

Parameters

secretStr,the

secret.

---

The documentation for this class was generated from the following file:

• CParserView.pki