StRTSBaseMaker Class Reference

Class StRTSBaseMaker - is an abstract StMaker to define the interface to access the DAQ data from the STAR production chain. More...

#include <StRTSBaseMaker.h>

Inheritance diagram for StRTSBaseMaker:

StMaker St_pp2pp_Maker StBTofHitMaker StEmcRawMaker StMtdHitMaker StDAQMaker StMuDstMaker StTreeMaker StMuIOMaker

List of all members.

Public Member Functions

 StRTSBaseMaker (const char *detectorName, const char *makerName="")
 StRTSBaseMaker( const char *detectorName,TVirtualPad *pad) ctor.
virtual ~StRTSBaseMaker ()
 StRTSBaseMaker class dtor.
Int_t Sector () const
Int_t Pad () const
Int_t Rdo () const
Int_t Row () const
UInt_t Detectors () const
 detectors present bit mask according to DAQ!
const TString & DetectorName () const
virtual Int_t Make ()=0
virtual const char * GetCVS () const

Static Public Member Functions

static UInt_t Token ()
 current token
static UInt_t Trgcmd ()
 current trigger command
static UInt_t Daqcmd ()
 current DAQ command
static UInt_t Trgword ()
 the Trigger Word
static UInt_t Phyword ()
 the Physics Word
static UInt_t Daqbits ()
 "offline" bits aka L3 summary...
static UInt_t Daqbits_l1 ()
 triggers satisfying l1
static UInt_t Daqbits_l2 ()
 triggers satisfying l2
static UInt_t Evpgroups ()
 evp groups aka L3 summary[2]

Protected Member Functions

StRtsTable * GetNextDaqElement (const char *elementPath)
 Query the STAR production chain for the DAQ data.
StRtsTable * DaqDta ()
 Return the current DAQ data block. This member function is provided for convenience.
StRtsTable * GetNext (const char *bank)
 This is an overloaded member function, provided for convenience.
virtual StRtsTable * GetNextRaw ()
 This is an overloaded member function, provided for convenience.
virtual StRtsTable * GetNextRaw (int sec)
 This is an overloaded member function, provided for convenience.
virtual StRtsTable * GetNextAdc ()
 This is an overloaded member function, provided for convenience.
virtual StRtsTable * GetNextAdc (int sec)
 This is an overloaded member function, provided for convenience.
virtual StRtsTable * GetNextLegacy ()
 This is an overloaded member function, provided for convenience.
virtual StRtsTable * GetNextLegacy (int sec)
 This is an overloaded member function, provided for convenience.

Detailed Description

Class StRTSBaseMaker - is an abstract StMaker to define the interface to access the DAQ data from the STAR production chain.

Author:
Valery Fine(fine@bnl.gov)
Date:
27/04/2008
See also:
StRtsReaderMaker.h
Class provides the interface and the default implementation to access the DAQ data defined by "A DAQ_READER Cookbook". The user has to subclass it to re-implement the pure virtual function StRTSBaseMaker::Make() StRTSBaseMaker is a base class to implement the concrete StMaker::Make() method accessing and parsing the concrete detector subsystem DAQ information and make it available and suitable for the offline production.
See also:
"Virtual function"

"A DAQ_READER Cookbook"

Definition at line 35 of file StRTSBaseMaker.h.

Constructor & Destructor Documentation

StRTSBaseMaker::StRTSBaseMaker ( const char *  detectorName,
const char *  makerName = "" 
)

StRTSBaseMaker( const char *detectorName,TVirtualPad *pad) ctor.

Parameters:
detectorName - the DAQ name of the detector as defined by the column detector FROM THE "Table 1" of the "A DAQ_READER Cookbook"
makerName - The object name. It is adviced to provide each object instance with its own name

Definition at line 89 of file StRTSBaseMaker.cxx.

Member Function Documentation

StRtsTable* StRTSBaseMaker::DaqDta (  )  [inline, protected]

Return the current DAQ data block. This member function is provided for convenience.

One of the suitable method such as GetNextRaw, GetNextAdc, GetNextLegacy, GetNext, has to be called first to assign this pointer

Definition at line 50 of file StRTSBaseMaker.h.

Referenced by StMtdHitMaker::GetNextRaw(), StBTofHitMaker::GetNextRaw(), StDAQMaker::Make(), and St_pp2pp_Maker::Make().

StRtsTable * StRTSBaseMaker::GetNext ( const char *  bank  )  [protected]

This is an overloaded member function, provided for convenience.

Parameters:
bank - the name of the bank.
The format is bank[d], where
  • bank is the name of the bank as defined by the "DAQ_READER bank name" column from the "A DAQ_READER Cookbook" Table 1.
  • [d] - is an optional component which is a comma separated list of the indexis surrounding by the square brackets.
Returns:
the DAQ data for the bank "bank" if exists
See also:
"A DAQ_READER Cookbook"

Definition at line 153 of file StRTSBaseMaker.cxx.

References GetNextDaqElement().

Referenced by GetNextAdc(), GetNextLegacy(), and GetNextRaw().

StRtsTable * StRTSBaseMaker::GetNextAdc ( int  sec  )  [protected, virtual]

This is an overloaded member function, provided for convenience.

Returns:
the DAQ data for the bank "adc" from sector sec if exists
See also:
"A DAQ_READER Cookbook"

Definition at line 224 of file StRTSBaseMaker.cxx.

References GetNext().

StRtsTable * StRTSBaseMaker::GetNextAdc (  )  [protected, virtual]

This is an overloaded member function, provided for convenience.

Returns:
the DAQ data for the bank "adc" if exists
See also:
"A DAQ_READER Cookbook"

Definition at line 209 of file StRTSBaseMaker.cxx.

References GetNext().

Referenced by St_pp2pp_Maker::Make().

StRtsTable * StRTSBaseMaker::GetNextDaqElement ( const char *  elementPath  )  [protected]

Query the STAR production chain for the DAQ data.

Use the syntax defined by A DAQ_READER Cookbook" to query the DAQ data for the current event. It generates the text query using the format RTS/detector/bank[d]
where

  • "RTS" is a text constant
  • detector is the name of the detector defined by the class ctor
    See also:
    StRTSBaseMaker::StRTSBaseMaker
  • bank is the name of the bank as defined by the "DAQ_READER bank name" column from the "A DAQ_READER Cookbook" "Table 1"
    See also:
    A DAQ_READER Cookbook"
  • [d] - is an optional component which is a comma separated list of the indexis surrounding by the square brackets.
For example the text "RTS/tpx/cld[1]" is to query the DAQ cluster data for the first sector of TPX detector
Returns:
the pointer the StRtsTable object filled with the query data
=0; no data for the "elementPath" was found
Note:
the methgod is designed to be called from the StMaker::Make implementation indirectly. Normally one does not need to invoke this method from the end-user code.

Definition at line 126 of file StRTSBaseMaker.cxx.

Referenced by GetNext().

StRtsTable * StRTSBaseMaker::GetNextLegacy ( int  sec  )  [protected, virtual]

This is an overloaded member function, provided for convenience.

Returns:
the DAQ data for the bank "legacy" from sector sec if exists
See also:
"A DAQ_READER Cookbook"

Definition at line 256 of file StRTSBaseMaker.cxx.

References GetNext().

StRtsTable * StRTSBaseMaker::GetNextLegacy (  )  [protected, virtual]

This is an overloaded member function, provided for convenience.

Returns:
the DAQ data for the bank "legacy" if exists
See also:
"A DAQ_READER Cookbook"

Definition at line 240 of file StRTSBaseMaker.cxx.

References GetNext().

Referenced by StMtdHitMaker::GetNextRaw(), StBTofHitMaker::GetNextRaw(), and StDAQMaker::Make().

StRtsTable * StRTSBaseMaker::GetNextRaw ( int  sec  )  [protected, virtual]

This is an overloaded member function, provided for convenience.

Returns:
the DAQ data for the bank "raw" from sector sec if exists
See also:
"A DAQ_READER Cookbook"

Reimplemented in StBTofHitMaker, and StMtdHitMaker.

Definition at line 193 of file StRTSBaseMaker.cxx.

References GetNext().

StRtsTable * StRTSBaseMaker::GetNextRaw (  )  [protected, virtual]

This is an overloaded member function, provided for convenience.

Returns:
the DAQ data for the bank "raw" if exists
See also:
"A DAQ_READER Cookbook"

Reimplemented in StBTofHitMaker, and StMtdHitMaker.

Definition at line 177 of file StRTSBaseMaker.cxx.

References GetNext().

virtual Int_t StRTSBaseMaker::Make (  )  [pure virtual]

One has to implement this method to access the concrete detector subsystem DAQ information via the suitable method such as GetNextRaw, GetNextAdc, GetNextLegacy, GetNext, parse it and make it available for the STAR production chain

Reimplemented from StMaker.

Implemented in St_pp2pp_Maker, StBTofHitMaker, StDAQMaker, StEmcRawMaker, StMtdHitMaker, StMuDstMaker, StMuIOMaker, and StTreeMaker.

The documentation for this class was generated from the following files:
Generated on Thu Feb 9 04:27:33 2012 for StRoot by  doxygen 1.5.9