CCAENV830Module Class Reference

#include <CCAENV830Module.h>

Inheritance diagram for CCAENV830Module:

[legend]Collaboration diagram for CCAENV830Module:


Public Member Functions
	CCAENV830Module (const string &rName, CTCLInterpreter &rInterp)
virtual	~CCAENV830Module ()
virtual void	Initialize ()
virtual void	Prepare ()
virtual void	Read (DAQWordBufferPtr &rBuffer)
virtual int	Read (void *pBuffer)
virtual void	Clear ()
virtual string	getType () const
	Return module type string (pure virt).
	CCAENV830Module (const string &rName, CTCLInterpreter &rInterp)
virtual	~CCAENV830Module ()
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).
virtual string	getType () const
	Return module type string (pure virt).
Private Member Functions
	CCAENV830Module (const CCAENV830Module &rhs)
CCAENV830Module &	operator= (const CCAENV830Module &rhs)
int	operator!= (const CCAENV830Module &rhs)
int	operator== (const CCAENV830Module &rhs)
	CCAENV830Module (const CCAENV830Module &rhs)
CCAENV830Module &	operator= (const CCAENV830Module &rhs)
int	operator!= (const CCAENV830Module &rhs)
int	operator== (const CCAENV830Module &rhs)
Private Attributes
CCAENV830 *	m_pModule
	The module hardware driver.
int	m_nId
	Packet id.
bool	m_fHeader
	True if headers enabled.
bool	m_fWide
	True if module reads are wide.
bool	m_fManualClear
	True if manual clear needed.
bool	m_fPacketize
	True if should add packet info.
bool	m_fVmeTrigger
	True if trigger via VME.
unsigned long	m_lEnables
	Channel enables mask.
int	m_nCrate
	Crate of module.
int	m_nSlot
	Slot of module.
CCAENV830 *	m_pModule
	The module hardware driver.

Detailed Description

This class is a TCL Configuration manager for a CAEN v830 scaler (CCAENV830). The configuration commands currently understood are:

base (integer) Base address of the module if it is not setup via geographical addressing. (geo false).
slot (integer) The slot number of the module if it is being setup via geographical addressing (geo true).
geo (boolean) true if the module is being setup geographically, false if the module is being setup using base-addressing.
crate (integer) The crate number the module is in (defaults 0)
enables (integer[32]) an array of flags for each channel, each flag is 0 to disable a channel and 1 to enable it.
trigger (integer) an integer encoding of the trigger mode as follows. 0 Disable, 1 Random 2 Periodic.
wide (boolean) If true, the module is read in 32 bit wide mode otherwise in 26 bit mode.
header (boolean) If true, the module will have a header, otherwise not.
autoreset (boolean) If true, the scalers reset after being latched via a trigger.
fpclearmeb (boolean) If true, the scaler MEB is cleared on a front panel clear (false, only the counters are cleared).
id (integer) The id of the packet created by the module (see below).
manualclear (boolean) If true, the scalers are manually reset via the clear function after the MEB is read out.
packetize (boolean) If true, read inserts additional packetization information in the readout stream. This is intended for use when the module is being used to supply event parameters (e.g. timing).
vmetrigger (boolean) If true, read does a vme trigger of the modules and then does the read. Requires trigger to be set to random.
parameters (string[32]) Set of parameter names associated with each channel of the module. This is used to setup the scaler display etc.

Since the module has modes in which it is not possible to mechanically decode it, if packetize is true, Read will insert additional information into the event stream:

The module will be an identified packet.. It will have a word count and an id (set by the id config parameter).

The module will include a word of mode information as as follows:

     +--------------------------------+
     |H|W|  Slot (5) |X|  Crate (8)   | 
     +-+-+-----------+-+--------------+
      ^ ^     ^       ^     ^
      | |     |       |     +--------- 8 bits of module crate num.
      | |     |       +--------------- 1 unused bit.
      | |     +----------------------- 5 bits of Geographical addr.
      | +----------------------------- 1 bit set if wide readout.
      +------------------------------- 1 bit set if header enabled.

If the W bit is set, an additional long word channel mask will be inserted in the data stream. This long word will be in little endian order (low order word first). Each bit of the longword represents a scaler channel and will be set if the channel is present. Note that the channels are then placed in the buffer from low channel number to high. In little endian word order.

Definition at line 364 of file CCAENV830Module.h.

Constructor & Destructor Documentation

CCAENV830Module::CCAENV830Module ( const string & rName,

CTCLInterpreter & rInterp

)

Construct a scaler module reader. This does not actually construct the underlying CCAENV830 module. Instead it constructs the configuration parameters for the module and defines them to the base class. The module driver itself will be constructed as a result of the Initialize() call.

Parameters:

rName (const string& [in]): Name to give to this module. This name will be registered to the interpreter as a command that can be used to configure the module.

rInterp (CTCLInterpreter& rInterp [in]): The interpreter on which this module will be registered as a command

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

CCAENV830Module::~CCAENV830Module ( ) [virtual]

Destruction of the module implies destruction of the card driver.
Definition at line 371 of file CCAENV830Module.cpp.
References m_pModule.

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

CCAENV830Module::CCAENV830Module ( const string & rName,

CTCLInterpreter & rInterp

)

virtual CCAENV830Module::~CCAENV830Module ( ) [virtual]

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

Member Function Documentation

