CigiBaseShortArtPartCtrl.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_SHORT_ART_PART_CTRL_INCLUDED_)
#define _CIGI_BASE_SHORT_ART_PART_CTRL_INCLUDED_

#include "CigiBasePacket.h"

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

#define CIGI_SHORT_ART_PART_CTRL_PACKET_ID_V3 7
#define CIGI_SHORT_ART_PART_CTRL_PACKET_SIZE_V3 16


class CigiShortArtPartCtrlV3;
class CigiArtPartCtrlV3;


class CIGI_SPEC CigiBaseShortArtPartCtrl : public CigiBasePacket
{

friend class CigiShortArtPartCtrlV3;

public:

   //=========================================================
   enum DofSelectGrp
   {
      NotUsed=0,
      Xoff=1,
      Yoff=2,
      Zoff=3,
      Yaw=4,
      Pitch=5,
      Roll=6
   };




   //==> Management

   //=========================================================
   CigiBaseShortArtPartCtrl();

   //=========================================================
   virtual ~CigiBaseShortArtPartCtrl();


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

   //=========================================================
        int SpecialConversion(CigiVersionID &CnvtVersion,
                         Cigi_uint8 ArtPartID,
                         CigiArtPartCtrlV3 *ArtPart);



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


   //+> ArtPart1

   //=========================================================
   int SetArtPart1(const Cigi_uint8 ArtPart1In, bool bndchk=true)
   {
      ArtPart1 = ArtPart1In;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint8 GetArtPart1(void) const { return(ArtPart1); }


   //+> ArtPart2

   //=========================================================
   int SetArtPart2(const Cigi_uint8 ArtPart2In, bool bndchk=true)
   {
      ArtPart2 = ArtPart2In;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint8 GetArtPart2(void) const { return(ArtPart2); }


   //+> DofSelect1

   //=========================================================
   int SetDofSelect1(const DofSelectGrp DofSelect1In, bool bndchk=true);

   //=========================================================
   DofSelectGrp GetDofSelect1(void) const { return(DofSelect1); }


   //+> DofSelect2

   //=========================================================
   int SetDofSelect2(const DofSelectGrp DofSelect2In, bool bndchk=true);

   //=========================================================
   DofSelectGrp GetDofSelect2(void) const { return(DofSelect2); }


   //+> ArtPart1En

   //=========================================================
   int SetArtPart1En(const bool ArtPart1EnIn, bool bndchk=true)
   {
      ArtPart1En = ArtPart1EnIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   bool GetArtPart1En(void) const { return(ArtPart1En); }


   //+> ArtPart2En

   //=========================================================
   int SetArtPart2En(const bool ArtPart2EnIn, bool bndchk=true)
   {
      ArtPart2En = ArtPart2EnIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   bool GetArtPart2En(void) const { return(ArtPart2En); }


   //+> Dof1

   //=========================================================
   int SetDof1(const float Dof1In, bool bndchk=true)
   {
      Dof1 = Dof1In;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetDof1(void) const { return(Dof1); }


   //+> Dof2

   //=========================================================
   int SetDof2(const float Dof2In, bool bndchk=true)
   {
      Dof2 = Dof2In;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetDof2(void) const { return(Dof2); }



protected:

   //==> Member variables

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

   //=========================================================
   Cigi_uint8 ArtPart1;

   //=========================================================
   Cigi_uint8 ArtPart2;

   //=========================================================
   DofSelectGrp DofSelect1;

   //=========================================================
   DofSelectGrp DofSelect2;

   //=========================================================
   bool ArtPart1En;

   //=========================================================
   bool ArtPart2En;

   //=========================================================
   float Dof1;

   //=========================================================
   float Dof2;


};

#endif // #if !defined(_CIGI_BASE_SHORT_ART_PART_CTRL_INCLUDED_)

---