CODA version 2 event decoder implementation. More...

#include <Coda2EventDecoder.h>

Inheritance diagram for Coda2EventDecoder:

Collaboration diagram for Coda2EventDecoder:

Public Member Functions
	Coda2EventDecoder ()

	~Coda2EventDecoder () override

std::vector< UInt_t >	EncodePHYSEventHeader (std::vector< ROCID_t > &ROCList) override

void	EncodePrestartEventHeader (int *buffer, int runnumber, int runtype, int localtime) override

void	EncodeGoEventHeader (int *buffer, int eventcount, int localtime) override

void	EncodePauseEventHeader (int *buffer, int eventcount, int localtime) override

void	EncodeEndEventHeader (int *buffer, int eventcount, int localtime) override

Int_t	DecodeEventIDBank (UInt_t *buffer) override

void	PrintDecoderInfo (QwLog &out) override

Public Member Functions inherited from VEventDecoder
	VEventDecoder ()

virtual	~VEventDecoder ()

virtual Bool_t	DecodeSubbankHeader (UInt_t *buffer)
	Decode the subbank header for the current event/bank context.

virtual Bool_t	IsPhysicsEvent ()

virtual Bool_t	IsROCConfigurationEvent ()

virtual Bool_t	IsEPICSEvent ()

UInt_t	GetWordsSoFar () const

UInt_t	GetEvtNumber () const

UInt_t	GetEvtLength () const

UInt_t	GetFragLength () const

UInt_t	GetEvtType () const

UInt_t	GetBankDataType () const

UInt_t	GetSubbankTag () const

UInt_t	GetSubbankType () const

ROCID_t	GetROC () const

void	SetWordsSoFar (UInt_t val)

void	AddWordsSoFarAndFragLength ()

void	SetFragLength (UInt_t val)

void	SetAllowLowSubbankIDs (Bool_t val=kFALSE)

Public Member Functions inherited from MQwCodaControlEvent
	MQwCodaControlEvent ()

	~MQwCodaControlEvent ()

void	ResetControlParameters ()

void	ProcessControlEvent (UInt_t evtype, UInt_t *buffer)

void	ReportRunSummary ()

UInt_t	GetStartTime ()

UInt_t	GetPrestartTime ()

UInt_t	GetPrestartRunNumber ()

UInt_t	GetRunType ()

UInt_t	GetGoTime (int index=0)

UInt_t	GetGoEventCount (int index=0)

UInt_t	GetPauseTime (int index=0)

UInt_t	GetPauseEventCount (int index=0)

UInt_t	GetEndTime ()

UInt_t	GetEndEventCount ()

TString	GetStartSQLTime ()

TString	GetEndSQLTime ()

time_t	GetStartUnixTime ()

time_t	GetEndUnixTime ()

Private Attributes
UInt_t	fEvtClass

UInt_t	fStatSum

UInt_t	fIDBankNum

Additional Inherited Members
Protected Types inherited from VEventDecoder
enum	KEYWORDS { EPICS_EVTYPE = 131 }

Protected Types inherited from MQwCodaControlEvent
enum	EventTypes { kSYNC_EVENT = 16 , kPRESTART_EVENT = 17 , kGO_EVENT = 18 , kPAUSE_EVENT = 19 , kEND_EVENT = 20 }

Protected Member Functions inherited from MQwCodaControlEvent
void	ProcessSync (UInt_t local_time, UInt_t statuscode)

void	ProcessPrestart (UInt_t local_time, UInt_t local_runnumber, UInt_t local_runtype)

void	ProcessGo (UInt_t local_time, UInt_t evt_count)

void	ProcessPause (UInt_t local_time, UInt_t evt_count)

void	ProcessEnd (UInt_t local_time, UInt_t evt_count)

Protected Attributes inherited from VEventDecoder
UInt_t	fWordsSoFar

UInt_t	fEvtLength

UInt_t	fEvtNumber
	CODA event number; only defined for physics events.

UInt_t	fFragLength

UInt_t	fEvtType

UInt_t	fEvtTag

UInt_t	fBankDataType

BankID_t	fSubbankTag

UInt_t	fSubbankType

UInt_t	fSubbankNum

ROCID_t	fROC

Bool_t	fPhysicsEventFlag

Bool_t	fControlEventFlag

Bool_t	fAllowLowSubbankIDs

Protected Attributes inherited from MQwCodaControlEvent
Bool_t	fFoundControlEvents

UInt_t	fPrestartTime

UInt_t	fPrestartRunNumber

UInt_t	fRunType

UInt_t	fEndTime

UInt_t	fEndEventCount

UInt_t	fNumberPause

std::vector< UInt_t >	fPauseEventCount

std::vector< UInt_t >	fPauseTime

UInt_t	fNumberGo

std::vector< UInt_t >	fGoEventCount

std::vector< UInt_t >	fGoTime

UInt_t	fStartTime

TDatime	fPrestartDatime

TDatime	fStartDatime

TDatime	fEndDatime

Detailed Description

CODA version 2 event decoder implementation.

Concrete decoder for CODA 2.x format event streams, handling the legacy data structures and bank formats. Maintains compatibility with older data files while providing the same encoding/decoding interface.

Definition at line 22 of file Coda2EventDecoder.h.

Constructor & Destructor Documentation

◆ Coda2EventDecoder()

Coda2EventDecoder::Coda2EventDecoder ( )

inline

Definition at line 25 of file Coda2EventDecoder.h.

                            :
            fEvtClass(0),
            fStatSum(0),
            fIDBankNum(0) { }

References fEvtClass, fIDBankNum, and fStatSum.

◆ ~Coda2EventDecoder()

Coda2EventDecoder::~Coda2EventDecoder ( )

inlineoverride

Definition at line 29 of file Coda2EventDecoder.h.

29{ }

Member Function Documentation

◆ DecodeEventIDBank()

Int_t Coda2EventDecoder::DecodeEventIDBank ( UInt_t * buffer )

overridevirtual

Determine whether a buffer contains a PHYS, control, or other event.

Parameters

buffer Event buffer to decode.

Returns: CODA_OK on success.

Implements VEventDecoder.

Definition at line 73 of file Coda2EventDecoder.cc.

{
 
    UInt_t local_datatype;
    UInt_t local_eventtype;
 
    fPhysicsEventFlag = kFALSE;
 
    QwDebug << "QwEventBuffer::DecodeEventIDBank: " <<  std::hex
            << buffer[0] << " "
            << buffer[1] << " "
            << buffer[2] << " "
            << buffer[3] << " "
            << buffer[4] << std::dec
            << QwLog::endl;
 
    if ( buffer[0] == 0 ){
        /*****************************************************************
         *  This buffer is empty.                                        *
         *****************************************************************/
        fEvtLength = (1);     //  Pretend that there is one word.
        fWordsSoFar = (1);      //  Mark that we've read the word already.
        fEvtType = (0);
        fEvtTag       = 0;
        fBankDataType = 0;
        fIDBankNum    = 0;
        fEvtNumber    = 0;
        fEvtClass     = 0;
        fStatSum      = 0;
    } else {
        /*****************************************************************
         *  This buffer contains data; fill the event ID parameters.     *
         *****************************************************************/
        //  First word is the number of long-words in the buffer.
        fEvtLength = (buffer[0]+1);
 
        // Second word contains the event type, for CODA events.
        fEvtTag   = (buffer[1] & 0xFFFF0000) >> 16;  // (bits(31-16));
        local_datatype = (buffer[1] & 0xFF00) >> 8;  // (bits(15-8));
        fIDBankNum = (buffer[1] & 0xFF);             // (bits(7-0));
        if ( fIDBankNum == 0xCC) {
            //  This is a CODA event bank; the event type is equal to
            //  the event tag.
            local_eventtype = fEvtTag;
            fEvtType = (local_eventtype);
            fBankDataType = local_datatype;
 
            // local_eventtype is unsigned int and always positive
            if (/* local_eventtype >= 0 && */ local_eventtype <= 15) {
                //  This is a physics event; record the event number, event
                //  classification, and status summary.
                fPhysicsEventFlag = kTRUE;
                fEvtNumber = buffer[4];
                fEvtClass  = buffer[5];
                fStatSum   = buffer[6];
                //  Now skip to the first ROC data bank.
                fWordsSoFar = (7);
            } else {
                //  This is not a physics event, but is still in the CODA
                //  event format.  The first two words have been examined.
                fEvtNumber = 0;
                fEvtClass  = 0;
                fStatSum   = 0;
                fWordsSoFar = (2);
                //  Run this event through the Control event processing.
                //  If it is not a control event, nothing will happen.
                ProcessControlEvent(fEvtType, &buffer[fWordsSoFar]);
            }
        } else {
            //  This is not an event in the CODA event bank format,
            //  but it still follows the CEBAF common event format.
            //  Arbitrarily set the event type to "fEvtTag".
            //  The first two words have been examined.
            fEvtType = (fEvtTag);
            fBankDataType = local_datatype;
            fEvtNumber = 0;
            fEvtClass  = 0;
            fStatSum   = 0;
            fWordsSoFar = (2);
        }
    }
    //  Initialize the fragment size to the event size, in case the
    //  event is not subbanked.
    fFragLength = fEvtLength-fWordsSoFar;
    QwDebug << Form("buffer[0-1] 0x%x 0x%x ; ",
            buffer[0], buffer[1])
        << Form("Length: %d; Tag: 0x%x; Bank data type: 0x%x; Bank ID num: 0x%x; ",
                fEvtLength, fEvtTag, fBankDataType, fIDBankNum)
        << Form("Evt type: 0x%x; Evt number %d; Evt Class 0x%.8x; ",
                fEvtType, fEvtNumber, fEvtClass)
        << Form("Status Summary: 0x%.8x; Words so far %d",
                fStatSum, fWordsSoFar)
        << QwLog::endl;
 
    return CODA_OK;
}

References QwLog::endl(), VEventDecoder::fBankDataType, fEvtClass, VEventDecoder::fEvtLength, VEventDecoder::fEvtNumber, VEventDecoder::fEvtTag, VEventDecoder::fEvtType, VEventDecoder::fFragLength, fIDBankNum, VEventDecoder::fPhysicsEventFlag, fStatSum, VEventDecoder::fWordsSoFar, MQwCodaControlEvent::ProcessControlEvent(), and QwDebug.

Here is the call graph for this function:

◆ EncodeEndEventHeader()

void Coda2EventDecoder::EncodeEndEventHeader	(	int *	buffer,
		int	eventcount,
		int	localtime )

overridevirtual

Create an END event EVIO header.

Parameters

buffer	Output buffer (>= 5 words).
eventcount	Number of events.
localtime	Event time.

Implements VEventDecoder.

Definition at line 62 of file Coda2EventDecoder.cc.

{
    buffer[0] = 4; // End event length
    buffer[1] = ((kEND_EVENT << 16) | (0x01 << 8) | 0xCC);
    buffer[2] = localtime;
    buffer[3] = 0; // unused
    buffer[4] = eventcount;
  ProcessEnd(localtime, eventcount);
}

References MQwCodaControlEvent::kEND_EVENT, and MQwCodaControlEvent::ProcessEnd().

Here is the call graph for this function:

◆ EncodeGoEventHeader()

void Coda2EventDecoder::EncodeGoEventHeader	(	int *	buffer,
		int	eventcount,
		int	localtime )

overridevirtual

Create a GO event EVIO header.

Parameters

buffer	Output buffer (>= 5 words).
eventcount	Number of events.
localtime	Event time.

Implements VEventDecoder.

Definition at line 40 of file Coda2EventDecoder.cc.

{
    buffer[0] = 4; // Go event length
    buffer[1] = ((kGO_EVENT << 16) | (0x01 << 8) | 0xCC);
    buffer[2] = localtime;
    buffer[3] = 0; // unused
    buffer[4] = eventcount;
  ProcessGo(localtime, eventcount);
}

References MQwCodaControlEvent::kGO_EVENT, and MQwCodaControlEvent::ProcessGo().

Here is the call graph for this function:

◆ EncodePauseEventHeader()

void Coda2EventDecoder::EncodePauseEventHeader	(	int *	buffer,
		int	eventcount,
		int	localtime )

overridevirtual

Create a PAUSE event EVIO header.

Parameters

buffer	Output buffer (>= 5 words).
eventcount	Number of events.
localtime	Event time.

Implements VEventDecoder.

Definition at line 51 of file Coda2EventDecoder.cc.

{
    buffer[0] = 4; // Pause event length
    buffer[1] = ((kPAUSE_EVENT << 16) | (0x01 << 8) | 0xCC);
    buffer[2] = localtime;
    buffer[3] = 0; // unused
    buffer[4] = eventcount;
  ProcessPause(localtime, eventcount);
}

References MQwCodaControlEvent::kPAUSE_EVENT, and MQwCodaControlEvent::ProcessPause().

