class CommandInformation

Class for TCL command description

Inheritance:

Public Methods

int	(*getCommand(void) const) (TclModule *m, int argc, char **argv) returns command callback function (0 if none was set)
TclString*	getSynopsis (void) const returns command synopsis
std::map < char *, CommandOption *, CStringCompare > *	getOptions (void) const return command options hashtable
static int	genericCmd (ClientData cd, Tcl_Interp *interp, int argc, char **argv) TCL callback command

Public

	Constructors _description command description string (TclModule *m, const char *_name, int(*fct)(TclModule *m, int argc, char **argv), const char *_synopsis = 0, const char *_description = 0) builds a new command calling back one global function _description command description string (const char *_name, std::map < char *, CommandOption *, CStringCompare > *_options, const char *_description = 0) builds a new command calling back one object method per option
	Destructor ~CommandInformation () empty
int	argv arguments array (int argc, char **argv) const execute command with given arguments

Protected Fields

const char*	name command name
const char*	synopsis command synopsis
const char*	description commandeffect description
std::map < char *, CommandOption *, CStringCompare > *	options command options hashtable (can be empty if globalCommand != 0)
TclModule*	module command module

Protected Methods

int	(*globalCommand) (TclModule *m, int argc, char **argv) command callback function (can be 0 if options is not empty)

const char* name

command name

const char* synopsis

command synopsis

const char* description

commandeffect description

std::map < char *, CommandOption *, CStringCompare > * options

command options hashtable (can be empty if globalCommand != 0)

int (*globalCommand)(TclModule *m, int argc, char **argv)

command callback function (can be 0 if options is not empty)

TclModule* module

command module

Constructors

_description command description string (TclModule *m, const char *_name, int(*fct)(TclModule *m, int argc, char **argv), const char *_synopsis = 0, const char *_description = 0)

builds a new command calling back one global function

_description command description string (const char *_name, std::map < char *, CommandOption *, CStringCompare > *_options, const char *_description = 0)

builds a new command calling back one object method per option

Destructor

~CommandInformation()

empty

int (*getCommand(void) const)(TclModule *m, int argc, char **argv)

returns command callback function (0 if none was set)

TclString* getSynopsis(void) const

returns command synopsis

std::map < char *, CommandOption *, CStringCompare > * getOptions(void) const

return command options hashtable

int argv arguments array (int argc, char **argv) const

execute command with given arguments

static int genericCmd(ClientData cd, Tcl_Interp *interp, int argc, char **argv)

TCL callback command

alphabetic index hierarchy of classes

this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de