CigiBaseCollDetSegDef.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_COLL_DET_SEG_DEF_INCLUDED_)
#define _CIGI_BASE_COLL_DET_SEG_DEF_INCLUDED_

#include "CigiBasePacket.h"

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

#define CIGI_COLL_DET_SEG_DEF_PACKET_ID_V1 24
#define CIGI_COLL_DET_SEG_DEF_PACKET_SIZE_V1 24

#define CIGI_COLL_DET_SEG_DEF_PACKET_ID_V2 24
#define CIGI_COLL_DET_SEG_DEF_PACKET_SIZE_V2 24

#define CIGI_COLL_DET_SEG_DEF_PACKET_ID_V3 22
#define CIGI_COLL_DET_SEG_DEF_PACKET_SIZE_V3 40


class CigiCollDetSegDefV1;
class CigiCollDetSegDefV2;
class CigiCollDetSegDefV3;


class CIGI_SPEC CigiBaseCollDetSegDef : public CigiBasePacket
{

friend class CigiCollDetSegDefV1;
friend class CigiCollDetSegDefV2;
friend class CigiCollDetSegDefV3;

public:

   //==> Management

   //=========================================================
   CigiBaseCollDetSegDef() { };

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


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

      // Note: V1 & V2 are the same
      if(CnvtVersion.CigiMajorVersion < 3)
         CnvtInfo.CnvtPacketID = CIGI_COLL_DET_SEG_DEF_PACKET_ID_V2;
      else
         CnvtInfo.CnvtPacketID = CIGI_COLL_DET_SEG_DEF_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); }


   //+> SegmentEn

   //=========================================================
   int SetSegmentEn(const bool SegmentEnIn, bool bndchk=true)
   {
      SegmentEn = SegmentEnIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   bool GetSegmentEn(void) const { return(SegmentEn); }


   //+> X1

   //=========================================================
   int SetX1(const float X1In, bool bndchk=true)
   {
      X1 = X1In;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetX1(void) const { return(X1); }


   //+> Y1

   //=========================================================
   int SetY1(const float Y1In, bool bndchk=true)
   {
      Y1 = Y1In;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetY1(void) const { return(Y1); }


   //+> Z1

   //=========================================================
   int SetZ1(const float Z1In, bool bndchk=true)
   {
      Z1 = Z1In;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetZ1(void) const { return(Z1); }


   //+> X2

   //=========================================================
   int SetX2(const float X2In, bool bndchk=true)
   {
      X2 = X2In;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetX2(void) const { return(X2); }


   //+> Y2

   //=========================================================
   int SetY2(const float Y2In, bool bndchk=true)
   {
      Y2 = Y2In;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetY2(void) const { return(Y2); }


   //+> Z2

   //=========================================================
   int SetZ2(const float Z2In, bool bndchk=true)
   {
      Z2 = Z2In;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetZ2(void) const { return(Z2); }


   //+> Mask

   //=========================================================
   int SetMask(const Cigi_uint32 MaskIn, bool bndchk=true)
   {
      Mask = MaskIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint32 GetMask(void) const { return(Mask); }



protected:

   //==> Member variables

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

   //=========================================================
   Cigi_uint8 SegmentID;

   //=========================================================
   bool SegmentEn;

   //=========================================================
   float X1;

   //=========================================================
   float Y1;

   //=========================================================
   float Z1;

   //=========================================================
   float X2;

   //=========================================================
   float Y2;

   //=========================================================
   float Z2;

   //=========================================================
   Cigi_uint32 Mask;


};

#endif // #if !defined(_CIGI_BASE_COLL_DET_SEG_DEF_INCLUDED_)

---