PXXPayloadEnvelope Class Reference
#include <PXXPayloadEnvelope.h>
Inheritance diagram for PXXPayloadEnvelope:
List of all members.
Detailed Description
PXXPayloadEnvelope //
This is the envelope class which placed on the top of every payloads. // The envelope in java payloads must be written in BIG_ENDIAN. // The payload type is assigned 4bytes, however, only lower two bytes are used // then users can use the field to correct endianness of decoder. // format of payload envelope *** // Field | Size | Description // ---------------|---------|------------------------------------------------- // record length | 4 bytes | total payload length including the envelope // payload type | 4 bytes | indicates payload type in the lower two bytes // universal time | 8 bytes | rap-cal unique time // --------------------------------------------------------------------------- //
- Author:
- Kotoyo Hoshina 23/Aug/05 //
Constructor & Destructor Documentation
| PXXPayloadEnvelope::PXXPayloadEnvelope |
( |
|
) |
|
|
|
|
Constructor. All value of fields are set to 0. |
Member Function Documentation
| virtual Int32b_t PXXPayloadEnvelope::GetPayloadLength |
( |
|
) |
const [virtual] |
|
|
|
Returns the length in bytes of this payload including the envelope. If the length is -INT_MAX, send error the program. |
| virtual Int32b_t PXXPayloadEnvelope::GetPayloadType |
( |
|
) |
const [virtual] |
|
|
|
returns the payload type If the payload type is -INT_MAX, send error the program. |
| virtual Long64b_t PXXPayloadEnvelope::GetUniversalTime64b |
( |
|
) |
const [virtual] |
|
|
|
returns the Payload interface type as defined in the PXXPayloadInterfaceRegistry. If the payload interface type is -INT_MAX, send error the program. |
| virtual Int32b_t PXXPayloadEnvelope::GetUnpackedEnvelopeSize |
( |
|
) |
[inline, virtual] |
|
|
|
returns the size of the envelope itself. It is fixed 16. See class description. - Returns:
- int ... size of the envelope
|
| PXXPayloadEnvelope::SET_LOGGER |
( |
"PXXPayloadEnvelope" |
|
) |
|
|
| virtual void PXXPayloadEnvelope::SetPayloadLength |
( |
Int32b_t |
l |
) |
[inline, virtual] |
|
|
|
Use the set function only when you cannot use Unpack() method... |
| virtual void PXXPayloadEnvelope::SetPayloadType |
( |
Int32b_t |
t |
) |
[inline, virtual] |
|
|
|
Use the set function only when you cannot use Unpack() method... |
| virtual void PXXPayloadEnvelope::SetUniversalTime64b |
( |
Long64b_t |
t |
) |
[inline, virtual] |
|
|
|
Use the set function only when you cannot use Unpack() method... |
| virtual void PXXPayloadEnvelope::WriteProperties |
( |
|
) |
[virtual] |
|
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