AliRoot Core  v5-06-15 (45dab64)
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
AliMUONTriggerDDLDecoderEventHandler Class Reference

Callback event handler class for the AliMUONTriggerDDLDecoder. This class is the base class defining what methods the event handler for the high performance decoder should have. This handler actually does nothing. The user of this decoder will have to derive from this class a custom event handler that actually does something within the callback methods OnNewRegionalHeader, OnLocalStruct, OnError etc... More...

#include <AliMUONTriggerDDLDecoderEventHandler.h>

Inheritance diagram for AliMUONTriggerDDLDecoderEventHandler:

Public Types

enum  ErrorCode {
  kNoError = 0, kTooManyRegionals = 1, kNoDarcHeader = 2, kNoDarcScalars = 3,
  kWrongEventType = 4, kNoEndOfDarc = 5, kBadEndOfDarc = 6, kNoGlobalHeader = 7,
  kNoGlobalScalars = 8, kNoEndOfGlobal = 9, kBadEndOfGlobal = 10, kNoRegionalHeader = 11,
  kNoRegionalScalars = 12, kNoEndOfRegional = 13, kBadEndOfRegional = 14, kNoLocalStruct = 15,
  kNoLocalScalars = 16, kNoEndOfLocal = 17, kBadEndOfLocal = 18, kBufferTooBig = 19
}
 All the possible error codes from the parsing. More...
 

Public Member Functions

virtual ~AliMUONTriggerDDLDecoderEventHandler ()
 
void OnNewBuffer (const void *, UInt_t)
 
void OnEndOfBuffer (const void *, UInt_t)
 
void OnDarcHeader (UInt_t, const AliMUONDarcScalarsStruct *, const void *)
 
void OnGlobalHeader (const AliMUONGlobalHeaderStruct *, const AliMUONGlobalScalarsStruct *, const void *)
 
void OnNewRegionalStruct (const AliMUONRegionalHeaderStruct *, const AliMUONRegionalScalarsStruct *, const void *)
 
void OnNewRegionalStructV2 (UInt_t, const AliMUONRegionalHeaderStruct *, const AliMUONRegionalScalarsStruct *, const void *)
 
void OnEndOfRegionalStruct (const AliMUONRegionalHeaderStruct *, const AliMUONRegionalScalarsStruct *, const void *)
 
void OnEndOfRegionalStructV2 (UInt_t, const AliMUONRegionalHeaderStruct *, const AliMUONRegionalScalarsStruct *, const void *)
 
void OnLocalStruct (const AliMUONLocalInfoStruct *, const AliMUONLocalScalarsStruct *)
 
void OnLocalStructV2 (UInt_t, const AliMUONLocalInfoStruct *, const AliMUONLocalScalarsStruct *)
 
void OnError (ErrorCode, const void *)
 

Static Public Member Functions

static UChar_t GetDarcEventType (UInt_t header)
 
static UChar_t GetDarcType (UInt_t header)
 
static UChar_t GetDarcSerialNb (UInt_t header)
 
static UChar_t GetDarcVersion (UInt_t header)
 
static bool GetDarcVMETrig (UInt_t header)
 
static bool GetDarcGlobalFlag (UInt_t header)
 
static bool GetDarcCTPTrig (UInt_t header)
 
static bool GetDarcDAQFlag (UInt_t header)
 
static UChar_t GetDarcRegPattern (UInt_t header)
 
static UShort_t GetRegionalL0 (const AliMUONRegionalHeaderStruct *header)
 Return L0. More...
 
static UShort_t GetRegionalMask (const AliMUONRegionalHeaderStruct *header)
 Return mask. More...
 
static bool GetRegionalPhysFlag (const AliMUONRegionalHeaderStruct *header)
 Return RegPhysFlag. More...
 
static UChar_t GetRegionalResetNb (const AliMUONRegionalHeaderStruct *header)
 Return ResetNb. More...
 
static UChar_t GetRegionalSerialNb (const AliMUONRegionalHeaderStruct *header)
 Return SerialNb. More...
 
static UChar_t GetRegionalId (const AliMUONRegionalHeaderStruct *header)
 Return Id. More...
 
static UChar_t GetRegionalVersion (const AliMUONRegionalHeaderStruct *header)
 Return Version. More...
 
static UChar_t GetRegionalOutput (const AliMUONRegionalHeaderStruct *header)
 Return Output. More...
 
static UShort_t GetRegionalErrorBits (const AliMUONRegionalHeaderStruct *header)
 Return ErrorBits. More...
 
static UChar_t GetRegionalFPGANumber (const AliMUONRegionalHeaderStruct *header)
 Return FPGANumber. More...
 
static bool GetRegionalDarcPhysFlag (const AliMUONRegionalHeaderStruct *header)
 Return DarcPhysFlag. More...
 
static bool GetRegionalPresentFlag (const AliMUONRegionalHeaderStruct *header)
 Return PresentFlag. More...
 
static bool GetRegionalRamNotFullFlag (const AliMUONRegionalHeaderStruct *header)
 Return RamNotFullFlag. More...
 
static bool GetRegionalRamNotEmptyFlag (const AliMUONRegionalHeaderStruct *header)
 Return RamNotEmptyFlag. More...
 
static bool GetRegionalL2RejStatus (const AliMUONRegionalHeaderStruct *header)
 Return L2RejStatus. More...
 
static bool GetRegionalL2AccStatus (const AliMUONRegionalHeaderStruct *header)
 Return L2AccStatus. More...
 
static bool GetRegionalL1Status (const AliMUONRegionalHeaderStruct *header)
 Return L1Status. More...
 
static bool GetRegionalL0Status (const AliMUONRegionalHeaderStruct *header)
 Return L0Status. More...
 
static UChar_t GetRegionalEventInRam (const AliMUONRegionalHeaderStruct *header)
 Return EventInRam. More...
 
static UChar_t GetRegionalBusy (const AliMUONRegionalHeaderStruct *header)
 Return Busy. More...
 
static UChar_t GetGlobalOutput (const AliMUONGlobalHeaderStruct *header)
 
static UShort_t GetGlobalConfig (const AliMUONGlobalHeaderStruct *header)
 
static UShort_t GetLocalX2 (const AliMUONLocalInfoStruct *local)
 Return X2. More...
 
static UShort_t GetLocalX1 (const AliMUONLocalInfoStruct *local)
 Return X1. More...
 
static UShort_t GetLocalX4 (const AliMUONLocalInfoStruct *local)
 Return X4. More...
 
static UShort_t GetLocalX3 (const AliMUONLocalInfoStruct *local)
 Return X3. More...
 
static UShort_t GetLocalY2 (const AliMUONLocalInfoStruct *local)
 Return Y2. More...
 
static UShort_t GetLocalY1 (const AliMUONLocalInfoStruct *local)
 Return Y1. More...
 
static UShort_t GetLocalY4 (const AliMUONLocalInfoStruct *local)
 Return Y4. More...
 
static UShort_t GetLocalY3 (const AliMUONLocalInfoStruct *local)
 Return Y3. More...
 
static UChar_t GetLocalId (const AliMUONLocalInfoStruct *local)
 Return Id. More...
 
static UChar_t GetLocalDec (const AliMUONLocalInfoStruct *local)
 Return Dec. More...
 
static bool GetLocalTrigY (const AliMUONLocalInfoStruct *local)
 Return TrigY. More...
 
static bool GetLocalTriggerY (const AliMUONLocalInfoStruct *local)
 Return TriggerY. More...
 
static UChar_t GetLocalYPos (const AliMUONLocalInfoStruct *local)
 Return Upos. More...
 
static bool GetLocalSXDev (const AliMUONLocalInfoStruct *local)
 Get Sign of X deviation. More...
 
static UChar_t GetLocalXDev (const AliMUONLocalInfoStruct *local)
 Get X deviation. More...
 
static bool GetLocalTriggerX (const AliMUONLocalInfoStruct *local)
 Return TriggerX. More...
 
static UChar_t GetLocalXPos (const AliMUONLocalInfoStruct *local)
 Return Xpos. More...
 
static UChar_t GetLocalLpt (const AliMUONLocalInfoStruct *local)
 Return LPT. More...
 
static UChar_t GetLocalHpt (const AliMUONLocalInfoStruct *local)
 Return HPT. More...
 
static UShort_t GetLocalSwitch (const AliMUONLocalScalarsStruct *scalars)
 Return switch. More...
 
static UChar_t GetLocalComptXY (const AliMUONLocalScalarsStruct *scalars)
 Return ComptXY. More...
 
static UShort_t GetLocalXY1 (const AliMUONLocalScalarsStruct *scalars, UInt_t n)
 Return XY1. More...
 
static UShort_t GetLocalXY2 (const AliMUONLocalScalarsStruct *scalars, UInt_t n)
 Return XY2. More...
 
static UShort_t GetLocalXY3 (const AliMUONLocalScalarsStruct *scalars, UInt_t n)
 Return XY3. More...
 
static UShort_t GetLocalXY4 (const AliMUONLocalScalarsStruct *scalars, UInt_t n)
 Return XY4. More...
 
static const char * ErrorCodeToString (ErrorCode code)
 
static const char * ErrorCodeToMessage (ErrorCode code)
 

Detailed Description

Callback event handler class for the AliMUONTriggerDDLDecoder. This class is the base class defining what methods the event handler for the high performance decoder should have. This handler actually does nothing. The user of this decoder will have to derive from this class a custom event handler that actually does something within the callback methods OnNewRegionalHeader, OnLocalStruct, OnError etc...

Definition at line 139 of file AliMUONTriggerDDLDecoderEventHandler.h.

Member Enumeration Documentation

All the possible error codes from the parsing.

Enumerator
kNoError 
kTooManyRegionals 

Decoding was successful.

kNoDarcHeader 

Too many regional card structures are expected in the DDL payload.

kNoDarcScalars 

The DARC header is missing. The DDL buffer is too short to hold a DARC header.

kWrongEventType 

The DARC scalars are missing or corrupt. The DDL buffer is too short to contain them.

kNoEndOfDarc 

Wrong event type obtained from the Darc header.

kBadEndOfDarc 

The DDL buffer is too short to contain an end of DARC header key word.

kNoGlobalHeader 

End of DARC header key word is incorrect or corrupt.

kNoGlobalScalars 

The global header is missing. The DDL buffer is too short to hold a global header.

kNoEndOfGlobal 

The global scalars are missing or corrupt. The DDL buffer is too short to contain them.

kBadEndOfGlobal 

The DDL buffer is too short to contain an end of global header key word.

kNoRegionalHeader 

End of global header key word is incorrect or corrupt.

kNoRegionalScalars 

The regional header is missing. The DDL buffer is too short to hold another regional header.

kNoEndOfRegional 

The regional scalars are missing or corrupt. The DDL buffer is too short to contain them.

kBadEndOfRegional 

The DDL buffer is too short to contain an end of regional header key word.

kNoLocalStruct 

End of regional header key word is incorrect or corrupt.

kNoLocalScalars 

The local structure is missing. The DDL buffer is too short to hold another local structure.

kNoEndOfLocal 

The local scalars are missing or corrupt. The DDL buffer is too short to contain them.

kBadEndOfLocal 

The DDL buffer is too short to contain an end of local structure key word.

kBufferTooBig 

End of local structure key word is incorrect or corrupt.

Definition at line 149 of file AliMUONTriggerDDLDecoderEventHandler.h.

Constructor & Destructor Documentation

virtual AliMUONTriggerDDLDecoderEventHandler::~AliMUONTriggerDDLDecoderEventHandler ( )
inlinevirtual

The only reason for a virtual destructor is to make -Weffc++ shutup. This should not really be here since we do not actually want or need run-time polymorphism.

Definition at line 146 of file AliMUONTriggerDDLDecoderEventHandler.h.

Member Function Documentation

const char * AliMUONTriggerDDLDecoderEventHandler::ErrorCodeToMessage ( ErrorCode  code)
inlinestatic

This is a utility method which converts an error code to user friendly descriptive message useful for printing to the screen.

Parameters
codeThe error code as received in OnError for example.
Returns
An ANSI string containing a descriptive message of the error.

This is a utility method which converts an error code to user friendly descriptive message useful for printing to the screen.

Parameters
codeThe error code as received in OnError for example.
Returns
An ANSI string containing a descriptive message of the error.

Definition at line 785 of file AliMUONTriggerDDLDecoderEventHandler.h.

Referenced by operator<<().

const char * AliMUONTriggerDDLDecoderEventHandler::ErrorCodeToString ( ErrorCode  code)
inlinestatic

This is a utility method which converts an error code to a string representation for printing purposes.

Parameters
codeThe error code as received in OnError for example.
Returns
An ANSI string containing the name of the error code symbol.

This is a utility method which converts an error code to a string representation for printing purposes.

Parameters
codeThe error code as received in OnError for example.
Returns
An ANSI string containing the name of the error code symbol.

Definition at line 751 of file AliMUONTriggerDDLDecoderEventHandler.h.

static bool AliMUONTriggerDDLDecoderEventHandler::GetDarcCTPTrig ( UInt_t  header)
inlinestatic

Return CPT trigger

Parameters
headerShould be the header as given by the OnDarkHeader() method.

Definition at line 376 of file AliMUONTriggerDDLDecoderEventHandler.h.

Referenced by AliMUONRawStreamTriggerHP::AliHeader::GetCTPTrig().

static bool AliMUONTriggerDDLDecoderEventHandler::GetDarcDAQFlag ( UInt_t  header)
inlinestatic

Return DAQ flag

Parameters
headerShould be the header as given by the OnDarkHeader() method.

Definition at line 380 of file AliMUONTriggerDDLDecoderEventHandler.h.

Referenced by AliMUONRawStreamTriggerHP::AliHeader::GetDAQFlag().

static UChar_t AliMUONTriggerDDLDecoderEventHandler::GetDarcEventType ( UInt_t  header)
inlinestatic

Return event type

Parameters
headerShould be the header as given by the OnDarkHeader() method.

Definition at line 352 of file AliMUONTriggerDDLDecoderEventHandler.h.

Referenced by AliMUONRawStreamTriggerHP::AliHeader::GetEventType().

static bool AliMUONTriggerDDLDecoderEventHandler::GetDarcGlobalFlag ( UInt_t  header)
inlinestatic

Return global flag

Parameters
headerShould be the header as given by the OnDarkHeader() method.

Definition at line 372 of file AliMUONTriggerDDLDecoderEventHandler.h.

Referenced by AliMUONRawStreamTriggerHP::AliHeader::GetGlobalFlag().

static UChar_t AliMUONTriggerDDLDecoderEventHandler::GetDarcRegPattern ( UInt_t  header)
inlinestatic

Return reg pattern

Parameters
headerShould be the header as given by the OnDarkHeader() method.

Definition at line 384 of file AliMUONTriggerDDLDecoderEventHandler.h.

Referenced by AliMUONRawStreamTriggerHP::AliHeader::GetRegPattern().

static UChar_t AliMUONTriggerDDLDecoderEventHandler::GetDarcSerialNb ( UInt_t  header)
inlinestatic

Return serial number

Parameters
headerShould be the header as given by the OnDarkHeader() method.

Definition at line 360 of file AliMUONTriggerDDLDecoderEventHandler.h.

Referenced by AliMUONRawStreamTriggerHP::AliHeader::GetSerialNb().

static UChar_t AliMUONTriggerDDLDecoderEventHandler::GetDarcType ( UInt_t  header)
inlinestatic

Return Darc type

Parameters
headerShould be the header as given by the OnDarkHeader() method.

Definition at line 356 of file AliMUONTriggerDDLDecoderEventHandler.h.

Referenced by AliMUONRawStreamTriggerHP::AliHeader::GetDarcType().

static UChar_t AliMUONTriggerDDLDecoderEventHandler::GetDarcVersion ( UInt_t  header)
inlinestatic

Return version

Parameters
headerShould be the header as given by the OnDarkHeader() method.

Definition at line 364 of file AliMUONTriggerDDLDecoderEventHandler.h.

Referenced by AliMUONRawStreamTriggerHP::AliHeader::GetVersion().

static bool AliMUONTriggerDDLDecoderEventHandler::GetDarcVMETrig ( UInt_t  header)
inlinestatic

Return VME trig

Parameters
headerShould be the header as given by the OnDarkHeader() method.

Definition at line 368 of file AliMUONTriggerDDLDecoderEventHandler.h.

Referenced by AliMUONRawStreamTriggerHP::AliHeader::GetVMETrig().

static UShort_t AliMUONTriggerDDLDecoderEventHandler::GetGlobalConfig ( const AliMUONGlobalHeaderStruct header)
inlinestatic

Return global config

Parameters
headerShould be the header as given by the OnGlobalHeader() method.

Definition at line 542 of file AliMUONTriggerDDLDecoderEventHandler.h.

Referenced by AliMUONRawStreamTriggerHP::AliHeader::GetGlobalConfig().

static UChar_t AliMUONTriggerDDLDecoderEventHandler::GetGlobalOutput ( const AliMUONGlobalHeaderStruct header)
inlinestatic

Return global output

Parameters
headerShould be the header as given by the OnGlobalHeader() method.

Definition at line 534 of file AliMUONTriggerDDLDecoderEventHandler.h.

Referenced by AliMUONRawStreamTriggerHP::AliHeader::GetGlobalOutput().

static UChar_t AliMUONTriggerDDLDecoderEventHandler::GetLocalComptXY ( const AliMUONLocalScalarsStruct scalars)
inlinestatic
static UChar_t AliMUONTriggerDDLDecoderEventHandler::GetLocalDec ( const AliMUONLocalInfoStruct local)
inlinestatic
static UChar_t AliMUONTriggerDDLDecoderEventHandler::GetLocalHpt ( const AliMUONLocalInfoStruct local)
inlinestatic
static UChar_t AliMUONTriggerDDLDecoderEventHandler::GetLocalId ( const AliMUONLocalInfoStruct local)
inlinestatic
static UChar_t AliMUONTriggerDDLDecoderEventHandler::GetLocalLpt ( const AliMUONLocalInfoStruct local)
inlinestatic
static UShort_t AliMUONTriggerDDLDecoderEventHandler::GetLocalSwitch ( const AliMUONLocalScalarsStruct scalars)
inlinestatic
static bool AliMUONTriggerDDLDecoderEventHandler::GetLocalSXDev ( const AliMUONLocalInfoStruct local)
inlinestatic

Get Sign of X deviation.

Definition at line 642 of file AliMUONTriggerDDLDecoderEventHandler.h.

Referenced by GetLocalTriggerX(), and AliMUONRawStreamTriggerHP::AliLocalStruct::GetSXDev().

static bool AliMUONTriggerDDLDecoderEventHandler::GetLocalTriggerX ( const AliMUONLocalInfoStruct local)
inlinestatic
static bool AliMUONTriggerDDLDecoderEventHandler::GetLocalTriggerY ( const AliMUONLocalInfoStruct local)
inlinestatic
static bool AliMUONTriggerDDLDecoderEventHandler::GetLocalTrigY ( const AliMUONLocalInfoStruct local)
inlinestatic
static UShort_t AliMUONTriggerDDLDecoderEventHandler::GetLocalX1 ( const AliMUONLocalInfoStruct local)
inlinestatic
static UShort_t AliMUONTriggerDDLDecoderEventHandler::GetLocalX2 ( const AliMUONLocalInfoStruct local)
inlinestatic
static UShort_t AliMUONTriggerDDLDecoderEventHandler::GetLocalX3 ( const AliMUONLocalInfoStruct local)
inlinestatic
static UShort_t AliMUONTriggerDDLDecoderEventHandler::GetLocalX4 ( const AliMUONLocalInfoStruct local)
inlinestatic
static UChar_t AliMUONTriggerDDLDecoderEventHandler::GetLocalXDev ( const AliMUONLocalInfoStruct local)
inlinestatic
static UChar_t AliMUONTriggerDDLDecoderEventHandler::GetLocalXPos ( const AliMUONLocalInfoStruct local)
inlinestatic
static UShort_t AliMUONTriggerDDLDecoderEventHandler::GetLocalXY1 ( const AliMUONLocalScalarsStruct scalars,
UInt_t  n 
)
inlinestatic
static UShort_t AliMUONTriggerDDLDecoderEventHandler::GetLocalXY2 ( const AliMUONLocalScalarsStruct scalars,
UInt_t  n 
)
inlinestatic
static UShort_t AliMUONTriggerDDLDecoderEventHandler::GetLocalXY3 ( const AliMUONLocalScalarsStruct scalars,
UInt_t  n 
)
inlinestatic
static UShort_t AliMUONTriggerDDLDecoderEventHandler::GetLocalXY4 ( const AliMUONLocalScalarsStruct scalars,
UInt_t  n 
)
inlinestatic
static UShort_t AliMUONTriggerDDLDecoderEventHandler::GetLocalY1 ( const AliMUONLocalInfoStruct local)
inlinestatic
static UShort_t AliMUONTriggerDDLDecoderEventHandler::GetLocalY2 ( const AliMUONLocalInfoStruct local)
inlinestatic
static UShort_t AliMUONTriggerDDLDecoderEventHandler::GetLocalY3 ( const AliMUONLocalInfoStruct local)
inlinestatic
static UShort_t AliMUONTriggerDDLDecoderEventHandler::GetLocalY4 ( const AliMUONLocalInfoStruct local)
inlinestatic
static UChar_t AliMUONTriggerDDLDecoderEventHandler::GetLocalYPos ( const AliMUONLocalInfoStruct local)
inlinestatic
static UChar_t AliMUONTriggerDDLDecoderEventHandler::GetRegionalBusy ( const AliMUONRegionalHeaderStruct header)
inlinestatic
static bool AliMUONTriggerDDLDecoderEventHandler::GetRegionalDarcPhysFlag ( const AliMUONRegionalHeaderStruct header)
inlinestatic
static UShort_t AliMUONTriggerDDLDecoderEventHandler::GetRegionalErrorBits ( const AliMUONRegionalHeaderStruct header)
inlinestatic
static UChar_t AliMUONTriggerDDLDecoderEventHandler::GetRegionalEventInRam ( const AliMUONRegionalHeaderStruct header)
inlinestatic
static UChar_t AliMUONTriggerDDLDecoderEventHandler::GetRegionalFPGANumber ( const AliMUONRegionalHeaderStruct header)
inlinestatic
static UChar_t AliMUONTriggerDDLDecoderEventHandler::GetRegionalId ( const AliMUONRegionalHeaderStruct header)
inlinestatic
static UShort_t AliMUONTriggerDDLDecoderEventHandler::GetRegionalL0 ( const AliMUONRegionalHeaderStruct header)
inlinestatic
static bool AliMUONTriggerDDLDecoderEventHandler::GetRegionalL0Status ( const AliMUONRegionalHeaderStruct header)
inlinestatic
static bool AliMUONTriggerDDLDecoderEventHandler::GetRegionalL1Status ( const AliMUONRegionalHeaderStruct header)
inlinestatic
static bool AliMUONTriggerDDLDecoderEventHandler::GetRegionalL2AccStatus ( const AliMUONRegionalHeaderStruct header)
inlinestatic
static bool AliMUONTriggerDDLDecoderEventHandler::GetRegionalL2RejStatus ( const AliMUONRegionalHeaderStruct header)
inlinestatic
static UShort_t AliMUONTriggerDDLDecoderEventHandler::GetRegionalMask ( const AliMUONRegionalHeaderStruct header)
inlinestatic
static UChar_t AliMUONTriggerDDLDecoderEventHandler::GetRegionalOutput ( const AliMUONRegionalHeaderStruct header)
inlinestatic
static bool AliMUONTriggerDDLDecoderEventHandler::GetRegionalPhysFlag ( const AliMUONRegionalHeaderStruct header)
inlinestatic
static bool AliMUONTriggerDDLDecoderEventHandler::GetRegionalPresentFlag ( const AliMUONRegionalHeaderStruct header)
inlinestatic
static bool AliMUONTriggerDDLDecoderEventHandler::GetRegionalRamNotEmptyFlag ( const AliMUONRegionalHeaderStruct header)
inlinestatic
static bool AliMUONTriggerDDLDecoderEventHandler::GetRegionalRamNotFullFlag ( const AliMUONRegionalHeaderStruct header)
inlinestatic
static UChar_t AliMUONTriggerDDLDecoderEventHandler::GetRegionalResetNb ( const AliMUONRegionalHeaderStruct header)
inlinestatic
static UChar_t AliMUONTriggerDDLDecoderEventHandler::GetRegionalSerialNb ( const AliMUONRegionalHeaderStruct header)
inlinestatic
static UChar_t AliMUONTriggerDDLDecoderEventHandler::GetRegionalVersion ( const AliMUONRegionalHeaderStruct header)
inlinestatic
void AliMUONTriggerDDLDecoderEventHandler::OnDarcHeader ( UInt_t  ,
const AliMUONDarcScalarsStruct ,
const void *   
)
inline

