CigiBaseSOF.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_SOF_INCLUDED_)
#define _CIGI_BASE_SOF_INCLUDED_


#include "CigiBasePacket.h"

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

#define CIGI_SOF_PACKET_ID_V1 101
#define CIGI_SOF_PACKET_SIZE_V1 12

#define CIGI_SOF_PACKET_ID_V2 101
#define CIGI_SOF_PACKET_SIZE_V2 16

#define CIGI_SOF_PACKET_ID_V3 101
#define CIGI_SOF_PACKET_SIZE_V3 16

#define CIGI_SOF_PACKET_ID_V3_2 101
#define CIGI_SOF_PACKET_SIZE_V3_2 24


class CigiSOFV1;
class CigiSOFV2;
class CigiSOFV3;
class CigiSOFV3_2;


//=========================================================

class CIGI_SPEC CigiBaseSOF : public CigiBasePacket
{

friend class CigiSOFV1;
friend class CigiSOFV2;
friend class CigiSOFV3;
friend class CigiSOFV3_2;

public:

   //=========================================================
   enum IGModeGrp
   {
      Reset=0,
      Standby=0,
      Operate=1,
      debug=2,
      OfflineMaint=3
   };

   //=========================================================
   enum EarthRefModelGrp
   {
      WGS84=0,
      HostDefined=1
   };



   //==> Management

   //=========================================================
        CigiBaseSOF();

   //=========================================================
        virtual ~CigiBaseSOF();


   //==> 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);




   //==> Accessing Member Variable Values functions


   //+> Swap

   //=========================================================
   bool GetSwap(void) const { return(BSwapEn); }


   //+> Database ID

   //=========================================================
   Cigi_int8 GetDatabaseID(void) const { return(DatabaseID); }

   //=========================================================
        int SetDatabaseID(const Cigi_int8 DataBaseIDIn, bool bndchk=true)
   {
      DatabaseID = DataBaseIDIn;

      return(CIGI_SUCCESS);
   }


   //+> Frame Counter

   //=========================================================
   Cigi_uint32 GetFrameCntr(void) const { return(FrameCntr); }

   //=========================================================
   int SetFrameCntr(const Cigi_uint32 FrameCntrIn, bool bndchk=true)
   {
      FrameCntr = FrameCntrIn;

      return(CIGI_SUCCESS);
   }


   //+> IG Mode

   //=========================================================
   IGModeGrp GetIGMode(void) const { return(IGMode); }

   //=========================================================
        int SetIGMode(IGModeGrp IGModeIn, bool bndchk=true);


   //+> IG Status

   //=========================================================
   Cigi_uint8 GetIGStatus(void) const { return(IGStatus); }

   //=========================================================
   int SetIGStatus(Cigi_uint8 IGStatusIn, bool bndchk=true)
   {
      IGStatus = IGStatusIn;

      return(CIGI_SUCCESS);
   }



protected:

   //==> Member variables

   //=========================================================
        bool BSwapEn;

   //=========================================================
   Cigi_int8 DatabaseID;

   //=========================================================
   Cigi_uint8 IGStatus;

   //=========================================================
   Cigi_uint32 FrameCntr;

   //=========================================================
   Cigi_uint32 LastRcvdHostFrame;

   //=========================================================
   float TimeStampV2;

   //=========================================================
   Cigi_uint32 TimeStampV3;

   //=========================================================
   Cigi_uint16 ByteSwap;

   //=========================================================
   IGModeGrp IGMode;

   //=========================================================
   EarthRefModelGrp EarthRefModel;

   //=========================================================
   bool TimestampValid;



};

#endif // !defined(_CIGI_BASE_SOF_INCLUDED_)

---