include/KDIS/PDU/Synthetic_Environment/Object_State_Header.hpp

   1 /*********************************************************************
   2 Copyright 2013 Karl Jones
   3 All rights reserved.
   4
   5 Redistribution and use in source and binary forms, with or without
   6 modification, are permitted provided that the following conditions are met:
   7
   8 1. Redistributions of source code must retain the above copyright notice, this
   9    list of conditions and the following disclaimer.
  10 2. Redistributions in binary form must reproduce the above copyright notice,
  11    this list of conditions and the following disclaimer in the documentation
  12    and/or other materials provided with the distribution.
  13
  14 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  15 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  16 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  17 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
  18 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  19 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  20 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  21 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  23 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24
  25 For Further Information Please Contact me at
  26 Karljj1@yahoo.com
  27 http://p.sf.net/kdis/UserGuide
  28 *********************************************************************/
  29
  30 /********************************************************************
  31     class:      Object_State_Header
  32     DIS:        (6) 1278.1a - 1998
  33     created:    07/12/2009
  34     author:     Karl Jones
  35
  36     purpose:    Common attributes for point, linear and areal objects
  37
  38     size:       216 bits / 27 octets
  39 *********************************************************************/
  40
  41 #pragma once
  42
  43 #include "KDIS/DataTypes/EntityIdentifier.hpp"
  44 #include "KDIS/PDU/Header.hpp"
  45
  46 namespace KDIS {
  47 namespace PDU {
  48
  49 class KDIS_EXPORT Object_State_Header : public Header {
  50  protected:
  51   KDIS::DATA_TYPE::EntityIdentifier m_ObjID;
  52
  53   KDIS::DATA_TYPE::EntityIdentifier m_RefObjID;
  54
  55   KUINT16 m_ui16UpdateNum;
  56
  57   KUINT8 m_ui8ForceID;
  58
  59  public:
  60   static const KUINT16 OBJECT_STATE_HEADER_SIZE = 27;
  61
  62   Object_State_Header();
  63
  64   explicit Object_State_Header(const Header& H);
  65
  66   explicit Object_State_Header(KDataStream& stream);
  67
  68   Object_State_Header(const Header& H, KDataStream& stream);
  69
  70   Object_State_Header(const KDIS::DATA_TYPE::EntityIdentifier& ObjID,
  71                       const KDIS::DATA_TYPE::EntityIdentifier& RefObjID,
  72                       KUINT16 UpdateNum, KDIS::DATA_TYPE::ENUMS::ForceID FI);
  73
  74   virtual ~Object_State_Header();
  75
  76   //************************************
  77   // FullName:    KDIS::PDU::Object_State_Header::SetObjectID
  78   //              KDIS::PDU::Object_State_Header::GetObjectID
  79   // Description: The unique identification of the object in the SE.
  80   // Parameter:   const EntityIdentifier & ID
  81   //************************************
  82   void SetObjectID(const KDIS::DATA_TYPE::EntityIdentifier& ID);
  83   const KDIS::DATA_TYPE::EntityIdentifier& GetObjectID() const;
  84   KDIS::DATA_TYPE::EntityIdentifier& GetObjectID();
  85
  86   //************************************
  87   // FullName:    KDIS::PDU::Object_State_Header::SetReferencedObjectID
  88   //              KDIS::PDU::Object_State_Header::GetReferencedObjectID
  89   // Description: The unique identification of the object with which this
  90   //              state object is associated with.
  91   // Parameter:   const EntityIdentifier & ID
  92   //************************************
  93   void SetReferencedObjectID(const KDIS::DATA_TYPE::EntityIdentifier& ID);
  94   const KDIS::DATA_TYPE::EntityIdentifier& GetReferencedObjectID() const;
  95   KDIS::DATA_TYPE::EntityIdentifier& GetReferencedObjectID();
  96
  97   //************************************
  98   // FullName:    KDIS::PDU::Object_State_Header::SetUpdateNumber
  99   //              KDIS::PDU::Object_State_Header::GetUpdateNumber
 100   // Description: This field shall represent the unique update number, starting
 101   // with 1,
 102   //              of each state transition of an individual object.
 103   // Parameter:   KUINT16 U
 104   //************************************
 105   void SetUpdateNumber(KUINT16 U);
 106   KUINT16 GetUpdateNumber() const;
 107
 108   //************************************
 109   // FullName:    KDIS::PDU::Object_State_Header::SetForceID
 110   //              KDIS::PDU::Object_State_Header::GetForceID
 111   // Description: Identifies the force that created or modified the object.
 112   // Parameter:   ForceID ID
 113   //************************************
 114   void SetForceID(KDIS::DATA_TYPE::ENUMS::ForceID ID);
 115   KDIS::DATA_TYPE::ENUMS::ForceID GetForceID() const;
 116
 117   //************************************
 118   // FullName:    KDIS::PDU::Object_State_Header::GetAsString
 119   // Description: Returns a string representation of the PDU.
 120   //************************************
 121   virtual KString GetAsString() const;
 122
 123   //************************************
 124   // FullName:    KDIS::PDU::Object_State_Header::Decode
 125   // Description: Convert From Network Data.
 126   // Parameter:   KDataStream & stream
 127   // Parameter:   bool ignoreHeader = false - Decode the header from the stream?
 128   //************************************
 129   virtual void Decode(KDataStream& stream, bool ignoreHeader = false);
 130
 131   //************************************
 132   // FullName:    KDIS::PDU::Object_State_Header::Encode
 133   // Description: Convert To Network Data.
 134   // Parameter:   KDataStream & stream
 135   //************************************
 136   virtual KDataStream Encode() const;
 137   virtual void Encode(KDataStream& stream) const;
 138
 139   KBOOL operator==(const Object_State_Header& Value) const;
 140   KBOOL operator!=(const Object_State_Header& Value) const;
 141 };
 142
 143 }  // END namespace PDU
 144 }  // END namespace KDIS