minefieldQueryPdu.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1992-2025 MAK Technologies, Inc
** All rights reserved.
*********************************************************************/


#pragma once

#if DtDIS

#include <vlutil/vlMachineTypes.h>
#include "hostStructs.h"
#include "interactionDIS.h"
#include "exerciseConn.h"

#include "packets/mineQueryP.h"

#include "minefieldPerimeterRecord.h"


class DT_DLL_VL DtMinefieldQueryPdu;

typedef void (*DtMinefieldQueryPduCb)(DtMinefieldQueryPdu* pdu, void* usr);


class DT_DLL_VL DtMinefieldQueryPdu : public DtInteraction
{

public:

   DtMinefieldQueryPdu(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
   DtMinefieldQueryPdu(const DtNetMinefieldQueryPdu* initial,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER, DtPduFactory* pduFactory = 0);
   DtMinefieldQueryPdu(const DtMinefieldQueryPdu& orig);

   virtual ~DtMinefieldQueryPdu();

   DtMinefieldQueryPdu& operator=(const DtMinefieldQueryPdu& orig);

   virtual void setMinefieldID(const DtEntityIdentifier& id);
   virtual const DtEntityIdentifier& minefieldID() const;

   virtual void setRequestingEntityID(const DtEntityIdentifier& id);
   virtual const DtEntityIdentifier& requestingEntityID() const;

   virtual void setRequestID(DtU8 id);
   virtual DtU8 requestID() const;

   virtual bool setNumPerimeterPoints(DtU8 num);
   virtual DtU8 numPerimeterPoints() const;

   virtual bool setNumSensorTypes(DtU8 num);
   virtual DtU8 numSensorTypes() const;

   virtual void setDataFilter(DtU32 value);
   virtual DtU32 dataFilter() const;

   virtual void setDataFilterField(
      DtMinefieldDataFilterField field, bool value);
   virtual bool getDataFilterField(DtMinefieldDataFilterField field);

   virtual void setRequestedMineType(const DtEntityType& type);
   virtual const DtEntityType& requestedMineType() const;

   virtual bool setPerimeterPoint(int index,
      const DtMinefieldPerimeterRecord& init);
   virtual bool getPerimeterPoint(int index,
      DtMinefieldPerimeterRecord& record) const;

   virtual bool getSensorTypeCategory(int index,
      DtSensorTypeCategory& value);

   virtual bool setSensorTypeSubcategory(int index,
      DtOpticalSensorTypeSubcategory value);
   virtual bool setSensorTypeSubcategory(int index,
      DtFLIR_SensorTypeSubcategory value);
   virtual bool setSensorTypeSubcategory(int index,
      DtRADAR_SensorTypeSubcategory value);
   virtual bool setSensorTypeSubcategory(int index,
      DtMagneticSensorTypeSubcategory value);
   virtual bool setSensorTypeSubcategory(int index,
      DtLaserSensorTypeSubcategory value);
   virtual bool setSensorTypeSubcategory(int index,
      DtSONARSensorTypeSubcategory value);
   virtual bool setSensorTypeSubcategory(int index,
      DtPhysicalSensorTypeSubcategory value);
   virtual bool setSensorTypeSubcategory(int index,
      DtMultispectralSensorTypeSubcategory value);

   virtual bool getSensorTypeSubcategory(int index,
      DtOpticalSensorTypeSubcategory& value);
   virtual bool getSensorTypeSubcategory(int index,
      DtFLIR_SensorTypeSubcategory& value);
   virtual bool getSensorTypeSubcategory(int index,
      DtRADAR_SensorTypeSubcategory& value);
   virtual bool getSensorTypeSubcategory(int index,
      DtMagneticSensorTypeSubcategory& value);
   virtual bool getSensorTypeSubcategory(int index,
      DtLaserSensorTypeSubcategory& value);
   virtual bool getSensorTypeSubcategory(int index,
      DtSONARSensorTypeSubcategory& value);
   virtual bool getSensorTypeSubcategory(int index,
      DtPhysicalSensorTypeSubcategory& value);
   virtual bool getSensorTypeSubcategory(int index,
      DtMultispectralSensorTypeSubcategory& value);

   virtual void printData() const;

   virtual void printDataToStream(std::ostream &stream) const;

public:

   static DtPdu* create(const DtNetPacket* initial,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER, DtPduFactory* pduFactory = 0);

   static void addCallback(DtExerciseConn* conn,
      DtMinefieldQueryPduCb cb, void* usr);
   static void removeCallback(DtExerciseConn* conn,
      DtMinefieldQueryPduCb cb, void* usr);

protected:

   virtual DtPduKind internalGetPduKind() const;

   virtual DtNetMinefieldQueryPdu* netPduStruct()  const; 

   DtMinefieldQueryPdu* self() const; 

   virtual char* var() const;

   virtual int perimeterPointRecordOffset(int recordIndex) const;

   virtual int sensorTypeRecordOffset(int recordIndex) const;

   virtual void setSensorType(int index, DtU16 value);
   virtual DtU16 sensorType(int index) const;

protected:

   static const int theStaticSize;

protected:

   DtEntityIdentifier myEntityID;
   DtEntityType myEntityType;
   DtMinefieldPerimeterRecord myPerimeterRecord;

};

#endif