Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

PXXIEventPayload Class Reference

#include <PXXIEventPayload.h>

Inheritance diagram for PXXIEventPayload:

PXXEventPayload List of all members.

Public Member Functions

virtual ~PXXIEventPayload ()
virtual Int32b_t GetEventType () const =0
virtual Int32b_t GetEventConfigID () const =0
virtual Int32b_t GetRunNumber () const =0
virtual Int32b_t GetEventUID () const =0
virtual const PXXITriggerRequestPayloadGetTriggerRequestPayload () const =0
virtual const vector< PXXIReadoutDataPayloadPtrGetReadoutDataPayloadPtrs () const =0

Protected Member Functions

 PXXIEventPayload ()

Detailed Description

PXXIEventPayload //

This is an interface class for EventPayload. // It inherits PXXVPayload and doesn't implement Unpack() and Write(), // so you cannot instanciate the class. // All composite payloads must be an descendant of the class. // This interface provides a composite payload which contains the following // information: // 1. EventID - unique for this triggered event (from global trigger) // 2. Timewindow - for this event-data. Use functions of PXXICompositePayload. // 2.1 RunNumber - the run number which identifies the instrumentation // configuration and relative time offset needed to interpret the UTC times // 2.2 EventType - indicating a configuration type which cause this event // 2.3 EventConfigID - indicating as a primary key the unique configuration // with which this event-type was configured. // 3. PXXITriggerRequestPayload from the GlobalTrigger which caused the // creation of this event.(1st component of composite payload) // 4. vector of PXXIReadoutDataPayload's representing the data as queried // from the list of StringProcessor's and IceTopDataHandler's as specified // in the PXXITriggerRequestPayload. // (2nd and following components of composite payload) // NOTE: This interface reflects changes which are implemented in the // EventPayload_v2 class. The EventPayload class will implement // this interface but will return (-1) for // GetEventType(), GetEventConfigID(), and GetRunNumber() //

Author:
Kotoyo Hoshina //


Constructor & Destructor Documentation

virtual PXXIEventPayload::~PXXIEventPayload  )  [inline, virtual]
 

Destructor

PXXIEventPayload::PXXIEventPayload  )  [inline, protected]
 

Constructor. Must be instanciated as an attribute class object so that it should be protected.


Member Function Documentation

virtual Int32b_t PXXIEventPayload::GetEventConfigID  )  const [pure virtual]
 

Get's the event config id for this event type which acts as a primary key for looking up the parameters/settings which are specific to this specific event-type. Return fEventConfigID in event record

Returns:
int the event configuration id for this event. NOTE:a value of -1 indicates that this is not implemented by this object

Implemented in PXXEventPayload.

virtual Int32b_t PXXIEventPayload::GetEventType  )  const [pure virtual]
 

Get's the event type indicating the configuration type which produced this event. Return fEventType in event record.

Returns:
int the event-type NOTE:a value of -1 indicates that this is not implemented by this object

Implemented in PXXEventPayload.

virtual Int32b_t PXXIEventPayload::GetEventUID  )  const [pure virtual]
 

Returns the unique id assigned to this PXXITriggerRequestPayload from the GlobalTrigger. Return fEventUniqueID in event record.

Returns:
int ... the unique id for this event.

Implemented in PXXEventPayload.

virtual const vector<PXXIReadoutDataPayloadPtr> PXXIEventPayload::GetReadoutDataPayloadPtrs  )  const [pure virtual]
 

Returns the PXXIReadoutDataPayload's which represent the actual data associated with the event. They stored in 2nd or after of composite payload so that it makes a vector to store them, then return a copy of the generated vector (const).

Returns:
vector .... Array of PXXIReadoutDataPayload's

Implemented in PXXEventPayload.

virtual Int32b_t PXXIEventPayload::GetRunNumber  )  const [pure virtual]
 

Get's the run number for this event which provides a key to the instrumentation configuration at the time that this event was produced. Return fRunNumber in event record

Returns:
int .... the run number NOTE:a value of -1 indicates that this is not implemented by this object

Implemented in PXXEventPayload.

virtual const PXXITriggerRequestPayload& PXXIEventPayload::GetTriggerRequestPayload  )  const [pure virtual]
 

Returns the PXXITriggerRequestPayload which provides the context for the data of this event. It stored in 1st component of composite payload, so that it just returns reference to 1st component.

Returns:
PXXITriggerRequestPayload ... the trigger context.

Implemented in PXXEventPayload.


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


Generated on Thu Nov 10 14:06:36 2005 by doxygen version 1.4.1