CigiBaseCompCtrl.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_COMP_CTRL_INCLUDED_)
#define _CIGI_BASE_COMP_CTRL_INCLUDED_

#include "CigiBasePacket.h"

// ====================================================================
// preprocessor definitions
// ====================================================================

#define CIGI_COMP_CTRL_PACKET_ID_V1 3
#define CIGI_COMP_CTRL_PACKET_SIZE_V1 20

#define CIGI_COMP_CTRL_PACKET_ID_V2 3
#define CIGI_COMP_CTRL_PACKET_SIZE_V2 20

#define CIGI_COMP_CTRL_PACKET_ID_V3 4
#define CIGI_COMP_CTRL_PACKET_SIZE_V3 32

#define CIGI_SHORT_COMP_CTRL_PACKET_ID_V3 5
#define CIGI_SHORT_COMP_CTRL_PACKET_SIZE_V3 16

#define CIGI_COMP_CTRL_PACKET_ID_V3_3 4
#define CIGI_COMP_CTRL_PACKET_SIZE_V3_3 32

#define CIGI_SHORT_COMP_CTRL_PACKET_ID_V3_3 5
#define CIGI_SHORT_COMP_CTRL_PACKET_SIZE_V3_3 16



class CigiCompCtrlV1;
class CigiCompCtrlV2;
class CigiCompCtrlV3;
class CigiShortCompCtrlV3;
class CigiCompCtrlV3_3;
class CigiShortCompCtrlV3_3;


class CIGI_SPEC CigiBaseCompCtrl : public CigiBasePacket
{

friend class CigiCompCtrlV1;
friend class CigiCompCtrlV2;
friend class CigiCompCtrlV3;
friend class CigiShortCompCtrlV3;
friend class CigiCompCtrlV3_3;
friend class CigiShortCompCtrlV3_3;

public:

   //=========================================================
   enum CompAssocGrp
   {
      NoCnvtV1=-1,
      Entity=0,
      Environment=1,
      View=2
   };

   //=========================================================
   enum CompClassV2Grp
   {
      NoCnvtV2=-1,
      EntityV2=0,
      EnvironmentV2=1,
      ViewV2=2,
      ViewGrpV2=3,
      SensorV2=4,
      SystemV2=5
   };

   //=========================================================
   enum CompClassV3Grp
   {
      NoCnvtV3=-1,
      EntityV3=0,
      ViewV3=1,
      ViewGrpV3=2,
      SensorV3=3,
      RegionalSeaSurfaceV3=4,
      RegionalTerrainSurfaceV3=5,
      RegionalLayeredWeatherV3=6,
      GlobalSeaSurfaceV3=7,
      GlobalTerrainSurfaceV3=8,
      GlobalLayeredWeatherV3=9,
      AtmosphereV3=10,
      CelestialSphereV3=11,
      EventV3=12,
      SystemV3=13,
      SymbolSurfaceV3_3=14,
      SymbolV3_3=15
   };

   //=========================================================
   enum BytePos
   {
      MSB=3,   // Most significant byte
      Ord2=2,  // 2nd order byte
      Ord3=1,  // 3rd order byte
      LSB=0    // Least significant byte
   };

   //=========================================================
   enum HalfWordPos
   {
      MSHW=1,  // Most significant half word
      LSHW=0   // least significant half word
   };




   //==> Management

   //=========================================================
   CigiBaseCompCtrl() { };

   //=========================================================
   virtual ~CigiBaseCompCtrl() { };


   //==> Buffer Packing/Unpacking

   //=========================================================
   virtual int Pack(CigiBasePacket * Base, Cigi_uint8 * Buff, void *Spec) const=0;

   //=========================================================
   virtual int Unpack(Cigi_uint8 * Buff, bool Swap, void *Spec) =0;

   //=========================================================
        virtual int GetCnvt(CigiVersionID &CnvtVersion,
                       CigiCnvtInfoType::Type &CnvtInfo) =0;



   //==> Accessing Member Variable Values functions

   //+> CompID

   //=========================================================
   int SetCompID(const Cigi_uint16 CompIDIn, bool bndchk=true)
   {
      CompID = CompIDIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint16 GetCompID(void) const { return(CompID); }



protected:

   //==> Member variables

   //=========================================================
   Cigi_uint16 CompID;

   //=========================================================
   Cigi_uint16 InstanceID;

   //=========================================================
   Cigi_uint16 EntityID;

   //=========================================================
   Cigi_uint8 ViewID;

   //=========================================================
   Cigi_uint16 CompState;

   //=========================================================
   CompAssocGrp CompAssoc;

   //=========================================================
   CompClassV2Grp CompClassV2;

   //=========================================================
   CompClassV3Grp CompClassV3;

   //=========================================================
   Cigi_uint32 CompData[6];


};

#endif // #if !defined(_CIGI_BASE_COMP_CTRL_INCLUDED_)

---