CigiBasePositionReq.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_POSITION_REQ_INCLUDED_)
#define _CIGI_BASE_POSITION_REQ_INCLUDED_

#include "CigiBasePacket.h"

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

#define CIGI_POSITION_REQ_PACKET_ID_V3 27
#define CIGI_POSITION_REQ_PACKET_SIZE_V3 8


class CigiPositionReqV1;
class CigiPositionReqV2;
class CigiPositionReqV3;


class CIGI_SPEC CigiBasePositionReq : public CigiBasePacket
{

friend class CigiPositionReqV1;
friend class CigiPositionReqV2;
friend class CigiPositionReqV3;

public:

   //=========================================================
   enum UpdateModeGrp
   {
      OneShot=0,
      Continuous=1
   };

   //=========================================================
   enum ObjectClassGrp
   {
      Entity=0,
      ArtPart=1,
      View=2,
      ViewGrp=3,
      MotionTracker=4
   };

   //=========================================================
   enum CoordSysGrp
   {
      Geodetic=0,
      ParentEntity=1,
      Submodel=2
   };




   //==> Management

   //=========================================================
   CigiBasePositionReq();

   //=========================================================
   virtual ~CigiBasePositionReq();


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

   //+> ObjectID

   //=========================================================
   int SetObjectID(const Cigi_uint16 ObjectIDIn, bool bndchk=true)
   {
      ObjectID = ObjectIDIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint16 GetObjectID(void) const { return(ObjectID); }


   //+> ArtPartID

   //=========================================================
   int SetArtPartID(const Cigi_uint8 ArtPartIDIn, bool bndchk=true)
   {
      ArtPartID = ArtPartIDIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint8 GetArtPartID(void) const { return(ArtPartID); }


   //+> UpdateMode

   //=========================================================
   int SetUpdateMode(const UpdateModeGrp UpdateModeIn, bool bndchk=true);

   //=========================================================
   UpdateModeGrp GetUpdateMode(void) const { return(UpdateMode); }


   //+> ObjectClass

   //=========================================================
   int SetObjectClass(const ObjectClassGrp ObjectClassIn, bool bndchk=true);

   //=========================================================
   ObjectClassGrp GetObjectClass(void) const { return(ObjectClass); }


   //+> CoordSys

   //=========================================================
   int SetCoordSys(const CoordSysGrp CoordSysIn, bool bndchk=true);

   //=========================================================
   CoordSysGrp GetCoordSys(void) const { return(CoordSys); }



protected:

   //==> Member variables

   //=========================================================
   Cigi_uint16 ObjectID;

   //=========================================================
   Cigi_uint8 ArtPartID;

   //=========================================================
   UpdateModeGrp UpdateMode;

   //=========================================================
   ObjectClassGrp ObjectClass;

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


};

#endif // #if !defined(_CIGI_BASE_POSITION_REQ_INCLUDED_)

---