DtCigiBaseDiGuyEndGesture.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2020 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/


#pragma once

#include <makCigiExtensions/makCigiExtensions.h>

#include <CigiBaseVariableSizePckt.h>

#include <string>


namespace makCigiExt
{
   const int CIGI_DI_GUY_END_GESTURE_PACKET_ID = 242;

   // This is the size of the FIXED portion of the packet
   const int CIGI_DI_GUY_END_GESTURE_PACKET_SIZE = 16;

   const int CIGI_DI_GUY_END_GESTURE_PACKET_ID_V4 = 0xf002;

   // This is the size of the FIXED portion of the packet
   const int CIGI_DI_GUY_END_GESTURE_PACKET_SIZE_V4 = 16;

   //=========================================================
   class DT_DLL_MAKCIGIEXTENSIONS DtCigiBaseDiGuyEndGesture :
      public CigiBaseVariableSizePckt
   {
   public:

      //==> Management

      //=========================================================
      DtCigiBaseDiGuyEndGesture(void);

      //=========================================================
      virtual ~DtCigiBaseDiGuyEndGesture(void);

      //=========================================================
      DtCigiBaseDiGuyEndGesture(const DtCigiBaseDiGuyEndGesture &BaseIn);

      //=========================================================
      DtCigiBaseDiGuyEndGesture& operator=(const DtCigiBaseDiGuyEndGesture& BaseIn);

      //==> 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 GetTruePacketSize(CigiBaseVariableSizePckt &refPacket)
      { return(PacketSize + refPacket.GetVariableDataSize()); }

      //==> Accessing Member Variable Values functions

      //+> EntityID

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

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

      //+> PostureEn

      //=========================================================
      int SetRampDownEn(const bool RampDownEnIn, bool bndchk=true)
      {
         myRampDownEn = RampDownEnIn;
         return(CIGI_SUCCESS);
      }

      //=========================================================
      bool GetRampDownEn(void) const { return(myRampDownEn); }

      //+> Ramp Down

      //=========================================================
      int SetRampDown(const double RampDownIn, bool bndchk=true);

      //=========================================================
      double GetRampDown(void) const { return(myRampDown); }

      //+> Gesture

      int SetGesture(const std::string &GestureIn, bool bndchk=true);

      int GetGestureSize(void) const { return(VariableDataSize); }

      //=========================================================
      const std::string & GetGesture(void) const { return(myGesture); }

   protected:

      Cigi_uint16 myEntityID;
      double myRampDown;
      bool myRampDownEn;
      std::string myGesture;

      //=========================================================
      static const int MaxCharCnt = 221;
   };
}