---

CInterpreterCore Class Reference

#include <CInterpreterCore.h>

List of all members.

Public Methods
	CInterpreterCore (CInterpreterStartup &rInterp)
	Default constructor.
virtual	~CInterpreterCore ()
CBeginCommand *	getBegin ()
CEndCommand *	getEnd ()
CPauseCommand *	getPause ()
CResumeCommand *	getResume ()
CRunVariableCommand *	getRunVariables ()
CStateVariableCommand *	getStateVariables ()
CConstVariableCommand *	getConstVariables ()
CTagBaseCommand *	getTagBase ()
CExitCommand *	getExit ()
CInterpreterStartup *	getStartup ()
CConstVariable *	getState ()
CConstVariable *	getStartTime ()
void	setState (const string &rNewValue)
void	setStartTime (const string &rNewValue)
void	setEvents (unsigned int nValue)
void	setWords (unsigned int nValue)
virtual void	RegisterExtensions ()
Private Methods
	CInterpreterCore (const CInterpreterCore &rhs)
	Copy constructor (not allowed).
CInterpreterCore &	operator= (const CInterpreterCore &rhs)
	Assignment (not allowed).
int	operator== (const CInterpreterCore &rhs) const
	Comparison for equality. (not allowed).
int	operator!= (const CInterpreterCore &rhs) const
	!= operator (not allowed)
Private Attributes
CInterpreterStartup &	m_rInterpreter
	Interpreter startup for this object.
CBeginCommand *	m_pBegin
	Pointer to the Begin command object.
CEndCommand *	m_pEnd
	Pointer to the End command object.
CPauseCommand *	m_pPause
	Pointer to the Pause command object.
CResumeCommand *	m_pResume
	Pointer to the Resume command object.
CRunVariableCommand *	m_pRunVariable
	Pointer to object maintaining runvariables.
CStateVariableCommand *	m_pStateVariable
	Pointer to object maintaining state vars.
CTagBaseCommand *	m_pTagBase
	Pointer to object maintaining latent tagbase support.
CExitCommand *	m_pExit
	Pointer to safe exit command object.
CConstVariableCommand	m_Const
	const command object default const ok.
CTclAuthorizer *	m_pAuthorizer
	Authentication module for server.
CConstVariable *	m_pState
	Run state.
CConstVariable *	m_pStartTime
	Run Start Time.
CConstVariable *	m_pEvents
	Events in the run.
CConstVariable *	m_pWords
	Words acquired in run.

---

Detailed Description

Contains all of the core command extensions that will be registered on the run control interpreter. Introducing this class allows:

• For the command registration to be separated from the interpreter chosen (Tcl or Tk e.g.).
• For the application programmer to extend the base command set by deriving and overriding/extending.

One other key function of CInterpreterCore is to redefine the standard Tcl "exit" command to be "emergencyexit" This is done so that the core command set can provide a state sensitive exit command which e.g. refuses to exit during a run and can perform cleanup operations as well...yet retain exit for cases where people really want to abort runs.

Definition at line 337 of file CInterpreterCore.h.

---

Constructor & Destructor Documentation

CInterpreterCore::CInterpreterCore (  CInterpreterStartup &    rStartup )

Default constructor. Construct an interpreter core. Saves the interpreter startup object and constructs the commands. The commands are registered from the RegisterExtensions entry point. Parameters: rStartup  - reference to the interpreter startup object. Definition at line 302 of file CInterpreterCore.cpp.

CInterpreterCore::~CInterpreterCore (    )  [virtual]

Destructor: Release all dynamically produced members. In this case each member is a command object. It is unregistered and deleted. Definition at line 327 of file CInterpreterCore.cpp. References m_Const, m_pAuthorizer, m_pBegin, m_pEnd, m_pExit, m_pPause, m_pResume, m_pRunVariable, m_pState, m_pStateVariable, and m_pTagBase.

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

Copy constructor (not allowed).

---

Member Function Documentation

CBeginCommand* CInterpreterCore::getBegin (    )  [inline]

Definition at line 369 of file CInterpreterCore.h.

CConstVariableCommand* CInterpreterCore::getConstVariables (    )  [inline]

Definition at line 387 of file CInterpreterCore.h. References m_Const.

CEndCommand* CInterpreterCore::getEnd (    )  [inline]

Definition at line 372 of file CInterpreterCore.h.

CExitCommand* CInterpreterCore::getExit (    )  [inline]

Definition at line 393 of file CInterpreterCore.h.

CPauseCommand* CInterpreterCore::getPause (    )  [inline]

Definition at line 375 of file CInterpreterCore.h.

CResumeCommand* CInterpreterCore::getResume (    )  [inline]

Definition at line 378 of file CInterpreterCore.h.

CRunVariableCommand* CInterpreterCore::getRunVariables (    )  [inline]

Definition at line 381 of file CInterpreterCore.h. Referenced by CMyExperiment::SetupRunVariables(), and CExperiment::TriggerRunVariableBuffer().

CConstVariable* CInterpreterCore::getStartTime (    )  [inline]

Definition at line 403 of file CInterpreterCore.h. References m_pStartTime.

CInterpreterStartup* CInterpreterCore::getStartup (    )  [inline]

Definition at line 397 of file CInterpreterCore.h. References m_rInterpreter. Referenced by CTCLListener::CTCLListener().

CConstVariable* CInterpreterCore::getState (    )  [inline]

Definition at line 400 of file CInterpreterCore.h. References m_pState.

CStateVariableCommand* CInterpreterCore::getStateVariables (    )  [inline]

Definition at line 384 of file CInterpreterCore.h. Referenced by CExperiment::GetRunNumber(), CReadoutMain::getScalerPeriod(), CReadoutMain::getTitle(), CMyExperiment::SetupStateVariables(), and CExperiment::TriggerStateVariableBuffer().

CTagBaseCommand* CInterpreterCore::getTagBase (    )  [inline]

Definition at line 390 of file CInterpreterCore.h.

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

!= operator (not allowed)

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

Assignment (not allowed).

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

Comparison for equality. (not allowed).

void CInterpreterCore::RegisterExtensions (    )  [virtual]

Register the command extensions associated with a Readout interpreter. These extensions support: Run control State variables Run variables Parameters: CTCLInterpreter  * pInterp Definition at line 385 of file CInterpreterCore.cpp. References CTclAuthorizer::AddHost(), CReadoutMain::AddUserCommands(), CStateVariableCommand::begin(), CStateVariableCommand::Create(), CStateVariableCommand::end(), CReadoutMain::getExperiment(), CReadoutMain::getInstance(), CReadoutMain::getPort(), CReadoutMain::getServer(), CReadoutMain::getWindowed(), m_Const, m_pAuthorizer, m_pBegin, m_pEnd, m_pEvents, m_pExit, m_pPause, m_pResume, m_pRunVariable, m_pStartTime, m_pState, m_pStateVariable, m_pTagBase, m_pWords, m_rInterpreter, CReadoutMain::SetupRunVariables(), CReadoutMain::SetupStateVariables(), and StateVariableIterator. Referenced by CTkInterpreterShell::RegisterExtensions(), CTclInterpreterShell::RegisterExtensions(), and CInterpreterShell::RegisterExtensions().

void CInterpreterCore::setEvents (  unsigned int    nValue )

Set a current value for the number of events acquired. Parameters: nValue  unsigned int [in] New value for the "events" const. Definition at line 570 of file CInterpreterCore.cpp. References m_pEvents. Referenced by CExperiment::ReadEvent(), and CExperiment::Start().

void CInterpreterCore::setStartTime (  const string &    rNewValue )  [inline]

Definition at line 411 of file CInterpreterCore.h. References m_pStartTime. Referenced by CExperiment::Start().

