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

PXXVPayload Class Reference

#include <PXXVPayload.h>

Inheritance diagram for PXXVPayload:

PXXVUnpackable PXXIPayload PXXObject PXXVAttWritable TObject PXXDomHitEngineeringFormatPayload PXXVTriggerPayload PXXEngineeringFormatTriggerPayload PXXHitPayload PXXVCompositePayload PXXEngineeringFormatHitDataPayload PXXEventPayload PXXReadoutDataPayload PXXTriggerRequestPayload List of all members.

Public Member Functions

virtual ~PXXVPayload ()
virtual Int32b_t GetPayloadLength () const
virtual Int32b_t GetPayloadType () const
virtual Int32b_t GetPayloadInterfaceType () const
virtual const PXXIUTCTimeGetPayloadTimeUTC ()
virtual Int32b_t Unpack ()
virtual const PXXPayloadEnvelopeGetEnvelope () const

Protected Member Functions

 PXXVPayload (const PXXPayloadEnvelope &envelope)
 PXXVPayload ()
virtual void SetEnvelope (const PXXPayloadEnvelope &env)
virtual PXXPayloadEnvelopeGetEnvelope ()
virtual void SetPayloadTimeUTC (const PXXUTCTime8B &t)

Detailed Description

PXXVPayload //

This is an base(abstract) class of all payloads. // It inherits PXXVUnpackable and doesn't implement Unpack() and Write(), // so you cannot instanciate the class. // All payloads must be an descendant of the class. //

Author:
Kotoyo Hoshina 23/Aug/05 //


Constructor & Destructor Documentation

virtual PXXVPayload::~PXXVPayload  )  [virtual]
 

Destructor.

PXXVPayload::PXXVPayload const PXXPayloadEnvelope envelope  )  [protected]
 

The class is pure virtual so that the constructor should be protected.

PXXVPayload::PXXVPayload  )  [protected]
 

The class is pure virtual so that the constructor should be protected. If you use default constructor, you must set envelope before calling Unpack().


Member Function Documentation

virtual PXXPayloadEnvelope& PXXVPayload::GetEnvelope  )  [inline, protected, virtual]
 

non-const get method to get envelope

Returns:
payload envelope

virtual const PXXPayloadEnvelope& PXXVPayload::GetEnvelope  )  const [inline, virtual]
 

Return the refenence of payload envelope

Returns:
payload envelope

virtual Int32b_t PXXVPayload::GetPayloadInterfaceType  )  const [virtual]
 

returns the Payload interface type as defined in the PXXPayloadInterfaceRegistry. If the payload interface type is -INT_MAX, send error the program.

Implements PXXIPayload.

virtual Int32b_t PXXVPayload::GetPayloadLength  )  const [virtual]
 

Returns the length in bytes of this payload

Implements PXXIPayload.

virtual const PXXIUTCTime& PXXVPayload::GetPayloadTimeUTC  )  [virtual]
 

Return a const reference to the PXXIUTCTime

Implements PXXIPayload.

virtual Int32b_t PXXVPayload::GetPayloadType  )  const [virtual]
 

returns the Payload type If the payload type is , send error the program.

Implements PXXIPayload.

virtual void PXXVPayload::SetEnvelope const PXXPayloadEnvelope env  )  [inline, protected, virtual]
 

set envelope to the payload using operator=

Returns:
payload envelope

virtual void PXXVPayload::SetPayloadTimeUTC const PXXUTCTime8B t  )  [inline, protected, virtual]
 

set method to set PayloadTimeUTC, USE IT ONLY WHEN YOU CANNOT USE Unpack().

virtual Int32b_t PXXVPayload::Unpack  )  [virtual]
 

Override PXXVUnpackable::Unpack() to do length check.

Returns:
int ... It returns how many bytes have unpacked.

Reimplemented from PXXVUnpackable.


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


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