---

CExitCommand Class Reference

#include <CExitCommand.h>

List of all members.

Public Methods
	CExitCommand ()
	Default constructor.
	~CExitCommand ()
	Destructor.
CRunState &	getRunState ()
virtual int	operator() (CTCLInterpreter &rInterp, CTCLResult &rResult, int argc, char **argv)
virtual int	Shutdown (CTCLInterpreter &rInterp)
Private Methods
	CExitCommand (const CExitCommand &rhs)
	Copy constructor.
CExitCommand &	operator= (const CExitCommand &rhs)
	Assignment.
int	operator== (const CExitCommand &rhs) const
	Comparison for equality.
int	operator!= (const CExitCommand &rhs) const
Private Attributes
CRunState &	m_rRunState
	Current run state.

---

Constructor & Destructor Documentation

CExitCommand::CExitCommand (    )

Default constructor. Default constructor. This is called when declarations of the form e.g.: CExitCommand object; are performed. Definition at line 293 of file CExitCommand.cpp.

CExitCommand::~CExitCommand (    )  [inline]

Destructor. Definition at line 304 of file CExitCommand.h.

CExitCommand::CExitCommand (  const CExitCommand &    rhs )  [private]

Copy constructor.

---

Member Function Documentation

CRunState& CExitCommand::getRunState (    )  [inline]

Definition at line 314 of file CExitCommand.h.

int CExitCommand::operator!= (  const CExitCommand &    rhs )  const [private]

int CExitCommand::operator() (  CTCLInterpreter &    rInterp, CTCLResult &    rResult, int    argc, char **    argv )  [virtual]

Executes the exit command: It is an error to attempt to exit when the run is active. The shutdown C++ actions are performed. The shutdown script action is performed. The application exits. Parameters: rInterp  - Interpreter under which the command is running. rResult  - Result string returned to the interpreter. argc,argv  - Parameters in the command (argv[0] is command). Syntax: exit Returns: TCL_OK - if everything worked. Returns: TCL_ERROR - if there was some sort of error. Note: If TCL_ERROR is returned, rResult has a string containing the reason for the error. Definition at line 324 of file CExitCommand.cpp. References CReadoutMain::Exit(), CReadoutMain::getInstance(), CRunState::getState(), CRunState::Inactive, m_rRunState, and Shutdown().

CExitCommand& CExitCommand::operator= (  const CExitCommand &    rhs )  [private]

Assignment.

int CExitCommand::operator== (  const CExitCommand &    rhs )  const [private]

Comparison for equality.

int CExitCommand::Shutdown (  CTCLInterpreter &    rInterp )  [virtual]

Performs the finalization user actions: Invokes the C++ shutdown operations. Invokes the Tcl shutdown script. Parameters: rInterp  - Script under which the exit command is running. Definition at line 357 of file CExitCommand.cpp. Referenced by operator()().

---

Member Data Documentation

CRunState& CExitCommand::m_rRunState [private]

Current run state. Definition at line 298 of file CExitCommand.h. Referenced by operator()().

---

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

• CExitCommand.h
• CExitCommand.cpp

---