void CInterpreterCore::setState (  const string &    rNewValue )  [inline]

Definition at line 408 of file CInterpreterCore.h. References m_pState.

void CInterpreterCore::setWords (  unsigned int    nValue )

Set the value of the "words" const. This const tells you how many words of data have been acquired in the current run. Parameters: nValue  unsigned int [in] New value. Definition at line 582 of file CInterpreterCore.cpp. References m_pWords. Referenced by CExperiment::ReadEvent(), and CExperiment::Start().

---

Member Data Documentation

CConstVariableCommand CInterpreterCore::m_Const [private]

const command object default const ok. Definition at line 350 of file CInterpreterCore.h. Referenced by getConstVariables(), RegisterExtensions(), and ~CInterpreterCore().

CTclAuthorizer* CInterpreterCore::m_pAuthorizer [private]

Authentication module for server. Definition at line 351 of file CInterpreterCore.h. Referenced by RegisterExtensions(), and ~CInterpreterCore().

CBeginCommand* CInterpreterCore::m_pBegin [private]

Pointer to the Begin command object. Definition at line 342 of file CInterpreterCore.h. Referenced by RegisterExtensions(), and ~CInterpreterCore().

CEndCommand* CInterpreterCore::m_pEnd [private]

Pointer to the End command object. Definition at line 343 of file CInterpreterCore.h. Referenced by RegisterExtensions(), and ~CInterpreterCore().

CConstVariable* CInterpreterCore::m_pEvents [private]

Events in the run. Definition at line 354 of file CInterpreterCore.h. Referenced by RegisterExtensions(), and setEvents().

CExitCommand* CInterpreterCore::m_pExit [private]

Pointer to safe exit command object. Definition at line 349 of file CInterpreterCore.h. Referenced by RegisterExtensions(), and ~CInterpreterCore().

CPauseCommand* CInterpreterCore::m_pPause [private]

Pointer to the Pause command object. Definition at line 344 of file CInterpreterCore.h. Referenced by RegisterExtensions(), and ~CInterpreterCore().

CResumeCommand* CInterpreterCore::m_pResume [private]

Pointer to the Resume command object. Definition at line 345 of file CInterpreterCore.h. Referenced by RegisterExtensions(), and ~CInterpreterCore().

CRunVariableCommand* CInterpreterCore::m_pRunVariable [private]

Pointer to object maintaining runvariables. Definition at line 346 of file CInterpreterCore.h. Referenced by RegisterExtensions(), and ~CInterpreterCore().

CConstVariable* CInterpreterCore::m_pStartTime [private]

Run Start Time. Definition at line 353 of file CInterpreterCore.h. Referenced by getStartTime(), RegisterExtensions(), and setStartTime().

CConstVariable* CInterpreterCore::m_pState [private]

Run state. Definition at line 352 of file CInterpreterCore.h. Referenced by getState(), RegisterExtensions(), setState(), and ~CInterpreterCore().

CStateVariableCommand* CInterpreterCore::m_pStateVariable [private]

Pointer to object maintaining state vars. Definition at line 347 of file CInterpreterCore.h. Referenced by RegisterExtensions(), and ~CInterpreterCore().

CTagBaseCommand* CInterpreterCore::m_pTagBase [private]

Pointer to object maintaining latent tagbase support. Definition at line 348 of file CInterpreterCore.h. Referenced by RegisterExtensions(), and ~CInterpreterCore().

CConstVariable* CInterpreterCore::m_pWords [private]

Words acquired in run. Definition at line 355 of file CInterpreterCore.h. Referenced by RegisterExtensions(), and setWords().

CInterpreterStartup& CInterpreterCore::m_rInterpreter [private]

Interpreter startup for this object. Definition at line 341 of file CInterpreterCore.h. Referenced by getStartup(), and RegisterExtensions().

---

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

• CInterpreterCore.h
• CInterpreterCore.cpp

---