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

PXXEventPayload Class Reference

#include <PXXEventPayload.h>

Inheritance diagram for PXXEventPayload:

PXXVCompositePayload PXXIEventPayload PXXVTriggerPayload PXXICompositePayload PXXVPayload PXXITriggerPayload PXXVUnpackable PXXIPayload PXXObject PXXVAttWritable TObject List of all members.

Public Member Functions

 SET_LOGGER ("PXXEventPayload")
 PXXEventPayload (const PXXPayloadEnvelope &envelope)
virtual ~PXXEventPayload ()
virtual Int32b_t GetTriggerType () const
virtual Int32b_t GetTriggerConfigID () const
virtual const PXXISourceID & GetSourceID ()
virtual const PXXIUTCTime & GetFirstTimeUTC ()
virtual const PXXIUTCTime & GetLastTimeUTC ()
virtual Int32b_t GetEventType () const
virtual Int32b_t GetEventConfigID () const
virtual Int32b_t GetRunNumber () const
virtual Int32b_t GetEventUID () const
virtual const PXXITriggerRequestPayload & GetTriggerRequestPayload () const
virtual const vector< PXXIReadoutDataPayloadPtr > GetReadoutDataPayloadPtrs () const
virtual void WriteProperties ()

Constructor & Destructor Documentation

PXXEventPayload::PXXEventPayload (  const PXXPayloadEnvelope &  envelope  ) 
 

Constructor of an EventPayload (version 1).

virtual PXXEventPayload::~PXXEventPayload (   )  [virtual]
 

Destructor.

Member Function Documentation

virtual Int32b_t PXXEventPayload::GetEventConfigID (   )  const [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. However, version 1 doesn't have a field of Event configID so that the function returns -1 which means "not implemented".

Returns:
int the event configuration id for this event.

Implements PXXIEventPayload.

virtual Int32b_t PXXEventPayload::GetEventType (   )  const [virtual]
 

Get's the event type indicating the configuration type which produced this event. However, version 1 doesn't have a field of event type so that the function returns -1 which means "not implemented".

Returns:
int the event-type

Implements PXXIEventPayload.

virtual Int32b_t PXXEventPayload::GetEventUID (   )  const [virtual]
 

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

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

Implements PXXIEventPayload.

virtual const PXXIUTCTime& PXXEventPayload::GetFirstTimeUTC (   )  [virtual]
 

returns start time of interval (implementation of PXXICompositePayload)

Implements PXXICompositePayload.

virtual const PXXIUTCTime& PXXEventPayload::GetLastTimeUTC (   )  [virtual]
 

returns end time of interval (implementation of PXXICompositePayload)

Implements PXXICompositePayload.

virtual const vector<PXXIReadoutDataPayloadPtr> PXXEventPayload::GetReadoutDataPayloadPtrs (   )  const [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

Implements PXXIEventPayload.

virtual Int32b_t PXXEventPayload::GetRunNumber (   )  const [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. However, version 1 doesn't have a field of Run Number so that the function returns -1 which means "not implemented".

Returns:
int .... the run number

Implements PXXIEventPayload.

virtual const PXXISourceID& PXXEventPayload::GetSourceID (   )  [virtual]
 

returns ID of process that is responsible for this payload (implementation of PXXITriggerPayload)

Implements PXXITriggerPayload.

virtual Int32b_t PXXEventPayload::GetTriggerConfigID (   )  const [virtual]
 

returns ID of trigger (implementation of PXXITriggerPayload)

Implements PXXITriggerPayload.

virtual const PXXITriggerRequestPayload& PXXEventPayload::GetTriggerRequestPayload (   )  const [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.

Implements PXXIEventPayload.

virtual Int32b_t PXXEventPayload::GetTriggerType (   )  const [virtual]
 

returns the Trigger type (implementation of PXXITriggerPayload)

Implements PXXITriggerPayload.

PXXEventPayload::SET_LOGGER (  "PXXEventPayload"   ) 
 

virtual void PXXEventPayload::WriteProperties (   )  [virtual]
 

Write informations to the output stream

Implements PXXVAttWritable.

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