---

CStateTransitionCommand Class Reference

#include <CStateTransitionCommand.h>

Inheritance diagram for CStateTransitionCommand:

List of all members.

Public Methods
	CStateTransitionCommand (const char *pCmd)
	CStateTransitionCommand (const string &rCmd)
virtual	~CStateTransitionCommand ()
	Destructor.
CRunState &	getRunState () const
virtual int	ExecutePreFunction ()=0
virtual int	ExecutePostFunction ()=0
Private Methods
	CStateTransitionCommand (const CStateTransitionCommand &rhs)
CStateTransitionCommand &	operator= (const CStateTransitionCommand &rhs)
int	operator== (const CStateTransitionCommand &rhs) const
int	operator!= (const CStateTransitionCommand &rhs) const
Private Attributes
CRunState &	m_rRunState
	Run state machine.

---

Detailed Description

Encapsulates all run state transition commands. This allows a run state transition command to be passed to the experiment object which will manage the flow of the transition and perform appropriate callbacks to us.

\note: This is an abstract base class.

Definition at line 309 of file CStateTransitionCommand.h.

---

Constructor & Destructor Documentation

CStateTransitionCommand::CStateTransitionCommand (  const char *    pName )

Construct the command given a const char* command name. We must construct: Our base class which will be given an initial null interpreter (it is expected the caller will do a Bind). m_rRunState constructed as a reference to the run state object held by the main program object. Definition at line 293 of file CStateTransitionCommand.cpp.

CStateTransitionCommand::CStateTransitionCommand (  const string &    rName )

Construct the command given a const string& command name. We must construct: Our base class which will be given an initial null interpreter (it is expected the caller will do a Bind). m_rRunState constructed as a reference to the run state object held by the main program object. Definition at line 307 of file CStateTransitionCommand.cpp.

virtual CStateTransitionCommand::~CStateTransitionCommand (    )  [inline, virtual]

Destructor. Definition at line 319 of file CStateTransitionCommand.h.

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

---

Member Function Documentation

int CStateTransitionCommand::ExecutePostFunction (    )  [pure virtual]

Called to execute the PostBegin script (if defined). Note: This will be called back from the start function of CExperiment so that that object doesn't have to know much about scripts. etc. \end note Parameters: Implemented in CBeginCommand, CEndCommand, CPauseCommand, and CResumeCommand. Definition at line 343 of file CStateTransitionCommand.cpp. Referenced by CExperiment::Start(), and CExperiment::Stop().

int CStateTransitionCommand::ExecutePreFunction (    )  [pure virtual]

Executes the PreBegin script; returning the status and result string. Note: This is a callback given to the Experiment begin run function so that it does not need to know how to execute Tcl scripts. \endnote Parameters: Implemented in CBeginCommand, CEndCommand, CPauseCommand, and CResumeCommand. Definition at line 326 of file CStateTransitionCommand.cpp. Referenced by CExperiment::Start(), and CExperiment::Stop().

CRunState& CStateTransitionCommand::getRunState (    )  const [inline]

Definition at line 331 of file CStateTransitionCommand.h.

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

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

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

---

Member Data Documentation

CRunState& CStateTransitionCommand::m_rRunState [private]

Run state machine. Definition at line 312 of file CStateTransitionCommand.h.

---

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

• CStateTransitionCommand.h
• CStateTransitionCommand.cpp

---