CmdAction Class Reference

#include <CmdAction.h>

Inheritance diagram for CmdAction:

Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual int doIt (CmdContext *cc, JCPN(Vector)*args)=0
virtual char * help ()=0
virtual char * argtype ()=0
virtual char ** names (int &len)=0


Detailed Description

CmdAction is the interface specification for adding a command to a CmdParse parser.

Member Function Documentation

virtual int CmdAction::doIt ( CmdContext cc,
JCPN(Vector)*  args 
) [pure virtual]

virtual char* CmdAction::help (  )  [pure virtual]

virtual char* CmdAction::argtype (  )  [pure virtual]

Describes the args Vector wanted by this Command.

 This is our hack to get around stupid varargs-lessness in java.
 Each character indicates a separate user argument and its type.
 Type checked user input:
   C --> class named by user.
   c --> optional class named by user.
   I --> instance named by user.
   i --> optional instance named by user.
   S --> string token from user.
   s --> optional string token from user.
   K --> long token from user.
   k --> optional long token from user.
   D --> int token from user.
   d --> optional int token from user.
   B --> bool token from user.
   b --> optional bool token from user.
   G --> double token from user.
   g --> optional double token from user.
   * --> repeat previous character ad infinitum. can only appear last. 
 Special (cannot be followed directly by *):
   A --> all of the line after the command name token as a single string.
   a --> all of the line after the command name token as optional string.
   L --> the list of known CmdActions.
   P --> the command parser itself. 
 

Implemented in CmdActionExit, CmdActionHelp, CmdActionCCAArena, CmdActionCCAConfig, CmdActionCCAConnect, CmdActionCCADebug, CmdActionCCADisconnect, CmdActionCCADisplay, CmdActionCCAGo, CmdActionCCAInstantiate, CmdActionCCALinks, CmdActionCCANoDebug, CmdActionCCANuke, CmdActionCCAPallet, CmdActionCCAPath, CmdActionCCAPortProperties, CmdActionCCAProperties, CmdActionCCARemove, CmdActionCCARepository, and CmdActionCCAShell.

virtual char** CmdAction::names ( int &  len  )  [pure virtual]


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

Generated on Thu Mar 17 13:10:34 2011 for CCAFFEINE by  doxygen 1.5.9