CCAENModule Class Reference

#include <CCAENModule.h>

Inheritance diagram for CCAENModule:

[legend]Collaboration diagram for CCAENModule:


Public Member Functions
	CCAENModule (const string &rCommand, CTCLInterpreter &rInterp)
virtual	~CCAENModule ()
CAENcard *	getCard ()
bool	isMultiEvent () const
virtual void	Initialize ()
virtual void	Prepare ()
virtual void	Read (DAQWordBufferPtr &rBuffer)
virtual int	Read (void *pBuffer)
virtual void	Clear ()
	CCAENModule (const string &rCommand, CTCLInterpreter &rInterp)
virtual	~CCAENModule ()
CAENcard *	getCard ()
bool	isMultiEvent () const
virtual void	Initialize ()
	Initialize the readable (pure virt.).
virtual void	Prepare ()
	Prepare module for readout (pure virt.).
virtual void	Read (DAQWordBufferPtr &rBuffer)
	Read to DAQ buf.
virtual int	Read (void *pBuffer)
	Read to ordinary buf.
virtual void	Clear ()
	Clear (after read e.g.).(Pure virt).
Protected Member Functions
void	setCard (CAENcard *pCard)
void	setMultiEvent (bool on)
void	setCard (CAENcard *pCard)
void	setMultiEvent (bool on)
Private Member Functions
	CCAENModule (const CCAENModule &rhs)
CCAENModule &	operator= (const CCAENModule &rhs)
int	operator== (const CCAENModule &rhs)
int	operator!= (const CCAENModule &rhs)
	CCAENModule (const CCAENModule &rhs)
CCAENModule &	operator= (const CCAENModule &rhs)
int	operator== (const CCAENModule &rhs)
int	operator!= (const CCAENModule &rhs)
Private Attributes
CAENcard *	m_pCAENcard
	Pointer to the underlying driver.
bool	m_fMultiEvent
	If true Prepare does not clear.
CAENcard *	m_pCAENcard
	Pointer to the underlying driver.

Detailed Description

This class encapsulates the common features of the CAEN 32 channel adc,tdc,qdc modules. For the most part these modules are all identical, they are peak sensing ADC's with differnt x to peak converters. All modules support the following configuration parameters:

crate n - n is an integer VME crate number for the crate holding the module.
slot n - n is the VME slot number holding the VME card.
threshold t[32] - t are the 32 thresholds in mv. Value will be computed taking into account the full scale selection.
keepunder b - b is "on" or "off" depending on whether or not to keep data that does not make threshold.
keepoverflow b - b is "on" or "off" depending on whether or not to keep overflow data.
keepinvalid b - b is "on" or "off" depending on whether or not to keep data that is strobed in when the module is busy resetting.
card b - "on" to enable the card "off" to disable it.
enable i[32] - 32 channel enables. Nonzero is enabled, zero disabled.
fastclearwindow n - N is the width of the fast clear window in ns. Note that the current module has a width window width granularity of 31.25ns. The software will choose the closest value, and enforce a minimum of 0 and a maximum of 2ms (2,000,000 ns).
multievent b - True to run the module in multievent mode. in multievent mode, the module is note cleared after each readout in Prepare()

Definition at line 57 of file CCAENModule.h.

Constructor & Destructor Documentation

CCAENModule::CCAENModule ( const string & rName,

CTCLInterpreter & rInterpreter

)

Constructs a CAEN module object. The constructor creates the common set of configuration options that are recognized by all types of modules.

Parameters:

rName (const string& [in]): Command name that will be associated with this module. note that CCAENModules never get built by themselves, only their concrete model specific sub-clases.

rInterpeter (CTCLInterpreter& [in]): The interpreter on which this object's manipulating command will be registered.

Definition at line 304 of file CCAENModule.cpp.
References CConfigurableObject::AddBoolParam(), CDigitizerModule::AddIntArrayParam(), CDigitizerModule::AddIntParam(), CDigitizerModule::AddStringArrayParam(), CHANNELS(), CDigitizerModule::end(), CDigitizerModule::Find(), CDigitizerModule::ParameterIterator, CIntArrayParam::setRange(), and CIntConfigParam::setRange().

CCAENModule::~CCAENModule ( ) [virtual]

Definition at line 569 of file CCAENModule.cpp.
References m_pCAENcard.

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

CCAENModule::CCAENModule ( const string & rCommand,

CTCLInterpreter & rInterp

)

virtual CCAENModule::~CCAENModule ( ) [virtual]

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

Member Function Documentation

virtual void CCAENModule::Clear ( ) [virtual]

Clear (after read e.g.).(Pure virt).

Implements CDigitizerModule.
Reimplemented in CCAENV775, CCAENV785, CCAENV792, CCAENV775, CCAENV785, and CCAENV792.

void CCAENModule::Clear ( ) [virtual]

Called to clear any pending data from the module.
Implements CDigitizerModule.
Reimplemented in CCAENV775, CCAENV785, CCAENV792, CCAENV775, CCAENV785, and CCAENV792.
Definition at line 563 of file CCAENModule.cpp.
References m_pCAENcard.
Referenced by CCAENV792::Clear(), CCAENV785::Clear(), and CCAENV775::Clear().

CAENcard* CCAENModule::getCard ( ) [inline]

Reimplemented in CCAENV785, and CCAENV785.
Definition at line 77 of file include/CCAENModule.h.
References m_pCAENcard.

CAENcard* CCAENModule::getCard ( ) [inline]