The OnDarcHeader method will be called when the DARC header has been found in the DDL payload. The default behaviour of this method is to do nothing.

  • param UInt_t The DARC header word as found in the payload.
  • param const AliMUONDarcScalarsStruct* The DARC scalars found in the raw data. If there are no scalars in the data then this pointer is set to NULL.
  • param const void* A pointer to the remainder of the raw data after the DARC header and scalars.

Definition at line 203 of file AliMUONTriggerDDLDecoderEventHandler.h.

void AliMUONTriggerDDLDecoderEventHandler::OnEndOfBuffer ( const void *  ,
UInt_t   
)
inline

The OnEndOfBuffer method will be called whenever the buffer containing a DDL payload has been processed. For each OnNewBuffer method call a symmetric call to OnEndOfBuffer is made at the end of processing (after the last call to OnLocalStruct) The default behaviour of this method is to do nothing.

  • param const void* The pointer to the start of the memory buffer storing the DDL payload.
  • param UInt_t The size in bytes of the memory buffer.

Definition at line 192 of file AliMUONTriggerDDLDecoderEventHandler.h.

void AliMUONTriggerDDLDecoderEventHandler::OnEndOfRegionalStruct ( const AliMUONRegionalHeaderStruct ,
const AliMUONRegionalScalarsStruct ,
const void *   
)
inline

The OnEndOfRegionalStruct method will be called whenever a regional structure has been processed. For each OnNewRegionalStruct method call a symmetric call to OnEndOfRegionalStruct is made after processing of the regional structure is done (after the last call to OnLocalStruct for that regional structure).

  • param const AliMUONRegionalHeaderStruct* A pointer to the regional structure header.
  • param const AliMUONRegionalScalarsStruct* The regional scalars found in the raw data. If there are no scalars in the data then this pointer is set to NULL.
  • param const void* A pointer to the start of the local trigger structures data for this regional block.

Definition at line 279 of file AliMUONTriggerDDLDecoderEventHandler.h.

void AliMUONTriggerDDLDecoderEventHandler::OnEndOfRegionalStructV2 ( UInt_t  ,
const AliMUONRegionalHeaderStruct ,
const AliMUONRegionalScalarsStruct ,
const void *   
)
inline

The OnEndOfRegionalStructV2 method will be called whenever a regional structure has been processed. For each OnNewRegionalStruct method call a symmetric call to OnEndOfRegionalStruct is made after processing of the regional structure is done (after the last call to OnLocalStruct for that regional structure). This method is an alternate version to OnEndOfRegionalStruct and an inheriting class needs only implement one or the other version.

  • param UInt_t The structure index number of the regional structure.
  • param const AliMUONRegionalHeaderStruct* A pointer to the regional structure header.
  • param const AliMUONRegionalScalarsStruct* The regional scalars found in the raw data. If there are no scalars in the data then this pointer is set to NULL.
  • param const void* A pointer to the start of the local trigger structures data for this regional block.

Definition at line 302 of file AliMUONTriggerDDLDecoderEventHandler.h.

void AliMUONTriggerDDLDecoderEventHandler::OnError ( ErrorCode  ,
const void *   
)
inline

Whenever a parsing error of the DDL payload is encountered because of corruption of the raw data the OnError method is called immediately at the point this error is discovered. The default behaviour of this method is to do nothing. -param error This is an error code indicating the kind of problem encountered with the DDL payload. -param location This is a pointer into the DDL payload memory buffer indicating the exact location where the parsing error happened or i.e. the location of the corruption. Note that a relative offset in bytes from the start of the memory buffer can be calculated by: storing the buffer pointer recevied in OnNewBuffer earlier in fBufferStart for example, and then the offset is given by: offset = (unsigned long)location - (unsigned long)fBufferStart;

Definition at line 734 of file AliMUONTriggerDDLDecoderEventHandler.h.

