CTclCommand Class Reference

#include <CTclCommand.h>

Inheritance diagram for CTclCommand:

Public Member Functions
	CTclCommand (Tcl_Interp *pInterp, const char *cmdName)
virtual	~CTclCommand ()
virtual int	operator() (std::vector< Tcl_Obj * > &argv)=0

Protected Member Functions
Tcl_Interp *	getInterpreter ()
void	requireExactly (std::vector< Tcl_Obj * > &objv, int nParams)
void	requireAtMost (std::vector< Tcl_Obj * > &objv, int max)
void	setResult (const char *result)
void	setResult (Tcl_Obj *result)
void	setResult (double value)
void	setResult (int value)
int	getInteger (Tcl_Obj *intObj)
double	getDouble (Tcl_Obj *dblObj)

Detailed Description

This class is a light weight replacement for CTCLObjectCommand. in this project we don't have the libtcl++ library available but this makes object oriented command handlers somewhat simpler.

Constructor & Destructor Documentation

CTclCommand()

CTclCommand::CTclCommand	(	Tcl_Interp *	pInterp,
		const char *	cmdName
	)

constructor

Parameters

pInterp	Interpreter on which the command is registered.
cmdName	Command name string.

Note

The client data will be a pointer to this object so that the static commandRelay method actually registered as the command handler can invoke operator().

We assume the registration works.

~CTclCommand()

CTclCommand::~CTclCommand ( )

virtual

destructor unregisters the command

Member Function Documentation

getDouble()

double CTclCommand::getDouble ( Tcl_Obj *  dblObj )

protected

getDouble Get a double value from an object.

Parameters

dblObj

- the object.

Returns

double - the value.

Exceptions

std::string

if the object does not have double rep.

getInteger()

int CTclCommand::getInteger ( Tcl_Obj *  obj )

protected

getInteger Get an integer value from an object.

Parameters

obj	the object.

Returns

int the value.

Exceptions

std::string

if the object does not have a valid integer.

getInterpreter()

Tcl_Interp * CTclCommand::getInterpreter ( )

inlineprotected

operator()()

virtual int CTclCommand::operator() ( std::vector< Tcl_Obj * > &  argv )

pure virtual

Implemented in CInitSystem, CInventory, CBoot, CAdjustOffsets, CIsActive, CReadChanPar, CReadModPar, CRelease, CRestoreParams, CSaveParams, CWriteChanPar, and CWriteModPar.

requireAtMost()

void CTclCommand::requireAtMost ( std::vector< Tcl_Obj * > &  objv, int  max  )

protected

requireAtMost Require at most a specified number of command words.

Parameters

objv	- the command words.
max	- maximum number of words allowed.

Exceptions

std::string

error message if there are too many params.

requireExactly()

void CTclCommand::requireExactly ( std::vector< Tcl_Obj * > &  objv, int  nParams  )

protected

requireExactly Require an exact parameter count.

Parameters

objv	- the parameter vector.
nParams	- number required.

Exceptions

std::string

error message if there's not a match.

setResult() [1/4]

void CTclCommand::setResult ( const char *  result )

protected

setResult (String) Given a string, sets the Tcl intepreter result to it.

Parameters

result

the string

setResult() [2/4]

void CTclCommand::setResult ( double  value )

protected

setREsult (double)

setResult() [3/4]

void CTclCommand::setResult ( int  value )

protected

setResult(int)

setResult() [4/4]

void CTclCommand::setResult ( Tcl_Obj *  obj )

protected

setResult (Tcl_Obj*)

---

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

• CTclCommand.h
• CTclCommand.cpp