class OpCommand


 
LOGO
 Annotated List  Files  Globals  Hierarchy  Index  Top

Public Methods

Public Static Methods


Detailed Description

 OpCommand (OpCommandList& ocl, const list<string>& command_parts)

OpCommand

const list<string>&  command_parts ()

command_parts

[const]

const string&  command_name ()

command_name

[const]

const string&  help_string ()

help_string

[const]

const string&  module ()

module

[const]

const string&  command_action ()

command_action

[const]

void  set_help_string (const string& v)

set_help_string

void  set_module (const string& v)

set_module

void  set_command_action (const string& v)

set_command_action

void  set_command_action_filename (const string& v)

set_command_action_filename

void  set_command_action_argument_list (const list<string>& v)

set_command_action_argument_list

void  set_command_executable_filename (const string& v)

set_command_executable_filename

bool  is_executable ()

is_executable

[const]

bool  can_pipe ()

can_pipe

[const]

bool  default_nomore_mode ()

default_nomore_mode

[const]

Test if "no-more" (i.e., unpaged) is the default output mode.

Returns: true if "no-more" (i.e., unpaged) is the default output mode, otherwise false.

void  set_default_nomore_mode (bool v)

set_default_nomore_mode

Set the default paging mode.

Parameters:

vif true, then "no-more" (i.e., unpaged) is the default output mode.
void  add_opt_param (const string& opt_param, const string& opt_param_help)

add_opt_param

bool  has_opt_param (const string& opt_param)

has_opt_param

[const]

string  str ()

str

[const]

string  command_parts2command_name (const list<string>& command_parts)

command_parts2command_name

[static]

list<string>  select_positional_argument ( const list<string>& argument_list, const string& position, string& error_msg)

select_positional_argument

[static]

Select a positional argument.

Parameters:

argument_listthe list with the arguments.
positionthe positional argument (e.g., "$0" specifies all arguments, "$1" is the first argument, "$2" the second argument, etc.)
error_msgthe error message (if error).

Returns: if position is valid, then a list with the the strings with the selected arguments, or an empty string if an error. Note that only if the position argument is "$0", then the list will contain more than one elements.

OpInstance*  execute (EventLoop& eventloop, const list<string>& command_line, RouterCLI::OpModePrintCallback print_cb, RouterCLI::OpModeDoneCallback done_cb)

execute

Execute an operational mode command.

Parameters:

eventloopthe event loop.
command_linethe list with the command to execute and the arguments.
print_cbcallback to be invoked with output from command.
done_cbcallback to invoke when the command terminates.

Returns: a pointer to the command instance on success.

bool  command_match (const list<string>& path_parts, SlaveConfigTree* sct, bool exact_match)

command_match

[const]

void  get_matches (size_t wordnum, SlaveConfigTree* sct, map<string, CliCommandMatch>& return_matches)

get_matches

[const]

bool  type_match (const string& s, string& errmsg)

type_match

[const]

void  add_instance (OpInstance* instance)

add_instance

void  remove_instance (OpInstance* instance)

remove_instance

bool  is_invalid ()

is_invalid

[const]

void  set_is_invalid (bool v)

set_is_invalid


Generated by: pavlin on possum.icir.org on Wed Aug 2 15:36:46 2006, using kdoc $.