CigiBaseRateCtrl.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_RATE_CTRL_INCLUDED_)
#define _CIGI_BASE_RATE_CTRL_INCLUDED_

#include "CigiBasePacket.h"

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

#define CIGI_RATE_CTRL_PACKET_ID_V1 5
#define CIGI_RATE_CTRL_PACKET_SIZE_V1 32

#define CIGI_RATE_CTRL_PACKET_ID_V2 5
#define CIGI_RATE_CTRL_PACKET_SIZE_V2 32

#define CIGI_RATE_CTRL_PACKET_ID_V3 8
#define CIGI_RATE_CTRL_PACKET_SIZE_V3 32

#define CIGI_RATE_CTRL_PACKET_ID_V3_2 8
#define CIGI_RATE_CTRL_PACKET_SIZE_V3_2 32


class CigiRateCtrlV1;
class CigiRateCtrlV2;
class CigiRateCtrlV3;
class CigiRateCtrlV3_2;


class CIGI_SPEC CigiBaseRateCtrl : public CigiBasePacket
{

friend class CigiRateCtrlV1;
friend class CigiRateCtrlV2;
friend class CigiRateCtrlV3;
friend class CigiRateCtrlV3_2;

public:


   //=========================================================
   enum CoordSysGrp
   {
      World=0,
      Parent=0,
      Local=1
   };


   //==> Management

   //=========================================================
   CigiBaseRateCtrl() { };

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


   //==> 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)
   {
      CnvtInfo.ProcID = CigiProcessType::ProcStd;

      // V1 & V2 use the same packet id number
      if(CnvtVersion.CigiMajorVersion < 3)
         CnvtInfo.CnvtPacketID = CIGI_RATE_CTRL_PACKET_ID_V2;
      else
         CnvtInfo.CnvtPacketID = CIGI_RATE_CTRL_PACKET_ID_V3;

      return(CIGI_SUCCESS);
   }



   //==> Accessing Member Variable Values functions

   //+> EntityID

   //=========================================================
   int SetEntityID(const Cigi_uint16 EntityIDIn, bool bndchk=true)
   {
      EntityID = EntityIDIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint16 GetEntityID(void) const { return(EntityID); }


   //+> XRate

   //=========================================================
   int SetXRate(const float XRateIn, bool bndchk=true)
   {
      XRate = XRateIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetXRate(void) const { return(XRate); }


   //+> YRate

   //=========================================================
   int SetYRate(const float YRateIn, bool bndchk=true)
   {
      YRate = YRateIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetYRate(void) const { return(YRate); }


   //+> ZRate

   //=========================================================
   int SetZRate(const float ZRateIn, bool bndchk=true)
   {
      ZRate = ZRateIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetZRate(void) const { return(ZRate); }


   //+> RollRate

   //=========================================================
   int SetRollRate(const float RollRateIn, bool bndchk=true)
   {
      RollRate = RollRateIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetRollRate(void) const { return(RollRate); }


   //+> PitchRate

   //=========================================================
   int SetPitchRate(const float PitchRateIn, bool bndchk=true)
   {
      PitchRate = PitchRateIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetPitchRate(void) const { return(PitchRate); }


   //+> YawRate

   //=========================================================
   int SetYawRate(const float YawRateIn, bool bndchk=true)
   {
      YawRate = YawRateIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetYawRate(void) const { return(YawRate); }



protected:

   //==> Member variables

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

   //=========================================================
   Cigi_int8 ArtPartIDV1;

   //=========================================================
   Cigi_uint8 ArtPartIDV3;

   //=========================================================
   bool ApplyToArtPart;

   //=========================================================
   CoordSysGrp CoordSys;

   //=========================================================
   float XRate;

   //=========================================================
   float YRate;

   //=========================================================
   float ZRate;

   //=========================================================
   float RollRate;

   //=========================================================
   float PitchRate;

   //=========================================================
   float YawRate;


};

#endif // #if !defined(_CIGI_BASE_RATE_CTRL_INCLUDED_)

---