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

PXXCompositePayloadEnvelope Class Reference

#include <PXXCompositePayloadEnvelope.h>

Inheritance diagram for PXXCompositePayloadEnvelope:

PXXVUnpackable PXXObject PXXVAttWritable TObject List of all members.

Public Member Functions

 SET_LOGGER ("PXXCompositePayloadEnvelope")
 PXXCompositePayloadEnvelope ()
virtual ~PXXCompositePayloadEnvelope ()
virtual Int32b_t GetCompositePayloadLength () const
virtual Short16b_t GetCompositePayloadType () const
virtual Short16b_t GetNumberOfPayloads () const
virtual Int32b_t GetEnvelopeSize () const
virtual void WriteProperties ()

Detailed Description

*** format of composite payload envelope *** // Field | Size | Description // ---------------|---------|------------------------------------------------- // record length | 4 bytes | length of composite part including the envelope // composite type | 2 bytes | indicates composite type in the lower one byte // number payloads| 2 bytes | number of the payloads // --------------------------------------------------------------------------- //
Author:
Kotoyo Hoshina 23/Aug/05 //

Constructor & Destructor Documentation

PXXCompositePayloadEnvelope::PXXCompositePayloadEnvelope (   ) 
 

Constructor. All value of fields are set to 0.

virtual PXXCompositePayloadEnvelope::~PXXCompositePayloadEnvelope (   )  [inline, virtual]
 

Destructor.

Member Function Documentation

virtual Int32b_t PXXCompositePayloadEnvelope::GetCompositePayloadLength (   )  const [virtual]
 

Returns the length in bytes of this composite part of payload including the envelope. If the length is -INT_MAX, send error the program.

Returns:
int ... length of the composite payload

virtual Short16b_t PXXCompositePayloadEnvelope::GetCompositePayloadType (   )  const [virtual]
 

returns the composite payload type If the payload type is -SHRT_MAX, send error the program. The composite type is assigned 2bytes, however, only lower one byte is used then users can use the field to correct endianness of decoder.

Returns:
short ... composite type

virtual Int32b_t PXXCompositePayloadEnvelope::GetEnvelopeSize (   )  const [inline, virtual]
 

returns the size of the envelope itself. It is fixed 8. See class description.

Returns:
int ... size of the envelope

virtual Short16b_t PXXCompositePayloadEnvelope::GetNumberOfPayloads (   )  const [virtual]
 

returns the number of enclosed payloads. If the payload interface type is -SHRT_MAX, send error the program.

Returns:
short ... number of payloads

PXXCompositePayloadEnvelope::SET_LOGGER (  "PXXCompositePayloadEnvelope"   ) 
 

virtual void PXXCompositePayloadEnvelope::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