Reimplemented in CCAENV785, and CCAENV785.
Definition at line 77 of file CCAENModule.h.
References m_pCAENcard.
Referenced by CTriggerCommand::Initialize(), CCAENV792::Initialize(), and CCAENV775::Initialize().

virtual void CCAENModule::Initialize ( ) [virtual]

Initialize the readable (pure virt.).

Implements CDigitizerModule.
Reimplemented in CCAENV775, CCAENV785, CCAENV792, CCAENV775, CCAENV785, and CCAENV792.

void CCAENModule::Initialize ( ) [virtual]

Initializes a module. This is the function that will actually create the underlying module driver object. The parameters are processed and used to configure it.
Implements CDigitizerModule.
Reimplemented in CCAENV775, CCAENV785, CCAENV792, CCAENV775, CCAENV785, and CCAENV792.
Definition at line 386 of file CCAENModule.cpp.
References CHANNELS(), CDigitizerModule::end(), CDigitizerModule::Find(), CBoolConfigParam::getOptionValue(), CIntConfigParam::getOptionValue(), m_fMultiEvent, m_pCAENcard, and CDigitizerModule::ParameterIterator.
Referenced by CCAENV792::Initialize(), CCAENV785::Initialize(), and CCAENV775::Initialize().

bool CCAENModule::isMultiEvent ( ) const [inline]

Definition at line 80 of file include/CCAENModule.h.
References m_fMultiEvent.

bool CCAENModule::isMultiEvent ( ) const [inline]

Definition at line 80 of file CCAENModule.h.
References m_fMultiEvent.

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

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

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

virtual void CCAENModule::Prepare ( ) [virtual]

Prepare module for readout (pure virt.).

Implements CDigitizerModule.
Reimplemented in CCAENV775, CCAENV785, CCAENV792, CCAENV775, CCAENV785, and CCAENV792.

void CCAENModule::Prepare ( ) [virtual]

Called on a per event basis to prepare the card to accept the next trigger. For the CAEN modules, this is a no-op, once initialized, they're ready to go.
Implements CDigitizerModule.
Reimplemented in CCAENV775, CCAENV785, CCAENV792, CCAENV775, CCAENV785, and CCAENV792.
Definition at line 513 of file CCAENModule.cpp.
References m_fMultiEvent, and m_pCAENcard.
Referenced by CCAENV792::Prepare(), CCAENV785::Prepare(), and CCAENV775::Prepare().

virtual int CCAENModule::Read ( void * pBuffer ) [virtual]

Read to ordinary buf.

Implements CDigitizerModule.

virtual void CCAENModule::Read ( DAQWordBufferPtr & rBuffer ) [virtual]

Read to DAQ buf.

Implements CDigitizerModule.
Reimplemented in CCAENV775, CCAENV785, CCAENV792, CCAENV775, CCAENV785, and CCAENV792.

int CCAENModule::Read ( void * pBuffer ) [virtual]

Called to read an event into a nondaq buffer. this can be used for testing, but is really there to make the infrastructure of scaler and event reads identical.
Returns:
Number of words read.

Implements CDigitizerModule.
Definition at line 548 of file CCAENModule.cpp.
References m_pCAENcard.

void CCAENModule::Read ( DAQWordBufferPtr & rBuffer ) [virtual]

Reads an event from the card into the current event buffer
Parameters:

rBuffer (DAQWordBufferPtr& [modified]). Pointer like object to the target datat buffer. Data wil be read from the ADC to the location 'pointed to by the pointer.

Note:
The module is silently ignored if it has not yet caused a card to be instantiated.

Implements CDigitizerModule.
Reimplemented in CCAENV775, CCAENV785, CCAENV792, CCAENV775, CCAENV785, and CCAENV792.
Definition at line 529 of file CCAENModule.cpp.
References m_pCAENcard, and WAITLOOPS().
Referenced by CCAENV792::Read(), CCAENV785::Read(), and CCAENV775::Read().

void CCAENModule::setCard ( CAENcard * pCard ) [inline, protected]

Reimplemented in CCAENV785, and CCAENV785.
Definition at line 86 of file include/CCAENModule.h.
References m_pCAENcard.

void CCAENModule::setCard ( CAENcard * pCard ) [inline, protected]

Reimplemented in CCAENV785, and CCAENV785.
Definition at line 86 of file CCAENModule.h.
References m_pCAENcard.

void CCAENModule::setMultiEvent ( bool on ) [inline, protected]

Definition at line 89 of file include/CCAENModule.h.
References m_fMultiEvent.

void CCAENModule::setMultiEvent ( bool on ) [inline, protected]

Definition at line 89 of file CCAENModule.h.
References m_fMultiEvent.

Member Data Documentation

bool CCAENModule::m_fMultiEvent [private]

If true Prepare does not clear.

Reimplemented in CCAENV785.
Definition at line 61 of file include/CCAENModule.h.
Referenced by Initialize(), isMultiEvent(), Prepare(), and setMultiEvent().

CAENcard* CCAENModule::m_pCAENcard [private]

Pointer to the underlying driver.

Reimplemented in CCAENV785, and CCAENV785.
Definition at line 60 of file include/CCAENModule.h.

CAENcard* CCAENModule::m_pCAENcard [private]

Pointer to the underlying driver.

Reimplemented in CCAENV785, and CCAENV785.
Definition at line 60 of file CCAENModule.h.
Referenced by Clear(), getCard(), Initialize(), Prepare(), Read(), setCard(), and ~CCAENModule().

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

Generated on Fri Mar 12 13:04:31 2004 for Scripted Readout by

1.3.4

CCAENModule Class Reference

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation