KDIS  2-8-x
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Static Public Attributes | Protected Attributes | Friends | List of all members
Header6 Class Reference

#include <Header6.h>

Inheritance diagram for Header6:
Inheritance graph
[legend]
Collaboration diagram for Header6:
Collaboration graph
[legend]

Public Member Functions

virtual void Decode (KDataStream &stream, bool ignoreHeader=false) throw ( KException )
 Description: Convert From Network Data. More...
 
virtual KDataStream Encode () const
 Description: Convert To Network Data. More...
 
virtual void Encode (KDataStream &stream) const
 
virtual KString GetAsString () const
 Description: Returns a string representation of the PDU. More...
 
KUINT8 GetExerciseID () const
 
KUINT16 GetPDULength () const
 
KDIS::DATA_TYPE::ENUMS::PDUType GetPDUType () const
 
KDIS::DATA_TYPE::ENUMS::ProtocolFamily GetProtocolFamily () const
 
KDIS::DATA_TYPE::ENUMS::ProtocolVersion GetProtocolVersion () const
 
const KDIS::DATA_TYPE::TimeStamp & GetTimeStamp () const
 
KDIS::DATA_TYPE::TimeStamp & GetTimeStamp ()
 
 Header6 ()
 
 Header6 (KDataStream &stream) throw ( KException )
 
 Header6 (KDIS::DATA_TYPE::ENUMS::ProtocolVersion PV, KUINT8 ExerciseID, KDIS::DATA_TYPE::ENUMS::PDUType PT, KDIS::DATA_TYPE::ENUMS::ProtocolFamily PF, const KDIS::DATA_TYPE::TimeStamp &TS, KUINT16 PDULength)
 
KBOOL operator!= (const Header6 &Value) const
 
KBOOL operator== (const Header6 &Value) const
 
void SetExerciseID (KUINT8 EID)
 
void SetPDULength (KUINT16 PDUL)
 
void SetPDUType (KDIS::DATA_TYPE::ENUMS::PDUType Type)
 
void SetProtocolFamily (KDIS::DATA_TYPE::ENUMS::ProtocolFamily PF)
 
void SetProtocolVersion (KDIS::DATA_TYPE::ENUMS::ProtocolVersion PV)
 to the mimimum version of DIS required to support the current PDU. More...
 
void SetTimeStamp (const KDIS::DATA_TYPE::TimeStamp &TS)
 
virtual ~Header6 ()
 

Static Public Attributes

static const KUINT16 HEADER6_PDU_SIZE = 12
 

Protected Attributes

KDIS::DATA_TYPE::TimeStamp m_TimeStamp
 
KUINT16 m_ui16PDULength
 
KUINT8 m_ui8ExerciseID
 
KUINT8 m_ui8Padding1
 
KUINT8 m_ui8Padding2
 
KUINT8 m_ui8PDUType
 
KUINT8 m_ui8ProtocolFamily
 
KUINT8 m_ui8ProtocolVersion
 

Friends

KDataStream & operator<< (KDataStream &stream, Header6 *H)
 
KDataStream & operator>> (KDataStream &stream, Header6 *H)
 

Constructor & Destructor Documentation

Header6 ( )
Header6 ( KDataStream &  stream)
throw (KException
)
Header6 ( KDIS::DATA_TYPE::ENUMS::ProtocolVersion  PV,
KUINT8  ExerciseID,
KDIS::DATA_TYPE::ENUMS::PDUType  PT,
KDIS::DATA_TYPE::ENUMS::ProtocolFamily  PF,
const KDIS::DATA_TYPE::TimeStamp &  TS,
KUINT16  PDULength 
)
virtual ~Header6 ( )
virtual

Member Function Documentation

void SetProtocolVersion ( KDIS::DATA_TYPE::ENUMS::ProtocolVersion  PV)

to the mimimum version of DIS required to support the current PDU.

Description: DIS protocol version. In KDIS the version is automatically set by each PDU

KDIS::DATA_TYPE::ENUMS::ProtocolVersion GetProtocolVersion ( ) const
void SetExerciseID ( KUINT8  EID)

Description: Unique to each exercise being conducted simultaneously.

KUINT8 GetExerciseID ( ) const
void SetPDUType ( KDIS::DATA_TYPE::ENUMS::PDUType  Type)

Description: The type of PDU. Set by PDU automatically. Only change if you know what you are doing.

KDIS::DATA_TYPE::ENUMS::PDUType GetPDUType ( ) const
void SetProtocolFamily ( KDIS::DATA_TYPE::ENUMS::ProtocolFamily  PF)

Description: Family of protocols to which the PDU belongs Set by PDU automatically. Only change if you know what you are doing.

KDIS::DATA_TYPE::ENUMS::ProtocolFamily GetProtocolFamily ( ) const
void SetTimeStamp ( const KDIS::DATA_TYPE::TimeStamp &  TS)

Description: Specifies the time which the data in the PDU is valid.

const KDIS::DATA_TYPE::TimeStamp& GetTimeStamp ( ) const
KDIS::DATA_TYPE::TimeStamp& GetTimeStamp ( )
void SetPDULength ( KUINT16  PDUL)

Description: Specified the length of the PDU in KOCTETs( 8 bits = 1 octet ). This value will be set by each PDU, you should not have to set this value manually.

KUINT16 GetPDULength ( ) const
virtual KString GetAsString ( ) const
virtual

Description: Returns a string representation of the PDU.

Reimplemented in Aggregate_State_PDU, Entity_State_PDU, Header7, LE_Detonation_PDU, Directed_Energy_Fire_PDU, Appearance_PDU, Gridded_Data_PDU, TSPI_PDU, Transmitter_PDU, Environmental_Process_PDU, Minefield_Data_PDU, Intercom_Control_PDU, LE_Fire_PDU, Minefield_State_PDU, Collision_Elastic_PDU, IFF_PDU, IO_Action_PDU, Designator_PDU, Underwater_Acoustic_PDU, Minefield_Query_PDU, Point_Object_State_PDU, IsGroupOf_PDU, Detonation_PDU, Areal_Object_State_PDU, SEES_PDU, Collision_PDU, Entity_State_Update_PDU, Attribute_PDU, IO_Report_PDU, Fire_PDU, Transfer_Control_Request_PDU, Electromagnetic_Emission_PDU, Data_Query_PDU, Linear_Object_State_PDU, Signal_PDU, IsPartOf_PDU, Record_Query_R_PDU, Minefield_Response_NACK_PDU, Receiver_PDU, Stop_Freeze_PDU, Comment_PDU, Object_State_Header, Warfare_Header, Acknowledge_PDU, Entity_Damage_Status_PDU, Start_Resume_PDU, Set_Record_R_PDU, Radio_Communications_Header, Resupply_Received_PDU, Articulated_Parts_PDU, Simulation_Management_Header, Record_R_PDU, IO_Header, LE_Header, Logistics_Header, Action_Request_PDU, Repair_Response_PDU, Data_PDU, Event_Report_PDU, Minefield_Header, Action_Response_PDU, Create_Entity_PDU, Acknowledge_R_PDU, Repair_Complete_PDU, Service_Request_PDU, Create_Entity_R_PDU, Stop_Freeze_R_PDU, Start_Resume_R_PDU, Data_R_PDU, Action_Request_R_PDU, Remove_Entity_R_PDU, Intercom_Signal_PDU, Event_Report_R_PDU, Remove_Entity_PDU, Action_Response_R_PDU, Resupply_Offer_PDU, Set_Data_PDU, Comment_R_PDU, Set_Data_R_PDU, Resupply_Cancel_PDU, and Data_Query_R_PDU.

virtual void Decode ( KDataStream &  stream,
bool  ignoreHeader = false 
)
throw (KException
)
virtual

Description: Convert From Network Data.

Reimplemented in Aggregate_State_PDU, Entity_State_PDU, Header7, LE_Detonation_PDU, Directed_Energy_Fire_PDU, Appearance_PDU, Gridded_Data_PDU, TSPI_PDU, Transmitter_PDU, Environmental_Process_PDU, Minefield_Data_PDU, Intercom_Control_PDU, LE_Fire_PDU, Minefield_State_PDU, Collision_Elastic_PDU, IFF_PDU, IO_Action_PDU, Designator_PDU, Underwater_Acoustic_PDU, Minefield_Query_PDU, Point_Object_State_PDU, IsGroupOf_PDU, Detonation_PDU, Areal_Object_State_PDU, SEES_PDU, Collision_PDU, Entity_State_Update_PDU, Attribute_PDU, IO_Report_PDU, Fire_PDU, Transfer_Control_Request_PDU, Electromagnetic_Emission_PDU, Data_Query_PDU, Linear_Object_State_PDU, Signal_PDU, IsPartOf_PDU, Record_Query_R_PDU, Minefield_Response_NACK_PDU, Receiver_PDU, Stop_Freeze_PDU, Comment_PDU, Object_State_Header, Warfare_Header, Acknowledge_PDU, Entity_Damage_Status_PDU, Start_Resume_PDU, Set_Record_R_PDU, Radio_Communications_Header, Resupply_Received_PDU, Articulated_Parts_PDU, Simulation_Management_Header, Record_R_PDU, IO_Header, LE_Header, Logistics_Header, Action_Request_PDU, Repair_Response_PDU, Data_PDU, Event_Report_PDU, Minefield_Header, Action_Response_PDU, Create_Entity_PDU, Repair_Complete_PDU, Service_Request_PDU, Create_Entity_R_PDU, Stop_Freeze_R_PDU, Start_Resume_R_PDU, Data_R_PDU, Action_Request_R_PDU, Set_Data_R_PDU, and Data_Query_R_PDU.

virtual KDataStream Encode ( ) const
virtual