virtual void CCAENV830Module::Clear ( ) [virtual]

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

Implements CDigitizerModule.

void CCAENV830Module::Clear ( ) [virtual]

Clear is not required on an event by event basis since it's done in read to minimize dropped counts.
Implements CDigitizerModule.
Definition at line 609 of file CCAENV830Module.cpp.

virtual string CCAENV830Module::getType ( ) const [inline, virtual]

Return module type string (pure virt).

Implements CDigitizerModule.
Definition at line 400 of file include/CCAENV830Module.h.

virtual string CCAENV830Module::getType ( ) const [inline, virtual]

Return module type string (pure virt).

Implements CDigitizerModule.
Definition at line 400 of file CCAENV830Module.h.

virtual void CCAENV830Module::Initialize ( ) [virtual]

Initialize the readable (pure virt.).

Implements CDigitizerModule.

void CCAENV830Module::Initialize ( ) [virtual]

Initialize the module. This means:

Destroying any existing module driver.
Recovering and processing the configuration so that we now how to build and configure a new module driver.
constructing a new module driver.

Implements CDigitizerModule.
Definition at line 385 of file CCAENV830Module.cpp.
References CCAENV830::Clear(), CCAENV830::DisableAutoReset(), CCAENV830::Disabled, CCAENV830::DisableHeader(), CCAENV830::EnableAutoReset(), CCAENV830::EnableHeader(), CDigitizerModule::Find(), CCAENV830::FPClearsMEB(), CBoolConfigParam::getOptionValue(), CIntConfigParam::getOptionValue(), m_fHeader, m_fManualClear, m_fPacketize, m_fVmeTrigger, m_fWide, m_lEnables, m_nCrate, m_nId, m_nSlot, m_pModule, CDigitizerModule::ParameterIterator, CCAENV830::Periodic, CCAENV830::Random, CCAENV830::SetEnableMask(), CCAENV830::SetNarrow(), CCAENV830::SetTriggerMode(), CCAENV830::SetWide(), and CCAENV830::TriggerMode.

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

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

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

virtual void CCAENV830Module::Prepare ( ) [virtual]

Prepare module for readout (pure virt.).

Implements CDigitizerModule.

void CCAENV830Module::Prepare ( ) [virtual]

Prepare to read an event (first or after the prior one). This is a NO-OP as the module does not need any resetting etc.
Implements CDigitizerModule.
Definition at line 522 of file CCAENV830Module.cpp.

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

Read to ordinary buf.

Implements CDigitizerModule.

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

Read to DAQ buf.

Implements CDigitizerModule.

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

Read the module into an ordinary buffer.
Implements CDigitizerModule.
Definition at line 556 of file CCAENV830Module.cpp.
References CCAENV830::Clear(), CCAENV830::isDataReady(), m_fHeader, m_fManualClear, m_fPacketize, m_fVmeTrigger, m_fWide, m_lEnables, m_nCrate, m_nId, m_nSlot, m_pModule, CCAENV830::ReadEvent(), and CCAENV830::Trigger().

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

Read an Event from the module. See the class documentation for the data format.

Parameters:

rBuffer (DAQWordBufferPtr& [out]): 'pointer' to the buffer to fill with data.

Note:
The buffer pointer is advanced beyond the data event to point to the next free word.

Implements CDigitizerModule.
Definition at line 536 of file CCAENV830Module.cpp.

Member Data Documentation

bool CCAENV830Module::m_fHeader [private]

True if headers enabled.

Definition at line 370 of file include/CCAENV830Module.h.
Referenced by Initialize(), and Read().

bool CCAENV830Module::m_fManualClear [private]

True if manual clear needed.

Definition at line 372 of file include/CCAENV830Module.h.
Referenced by Initialize(), and Read().

bool CCAENV830Module::m_fPacketize [private]

True if should add packet info.

Definition at line 373 of file include/CCAENV830Module.h.
Referenced by Initialize(), and Read().

bool CCAENV830Module::m_fVmeTrigger [private]

True if trigger via VME.

Definition at line 374 of file include/CCAENV830Module.h.
Referenced by Initialize(), and Read().

bool CCAENV830Module::m_fWide [private]

True if module reads are wide.

Definition at line 371 of file include/CCAENV830Module.h.
Referenced by Initialize(), and Read().

unsigned long CCAENV830Module::m_lEnables [private]

Channel enables mask.

Definition at line 375 of file include/CCAENV830Module.h.
Referenced by Initialize(), and Read().

int CCAENV830Module::m_nCrate [private]

Crate of module.

Definition at line 376 of file include/CCAENV830Module.h.
Referenced by Initialize(), and Read().

int CCAENV830Module::m_nId [private]

Packet id.

Definition at line 369 of file include/CCAENV830Module.h.
Referenced by Initialize(), and Read().

int CCAENV830Module::m_nSlot [private]

Slot of module.

Definition at line 377 of file include/CCAENV830Module.h.
Referenced by Initialize(), and Read().

CCAENV830* CCAENV830Module::m_pModule [private]

The module hardware driver.

Definition at line 368 of file include/CCAENV830Module.h.

CCAENV830* CCAENV830Module::m_pModule [private]

The module hardware driver.

Definition at line 368 of file CCAENV830Module.h.
Referenced by Initialize(), Read(), and ~CCAENV830Module().

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

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

1.3.4

CCAENV830Module Class Reference

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation