Public Types | Public Member Functions | Protected Attributes
DxlROSCommand Class Reference

Motor command. More...

#include <console.h>

List of all members.

Public Types

typedef std::vector< std::string > ArgList

Public Member Functions

 DxlROSCommand (DxlROSConsole *console, std::string name, size_t nargs, std::string help)
bool execute (ArgList args)
 Executes the command with certain arguments.
std::string getHelp ()
 Returns help information.
bool match (std::string cmd, ArgList args)
 Check whether a command line matches this command.
bool matchHelp (std::string cmd, ArgList args)
 Check whether a command line loosely matches this command.

Protected Attributes

DxlROSConsoleconsole_
 Console on which to execute command.
std::string help_
 Help information.
std::string name_
 Command name.
size_t nargs_
 Number of arguments.

Detailed Description

Motor command.

Definition at line 10 of file console.h.


Member Typedef Documentation

typedef std::vector<std::string> DxlROSCommand::ArgList

Definition at line 13 of file console.h.


Constructor & Destructor Documentation

DxlROSCommand::DxlROSCommand ( DxlROSConsole console,
std::string  name,
size_t  nargs,
std::string  help 
) [inline]

Definition at line 22 of file console.h.


Member Function Documentation

Executes the command with certain arguments.

Definition at line 29 of file console.cpp.

std::string DxlROSCommand::getHelp ( ) [inline]

Returns help information.

Definition at line 40 of file console.h.

bool DxlROSCommand::match ( std::string  cmd,
ArgList  args 
) [inline]

Check whether a command line matches this command.

Definition at line 28 of file console.h.

bool DxlROSCommand::matchHelp ( std::string  cmd,
ArgList  args 
) [inline]

Check whether a command line loosely matches this command.

Definition at line 34 of file console.h.


Member Data Documentation

Console on which to execute command.

Definition at line 16 of file console.h.

std::string DxlROSCommand::help_ [protected]

Help information.

Definition at line 19 of file console.h.

std::string DxlROSCommand::name_ [protected]

Command name.

Definition at line 18 of file console.h.

size_t DxlROSCommand::nargs_ [protected]

Number of arguments.

Definition at line 17 of file console.h.


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


threemxl
Author(s):
autogenerated on Fri Aug 28 2015 13:21:09