Here is the call graph for this function:

◆ EncodePHYSEventHeader()

std::vector< UInt_t > Coda2EventDecoder::EncodePHYSEventHeader ( std::vector< ROCID_t > & ROCList )

overridevirtual

Create a PHYS event EVIO header.

Parameters

ROCList List of ROC IDs (unused in CODA2 headers).

Returns: Vector of 32-bit words containing the header.

Implements VEventDecoder.

Definition at line 14 of file Coda2EventDecoder.cc.

{
    std::vector<UInt_t> header;
    header.push_back((0x0001 << 16) | (0x10 << 8) | 0xCC);
    // event type | event data type | event ID (0xCC for CODA event)
    header.push_back(4);    // size of header field
    header.push_back((0xC000 << 16) | (0x01 << 8) | 0x00);
    // bank type | bank data type (0x01 for uint32) | bank ID (0x00 for header event)
    header.push_back(++fEvtNumber); // event number (initialized to 0, so increment before use to agree with CODA number)
    header.push_back(1);    // event class
    header.push_back(0);    // status summary
    return header;
}

References VEventDecoder::fEvtNumber.

◆ EncodePrestartEventHeader()

void Coda2EventDecoder::EncodePrestartEventHeader	(	int *	buffer,
		int	runnumber,
		int	runtype,
		int	localtime )

overridevirtual

Create a PRESTART event EVIO header.

Parameters

buffer	Output buffer (>= 5 words).
runnumber	Run number.
runtype	Run type.
localtime	Event time.

Implements VEventDecoder.

Definition at line 29 of file Coda2EventDecoder.cc.

{
    buffer[0] = 4; // Prestart event length
    buffer[1] = ((kPRESTART_EVENT << 16) | (0x01 << 8) | 0xCC);
    buffer[2] = localtime;
    buffer[3] = runnumber;
    buffer[4] = runtype;
  ProcessPrestart(localtime, runnumber, runtype);
}

References MQwCodaControlEvent::kPRESTART_EVENT, and MQwCodaControlEvent::ProcessPrestart().

Here is the call graph for this function:

◆ PrintDecoderInfo()

void Coda2EventDecoder::PrintDecoderInfo ( QwLog & out )

overridevirtual

Print internal decoder state for diagnostics.

Parameters

out	Logging stream.

Reimplemented from VEventDecoder.

Definition at line 171 of file Coda2EventDecoder.cc.

{
 
    out << Form("Length: %d; Tag: 0x%x; Bank data type: 0x%x; Bank ID num: 0x%x; ",
            fEvtLength, fEvtTag, fBankDataType, fIDBankNum)
        << Form("Evt type: 0x%x; Evt number %d; Evt Class 0x%.8x; ",
                fEvtType, fEvtNumber, fEvtClass)
        << QwLog::endl;
}

References QwLog::endl(), VEventDecoder::fBankDataType, fEvtClass, VEventDecoder::fEvtLength, VEventDecoder::fEvtNumber, VEventDecoder::fEvtTag, VEventDecoder::fEvtType, and fIDBankNum.

Here is the call graph for this function:

Field Documentation

◆ fEvtClass

UInt_t Coda2EventDecoder::fEvtClass

private

Definition at line 76 of file Coda2EventDecoder.h.

Referenced by Coda2EventDecoder(), DecodeEventIDBank(), and PrintDecoderInfo().

◆ fIDBankNum

UInt_t Coda2EventDecoder::fIDBankNum

private

Definition at line 78 of file Coda2EventDecoder.h.

Referenced by Coda2EventDecoder(), DecodeEventIDBank(), and PrintDecoderInfo().

◆ fStatSum

UInt_t Coda2EventDecoder::fStatSum

private

Definition at line 77 of file Coda2EventDecoder.h.

Referenced by Coda2EventDecoder(), and DecodeEventIDBank().

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Coda2EventDecoder()

◆ ~Coda2EventDecoder()

Member Function Documentation

◆ DecodeEventIDBank()

◆ EncodeEndEventHeader()

◆ EncodeGoEventHeader()

◆ EncodePauseEventHeader()

◆ EncodePHYSEventHeader()

◆ EncodePrestartEventHeader()

◆ PrintDecoderInfo()

Field Documentation

◆ fEvtClass

◆ fIDBankNum

◆ fStatSum