void AliMUONTriggerDDLDecoderEventHandler::OnGlobalHeader ( const AliMUONGlobalHeaderStruct ,
const AliMUONGlobalScalarsStruct ,
const void *   
)
inline

The OnGlobalHeader method will be called when the global header has been found in the DDL payload. The default behaviour of this method is to do nothing.

  • param const AliMUONGlobalHeaderStruct* A pointer to the global header.
  • param const AliMUONDarcScalarsStruct* The global scalars found in the raw data. If there are no scalars in the data then this pointer is set to NULL.
  • param const void* A pointer to the start of the regional data blocks.

Definition at line 219 of file AliMUONTriggerDDLDecoderEventHandler.h.

void AliMUONTriggerDDLDecoderEventHandler::OnLocalStruct ( const AliMUONLocalInfoStruct ,
const AliMUONLocalScalarsStruct  
)
inline

The OnLocalStruct method will be called for each local trigger structure found in the DDL payload. The user must overload this method to process the local structures as needed. The default behaviour of this method is to do nothing.

  • param const AliMUONRegionalHeaderStruct* A pointer to the local trigger structure found.
  • param const AliMUONRegionalScalarsStruct* The local scalars found in the raw data. If there are no scalars in the data then this pointer is set to NULL.

Definition at line 320 of file AliMUONTriggerDDLDecoderEventHandler.h.

void AliMUONTriggerDDLDecoderEventHandler::OnLocalStructV2 ( UInt_t  ,
const AliMUONLocalInfoStruct ,
const AliMUONLocalScalarsStruct  
)
inline

The OnLocalStructV2 method will be called for each local trigger structure found in the DDL payload. The user must overload this method to process the local structures as needed. The default behaviour of this method is to do nothing. This method is an alternate version to OnLocalStruct and an inheriting class needs only implement one or the other version.

  • param UInt_t The structure index number of the local structure.
  • param const AliMUONRegionalHeaderStruct* A pointer to the local trigger structure found.
  • param const AliMUONRegionalScalarsStruct* The local scalars found in the raw data. If there are no scalars in the data then this pointer is set to NULL.

Definition at line 339 of file AliMUONTriggerDDLDecoderEventHandler.h.

void AliMUONTriggerDDLDecoderEventHandler::OnNewBuffer ( const void *  ,
UInt_t   
)
inline

The OnNewBuffer method will be called whenever a new buffer containing a DDL payload is about to be processed. The default behaviour of this method is to do nothing.

  • param const void* The pointer to the start of the memory buffer storing the DDL payload.
  • param UInt_t The size in bytes of the memory buffer.

Definition at line 182 of file AliMUONTriggerDDLDecoderEventHandler.h.

void AliMUONTriggerDDLDecoderEventHandler::OnNewRegionalStruct ( const AliMUONRegionalHeaderStruct ,
const AliMUONRegionalScalarsStruct ,
const void *   
)
inline

The OnNewRegionalStruct method will be called for each regional header found in the DDL payload. The default behaviour of this method is to do nothing.

  • param const AliMUONRegionalHeaderStruct* A pointer to the regional structure header.
  • param const AliMUONRegionalScalarsStruct* The regional scalars found in the raw data. If there are no scalars in the data then this pointer is set to NULL.
  • param const void* A pointer to the start of the local trigger structures data for this regional block.

Definition at line 237 of file AliMUONTriggerDDLDecoderEventHandler.h.

void AliMUONTriggerDDLDecoderEventHandler::OnNewRegionalStructV2 ( UInt_t  ,
const AliMUONRegionalHeaderStruct ,
const AliMUONRegionalScalarsStruct ,
const void *   
)
inline

The OnNewRegionalStructV2 method will be called for each regional header found in the DDL payload. The default behaviour of this method is to do nothing. This method is an alternate version to OnNewRegionalStruct and an inheriting class needs only implement one or the other version.

  • param UInt_t The structure index number of the regional structure.
  • param const AliMUONRegionalHeaderStruct* A pointer to the regional structure header.
  • param const AliMUONRegionalScalarsStruct* The regional scalars found in the raw data. If there are no scalars in the data then this pointer is set to NULL.
  • param const void* A pointer to the start of the local trigger structures data for this regional block.

Definition at line 258 of file AliMUONTriggerDDLDecoderEventHandler.h.


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