objectSensorDescriptor.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2014 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/



#pragma once

#include "vrfobjparam/vrfobjparamDefines.h"
#include "vrfobjparam/componentDescriptor.h"
#include <readerWriter/rwReal.h>
#include <readerWriter/rwBoolean.h>
#include "vrfutil/nLengthIntegerVector.h"
#include "vrfutil/rwObjectTypeList.h"
#include "vrfutil/rwSpatialFilterContainer.h"
#include "readerWriter/rwVector.h"
#include "readerWriter/rwInt.h"


class DT_DLL_vrfobjparam DtObjectSensorDescriptor : public DtComponentDescriptor
{
private:
   DtObjectSensorDescriptor();

public:
   DtObjectSensorDescriptor(const DtString& name, 
      DtReaderWriterRegistry * parentRegistry = 0);
   
   DtObjectSensorDescriptor(const DtObjectSensorDescriptor & 
      orig, DtReaderWriterRegistry * parentRegistry = 0);
   
   DtObjectSensorDescriptor & operator=(const 
      DtObjectSensorDescriptor & orig);
   
   virtual ~DtObjectSensorDescriptor();

   virtual DtString type() const;


   virtual bool detectOnlyHostileForces() const;
   virtual void setDetectOnlyHostileForces(bool value);


   virtual bool detectOwnForce() const;
   virtual void setDetectOwnForce(bool v);


   virtual void setDetectionTypes(const DtRwObjectTypeList& objectTypes);
   virtual DtRwObjectTypeList& detectionTypes();
   virtual const DtRwObjectTypeList& detectionTypes() const;


   virtual void setDetectDestroyedObjects(bool value);
   virtual bool detectDestroyedObjects() const;

   virtual DtReal detectionPeriod() const;
   virtual void setDetectionPeriod(DtReal detectionPeriod);

   virtual DtReal detectionPeriodVariance() const;
   virtual void setDetectionPeriodVariance(DtReal detectionPeriodVariance);


   virtual void setAddSensorRangeRing(bool value);
   virtual bool addSensorRangeRing() const;


   virtual void setWindDegradesSensorPerformanceWhenAbove(double);
   virtual double windDegradesSensorPerformanceWhenAbove() const;


   virtual void setWindDegradesSensorPerformanceUntil(double);
   virtual double windDegradesSensorPerformanceUntil() const;


   virtual void setWindDegradesSensorPerformanceBy(double);
   virtual double windDegradesSensorPerformanceBy() const;


   virtual void setPrecipitationDegradesSensorPerformanceBy(double);
   virtual double precipitationDegradesSensorPerformanceBy() const;


   virtual void setSuppressionDegradesSensorPerformanceBy(double);

   virtual double suppressionDegradesSensorPerformanceBy() const;


   virtual void setZoomEnhancesSensitivity(bool v);
   virtual bool zoomEnhancesSensitivity() const;


   virtual DtRwSpatialFilterContainer* sensorGeometry();
   virtual const DtRwSpatialFilterContainer* sensorGeometry() const;

   virtual bool canShowRadarCoverage() const;
   virtual void setCanShowRadarCoverage(bool);

   virtual double radarCoverageAzimuthSamplingRate() const;
   virtual void setRadarCoverageAzimuthSamplingRate(double);

   virtual double radarCoverageElevationSamplingRate() const;
   virtual void setRadarCoverageElevationSamplingRate(double);

   virtual double radarCoveragePostSpacing() const;
   virtual void setRadarCoveragePostSpacing(double);

   virtual double radarCoverageMovementDelta() const;
   virtual void setRadarCoverageMovementDelta(double);

   virtual double radarCoverageOrientationDelta() const;
   virtual void setRadarCoverageOrientationDelta(double);

   virtual double radarCoverageWaitTime() const;
   virtual void setRadarCoverageWaitTime(double);

   virtual double radarCoverageHighResolutionRadius() const;
   virtual void setRadarCoverageHighResolutionRadius(double radius);

   virtual const DtVector& sensorOffset() const;
   virtual void setSensorOffset(const DtVector& sensorOffset);

   virtual int rangeId() const;
   virtual void setRangeId(int rangeId);
   virtual bool rangeIdIsSpecified() const;


   virtual void setAdditionalDetectionTypes(const DtRwObjectTypeList & objectTypes);
   virtual DtRwObjectTypeList& additionalDetectionTypes();
   virtual const DtRwObjectTypeList& additionalDetectionTypes() const;


   virtual int sensorTickTime() const;
   virtual void setSensorTickTime(int ms);


   virtual int tickOverrunStrategy() const;
   virtual void setTickOverrunStrategy(int s);

   virtual DtComponentDescriptor * clone(DtReaderWriterRegistry * parentRegistry
       = 0) const;

   static DtComponentDescriptor * creator();

   virtual void getSelf(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
      const DtVariableBindingsList& variableBindings);

protected:

   DtRwBoolean                 myDetectOnlyHostileForces;

   DtRwBoolean                 myDetectOwnForce;

   DtRwObjectTypeList          myDetectionTypes;

   DtRwObjectTypeList          myAdditionalDetectionTypes;

   DtRwBoolean                 myDetectDestroyedObjects;

   DtRwReal myDetectionPeriod;

   DtRwReal myDetectionPeriodVariance;

   DtRwBoolean                 myAddSensorRangeRing;

   DtRwReal myWindDegradesSensorPerformanceWhenAbove;

   DtRwReal myWindDegradesSensorPerformanceUntil;

   DtRwReal myWindDegradesSensorPerformanceBy;

   DtRwReal myPrecipitationDegradesSensorPerformanceBy;

   DtRwReal mySuppressionDegradesSensorPerformanceBy;

   DtRwBoolean myZoomEnhancesSensitivity;

   DtRwSpatialFilterContainer  mySensorGeometry;

   DtRwBoolean   myCanShowRadarCoverage;

   DtRwReal myRadarCoverageAzimuthSamplingRate;

   DtRwReal myRadarCoverageElevationSamplingRate;

   DtRwReal myRadarCoveragePostSpacing;

   DtRwReal myRadarCoverageMovementDelta;

   DtRwReal myRadarCoverageOrientationDelta;

   DtRwReal myRadarCoverageWaitTime;

   DtRwReal myRadarCoverageHighResolutionRadius;

   DtRwOffsetVector           mySensorOffset;

   DtRwInt          myRangeId;

   DtRwInt mySensorTickTime;

   DtRwInt myTickOverrunStrategy;
};