BLCMDexit Class Reference

Inheritance diagram for BLCMDexit:

BLCommand

List of all members.


Detailed Description

class BLCMDexit implements the exit command to exit the input file.

Public Member Functions

 BLCMDexit ()
G4String commandName ()
int command (BLArgumentVector &argv, BLArgumentMap &namedArgs)

Constructor & Destructor Documentation

BLCMDexit::BLCMDexit (  ) 

References BLCMDTYPE_CONTROL, BLCommand::registerCommand(), BLCommand::setDescription(), and BLCommand::setSynopsis().

00038 {
00039         registerCommand(BLCMDTYPE_CONTROL);
00040         setSynopsis("exit a command file.");
00041         setDescription("The exit command ceases reading the input file,\n"
00042                 "and starts the simulation immediately (ignoring the\n"
00043                 "remainder of the input file).");
00044 }


Member Function Documentation

G4String BLCMDexit::commandName (  )  [inline, virtual]

Implements BLCommand.

00028 { return "exit"; }

int BLCMDexit::command ( BLArgumentVector argv,
BLArgumentMap namedArgs 
) [virtual]

Implements BLCommand.

References BLCommand::getNextCommand().

00047 {
00048         // skip to EOF on current input
00049         for(;;) {
00050                 if(!BLCommand::getNextCommand()) break;
00051         }
00052         return 0;
00053 }


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