spotReportGeneratorControllerDescriptor.h

Go to the documentation of this file.

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



#pragma once

#include "vrfobjparam/componentDescriptor.h"
#include "vrfutil/rwReal.h"
#include "vrfutil/rwBoolean.h"
#include "vrfutil/rwObjectTypeList.h"
#include "vrfutil/rwSpotReportDeltaCheckList.h"

#include "vrfobjparam/vrfobjparamDefines.h"
class DT_DLL_vrfobjparam DtSpotReportGeneratorControllerDescriptor : public DtComponentDescriptor
{
public:
   DtSpotReportGeneratorControllerDescriptor(
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0);

   DtSpotReportGeneratorControllerDescriptor(
      const DtSpotReportGeneratorControllerDescriptor& orig,
      DtReaderWriterRegistry*  parentRegistry = 0);

   DtSpotReportGeneratorControllerDescriptor& operator=(
      const DtSpotReportGeneratorControllerDescriptor& orig);

   virtual ~DtSpotReportGeneratorControllerDescriptor();

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

   virtual DtString type() const;

   static DtComponentDescriptor* creator();

   virtual bool forwardSubordinateReports() const;
   virtual void setForwardSubordinateReports(const bool& newValue);

   virtual const DtRwSpotReportDeltaCheckList& spotReportMovementDeltaCheckList() const;
   virtual void setSpotReportMovementDeltaCheckList(const DtRwSpotReportDeltaCheckList & list);

   virtual const DtRwSpotReportDeltaCheckList& spotReportHeartbeatDeltaCheckList() const;
   virtual void setSpotReportHeartbeatDeltaCheckList(const DtRwSpotReportDeltaCheckList & list);

   virtual const DtRwObjectTypeList & objTypesToSpot() const;
   virtual void setObjTypesToSpot(const DtRwObjectTypeList & list);

   virtual bool reportOnOwnForce() const;
   virtual void setReportOnOwnForce(bool newVal);


   virtual bool reportOnHostileForces() const;
   virtual void setReportOnHostileForces(bool newVal);


   virtual bool sendSpotReportsOnScenarioLoad() const;
   virtual void setSendSpotReportsOnScenarioLoad(bool newVal);


   virtual bool sendOnlyOnDataChange() const;
   virtual void setSendOnlyOnDataChange(bool newVal);


   virtual bool sendToFrontEndOnly() const;
   virtual void setSendToFrontEndOnly(bool newVal);


   virtual bool reportOnNeutralForces() const;
   virtual void setReportOnNeutralForces(bool newVal);


   virtual bool onlyOneDestroyedReport() const;
   virtual void setOnlyOneDestroyedReport(bool newVal);


   virtual bool broadcast() const;
   virtual void setBroadcast(bool newVal);

   virtual double reportResendPeriod() const;
   virtual void setReportResendPeriod(const double& newValue);


   virtual DtString radioName() const;
   virtual void setRadioName(const DtString& name);

   static const DtString theDefaultRadioName;

protected:
   
   DtRwBoolean myForwardSubordinateReports;

   DtRwReal myReportResendPeriod;

   DtRwObjectTypeList myObjTypesToSpot;

   DtRwBoolean mySendReportsOnOwnForce;

   DtRwBoolean mySendReportsOnHostileForces;

   DtRwBoolean mySendReportsOnNeutralForces;

   DtRwBoolean myBroadcast;

   DtRwString myRadioName;

   DtRwSpotReportDeltaCheckList mySpotReportMovementDeltaCheckList;

   DtRwSpotReportDeltaCheckList mySpotReportHeartbeatDeltaCheckList;

   DtRwBoolean mySendSpotReportsOnScenarioLoad;

   DtRwBoolean mySendToFrontEndOnly;

   DtRwBoolean myOnlyOneDestroyedReport;

   DtRwBoolean mySendOnlyOnDataChange;
};