Description: Convert To Network Data.

Reimplemented in Aggregate_State_PDU, Entity_State_PDU, Header7, LE_Detonation_PDU, Directed_Energy_Fire_PDU, Appearance_PDU, Gridded_Data_PDU, TSPI_PDU, Transmitter_PDU, Environmental_Process_PDU, Minefield_Data_PDU, Intercom_Control_PDU, LE_Fire_PDU, Minefield_State_PDU, Collision_Elastic_PDU, IFF_PDU, IO_Action_PDU, Underwater_Acoustic_PDU, Designator_PDU, Minefield_Query_PDU, Point_Object_State_PDU, IsGroupOf_PDU, Detonation_PDU, Areal_Object_State_PDU, SEES_PDU, Collision_PDU, Entity_State_Update_PDU, Attribute_PDU, IO_Report_PDU, Fire_PDU, Transfer_Control_Request_PDU, Electromagnetic_Emission_PDU, Data_Query_PDU, Linear_Object_State_PDU, Signal_PDU, IsPartOf_PDU, Record_Query_R_PDU, Minefield_Response_NACK_PDU, Receiver_PDU, Stop_Freeze_PDU, Comment_PDU, Object_State_Header, Warfare_Header, Acknowledge_PDU, Entity_Damage_Status_PDU, Set_Record_R_PDU, Start_Resume_PDU, Radio_Communications_Header, Resupply_Received_PDU, Articulated_Parts_PDU, Simulation_Management_Header, Record_R_PDU, IO_Header, LE_Header, Logistics_Header, Action_Request_PDU, Repair_Response_PDU, Data_PDU, Event_Report_PDU, Minefield_Header, Action_Response_PDU, Create_Entity_PDU, Repair_Complete_PDU, Service_Request_PDU, Create_Entity_R_PDU, Stop_Freeze_R_PDU, Data_R_PDU, Start_Resume_R_PDU, Action_Request_R_PDU, Set_Data_R_PDU, and Data_Query_R_PDU.

virtual void Encode ( KDataStream &  stream) const
virtual

Reimplemented in Aggregate_State_PDU, Entity_State_PDU, Header7, LE_Detonation_PDU, Directed_Energy_Fire_PDU, Appearance_PDU, Gridded_Data_PDU, TSPI_PDU, Transmitter_PDU, Environmental_Process_PDU, Minefield_Data_PDU, Intercom_Control_PDU, LE_Fire_PDU, Minefield_State_PDU, Collision_Elastic_PDU, IFF_PDU, IO_Action_PDU, Underwater_Acoustic_PDU, Designator_PDU, Minefield_Query_PDU, Point_Object_State_PDU, IsGroupOf_PDU, Detonation_PDU, Areal_Object_State_PDU, SEES_PDU, Collision_PDU, Entity_State_Update_PDU, Attribute_PDU, IO_Report_PDU, Fire_PDU, Transfer_Control_Request_PDU, Electromagnetic_Emission_PDU, Data_Query_PDU, Linear_Object_State_PDU, Signal_PDU, IsPartOf_PDU, Record_Query_R_PDU, Minefield_Response_NACK_PDU, Receiver_PDU, Stop_Freeze_PDU, Comment_PDU, Object_State_Header, Warfare_Header, Acknowledge_PDU, Entity_Damage_Status_PDU, Set_Record_R_PDU, Start_Resume_PDU, Radio_Communications_Header, Resupply_Received_PDU, Articulated_Parts_PDU, Simulation_Management_Header, Record_R_PDU, IO_Header, LE_Header, Logistics_Header, Action_Request_PDU, Repair_Response_PDU, Data_PDU, Event_Report_PDU, Minefield_Header, Action_Response_PDU, Create_Entity_PDU, Repair_Complete_PDU, Service_Request_PDU, Create_Entity_R_PDU, Stop_Freeze_R_PDU, Data_R_PDU, Start_Resume_R_PDU, Action_Request_R_PDU, Set_Data_R_PDU, and Data_Query_R_PDU.

KBOOL operator== ( const Header6 &  Value) const
KBOOL operator!= ( const Header6 &  Value) const

Friends And Related Function Documentation

KDataStream& operator>> ( KDataStream &  stream,
Header6 *  H 
)
friend
KDataStream& operator<< ( KDataStream &  stream,
Header6 *  H 
)
friend

Member Data Documentation

KUINT8 m_ui8ProtocolVersion
protected
KUINT8 m_ui8ExerciseID
protected
KUINT8 m_ui8PDUType
protected
KUINT8 m_ui8ProtocolFamily
protected
KDIS::DATA_TYPE::TimeStamp m_TimeStamp
protected
KUINT16 m_ui16PDULength
protected
KUINT8 m_ui8Padding1
protected
KUINT8 m_ui8Padding2
protected
const KUINT16 HEADER6_PDU_SIZE = 12
static
The documentation for this class was generated from the following file: