DtCigiBaseDiGuyExecuteGesture.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_EXECUTE_GESTURE_PACKET_ID = 241;

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

   const int CIGI_DI_GUY_EXECUTE_GESTURE_PACKET_ID_V4 = 0xf001;

   // This is the size of the FIXED portion of the packet
   const int CIGI_DI_GUY_EXECUTE_GESTURE_PACKET_SIZE_V4 = 24;

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

      //==> Management

      //=========================================================
      DtCigiBaseDiGuyExecuteGesture(void);

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

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

      //=========================================================
      DtCigiBaseDiGuyExecuteGesture& operator=(const DtCigiBaseDiGuyExecuteGesture& 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 SetRepetitionsEn(const bool RepetitionsEnIn, bool bndchk=true)
      {
         myRepetitionsEn = RepetitionsEnIn;
         return(CIGI_SUCCESS);
      }

      //=========================================================
      bool GetRepetitionsEn(void) const { return(myRepetitionsEn); }

      //+> Repetitions

      //=========================================================
      int SetRepetitions(const Cigi_uint16 RepetitionsIn, bool bndchk=true);

      //=========================================================
      Cigi_uint16 GetRepetitions(void) const { return(myRepetitions); }

      //+> WeaponStateEn

      //=========================================================
      int SetDurationEn(const bool DurationEnIn, bool bndchk=true)
      {
         myDurationEn = DurationEnIn;
         return(CIGI_SUCCESS);
      }

      //=========================================================
      bool GetDurationEn(void) const { return(myDurationEn); }

      //+> Duration

      //=========================================================
      int SetDuration(float DurationIn, bool bndchk=true);

      //=========================================================
      float GetDuration(void) const { return(myDuration); }

      //+> ChannelAWeightEn

      //=========================================================
      int SetChannelAWeightEn(const bool ChannelAWeightEnIn, bool bndchk=true)
      {
         myChannelAWeightEn = ChannelAWeightEnIn;
         return(CIGI_SUCCESS);
      }

      //=========================================================
      bool GetChannelAWeightEn(void) const { return(myChannelAWeightEn); }

      //+> ChannelAWeight

      //=========================================================
      int SetChannelAWeight(float ChannelAWeightIn, bool bndchk=true);

      //=========================================================
      float GetChannelAWeight(void) const { return(myChannelAWeight); }

      //+> 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;
      Cigi_uint16 myRepetitions;
      float myDuration;
      float myChannelAWeight;
      std::string myGesture;

      bool myRepetitionsEn;
      bool myDurationEn;
      bool myChannelAWeightEn;

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