CTriggerCommand Class Reference

#include <CTriggerCommand.h>

Collaboration diagram for CTriggerCommand:


Public Member Functions
	CTriggerCommand (const string &rCommand, CTCLInterpreter &rInterp, CDigitizerDictionary *pDictionary)
virtual	~CTriggerCommand ()
CCAENModule *	getModule ()
CCAENTrigger *	getTrigger ()
CDigitizerDictionary *	getDictionary ()
int	operator() (CTCLInterpreter &rInterp, CTCLResult &rResult, int argc, char **argv)
void	Initialize ()
	CTriggerCommand (const string &rCommand, CTCLInterpreter &rInterp, CDigitizerDictionary *pDictionary)
virtual	~CTriggerCommand ()
CCAENModule *	getModule ()
CCAENTrigger *	getTrigger ()
CDigitizerDictionary *	getDictionary ()
int	operator() (CTCLInterpreter &rInterp, CTCLResult &rResult, int argc, char **argv)
void	Initialize ()
Protected Member Functions
void	setModule (CCAENModule *pModule)
void	setTrigger (CCAENTrigger *pTrigger)
void	setDictionary (CDigitizerDictionary *pDict)
void	setModule (CCAENModule *pModule)
void	setTrigger (CCAENTrigger *pTrigger)
void	setDictionary (CDigitizerDictionary *pDict)
Private Member Functions
	CTriggerCommand (const CTriggerCommand &rhs)
CTriggerCommand &	operator= (const CTriggerCommand &rhs)
int	operator== (const CTriggerCommand &rhs)
int	operator!= (const CTriggerCommand &rhs)
void	Usage (CTCLResult &rResult)
	CTriggerCommand (const CTriggerCommand &rhs)
CTriggerCommand &	operator= (const CTriggerCommand &rhs)
int	operator== (const CTriggerCommand &rhs)
int	operator!= (const CTriggerCommand &rhs)
void	Usage (CTCLResult &rResult)
Private Attributes
CDigitizerDictionary *	m_pDictionary
CCAENModule *	m_pModule
CCAENTrigger *	m_pTrigger
CDigitizerDictionary *	m_pDictionary
CCAENModule *	m_pModule
CCAENTrigger *	m_pTrigger

Detailed Description

This module provides a tcl command that allows us to select a trigger. The trigger module operates at define time as well as at run initiation time:

At define time the user issues a command like

trigger modulename

where modulename is the name of a module in the module dictionary. At this point, the only thing he trigger module does is locate this module or complain if it does not exist.

At run initiation time, the trigger module locates the underlying CCAEN card module driver and instantiates a CCAENTrigger object, and uses it to substitute for the Readout's normal trigger system. If the CAEN card module driver has not been instantiated yetm, this is also an error.

Definition at line 318 of file CTriggerCommand.h.

Constructor & Destructor Documentation

CTriggerCommand::CTriggerCommand ( const string & rCommand,

CTCLInterpreter & rInterp,

CDigitizerDictionary * pDictionary

)

Construct a trigger command object. The trigger command object responds to the trigger command which is used to select a module to serve as the event trigger.

Parameters:

rCommand (const string& [in]): Name of the command ... "trigger" usually.

rInterp (CTCLInterpreter& [in]): The interpreter on which this command will be entered.

pDictionary (CModuleDictionary* [in]): Pointer to the module dictionary that will have information about modules that are elligible to be triggers.

Definition at line 308 of file CTriggerCommand.cpp.
References pDictionary().

CTriggerCommand::~CTriggerCommand ( ) [virtual]

Destroy the command processor. This involves deleting the trigger.. note that the dictionary and trigger belong to external clients.
Definition at line 323 of file CTriggerCommand.cpp.
References m_pTrigger.

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

CTriggerCommand::CTriggerCommand ( const string & rCommand,

CTCLInterpreter & rInterp,

CDigitizerDictionary * pDictionary

)

virtual CTriggerCommand::~CTriggerCommand ( ) [virtual]

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

Member Function Documentation

CDigitizerDictionary* CTriggerCommand::getDictionary ( ) [inline]

Definition at line 344 of file include/CTriggerCommand.h.
References m_pDictionary.

CDigitizerDictionary* CTriggerCommand::getDictionary ( ) [inline]

Definition at line 344 of file CTriggerCommand.h.
References m_pDictionary.

CCAENModule* CTriggerCommand::getModule ( ) [inline]

Definition at line 338 of file include/CTriggerCommand.h.
References m_pModule.

CCAENModule* CTriggerCommand::getModule ( ) [inline]

Definition at line 338 of file CTriggerCommand.h.
References m_pModule.

CCAENTrigger* CTriggerCommand::getTrigger ( ) [inline]

Definition at line 341 of file include/CTriggerCommand.h.
References m_pTrigger.

CCAENTrigger* CTriggerCommand::getTrigger ( ) [inline]

Definition at line 341 of file CTriggerCommand.h.
References m_pTrigger.

void CTriggerCommand::Initialize ( )

void CTriggerCommand::Initialize ( )

Initialize the trigger module. This involves creating a CAENTrigger from the trigger module.
Definition at line 373 of file CTriggerCommand.cpp.
References CCAENModule::getCard(), gpStateMachine, m_pModule, and m_pTrigger.

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

int CTriggerCommand::operator() ( CTCLInterpreter & rInterp,

CTCLResult & rResult,

int argc,

char ** argv

)

int CTriggerCommand::operator() ( CTCLInterpreter & rInterp,

CTCLResult & rResult,

int argc,

char ** argv

)

Process the trigger command. The trigger command expects a sigle parameter, the name of a digitizer module that will be used to trigger the readout. At the time of this command, the dictionary must have an entry for this digiitzer.
Parameters:

rInterp (CTCLINterpreter& rInterp[in]): The interpreter that's executing this command. //

rResult (CTCLResult& rResult [out]): The result of the command for successs, this is just the name of the trigger module. For failure, a reason for the failure.

int argc, char**argv: The parameters (argv[0] is our command name.

Returns:
One of:

TCL_OK - If success.
TCL_ERROR - If failure.

Definition at line 347 of file CTriggerCommand.cpp.
References CDigitizerDictionary::DigitizerEnd(), CDigitizerDictionary::DigitizerFind(), m_pDictionary, m_pModule, CDigitizerDictionary::ModuleIterator, and Usage().

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

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

void CTriggerCommand::setDictionary ( CDigitizerDictionary * pDict ) [inline, protected]

Definition at line 356 of file include/CTriggerCommand.h.
References m_pDictionary.

void CTriggerCommand::setDictionary ( CDigitizerDictionary * pDict ) [inline, protected]

Definition at line 356 of file CTriggerCommand.h.
References m_pDictionary.

void CTriggerCommand::setModule ( CCAENModule * pModule ) [inline, protected]

Definition at line 350 of file include/CTriggerCommand.h.
References m_pModule.

void CTriggerCommand::setModule ( CCAENModule * pModule ) [inline, protected]

Definition at line 350 of file CTriggerCommand.h.
References m_pModule.

void CTriggerCommand::setTrigger ( CCAENTrigger * pTrigger ) [inline, protected]

Definition at line 353 of file include/CTriggerCommand.h.
References m_pTrigger.

void CTriggerCommand::setTrigger ( CCAENTrigger * pTrigger ) [inline, protected]

Definition at line 353 of file CTriggerCommand.h.
References m_pTrigger.

void CTriggerCommand::Usage ( CTCLResult & rResult ) [private]

void CTriggerCommand::Usage ( CTCLResult & rResult ) [private]

Put the command usage into a result string.
Definition at line 384 of file CTriggerCommand.cpp.
Referenced by operator()().