spotReportGeneratorController.h

Go to the documentation of this file.

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


#pragma once

#include "vrfobjcore/controllerComponent.h"
#include "vrfobjcore/entityTargetInformation.h"
#include <list>
#include "vrfmodel/vrfmodelDefines.h"
#include "vrftasks/radioMessageTypes.h"
#include "vrftasks/spotReport.h"
#include "vrfutil/sensorContactInfoList.h"

class DtSpotReportGeneratorControllerDescriptor;
class DtSensorContactListInputPort;
class DtSimReport;
class DtObjectTypesListOutputPort;
class DtRwSensorContactInfo;
class DtSpotReportGeneratorControllerPSR;
class DtSimMessage;
class DtVrfObjectMessage;
class DtSettingsObject;
class DtBoolSetting;

class DT_DLL_vrfmodel DtSpotReportGeneratorController : public DtControllerComponent
{
private:
   DtSpotReportGeneratorController();
   DtSpotReportGeneratorController(const DtSpotReportGeneratorController& orig);
   DtSpotReportGeneratorController& operator=(
      const DtSpotReportGeneratorController& orig);
public:

   DtSpotReportGeneratorController(const DtString& name, DtLocalObject* owner, 
      DtSimulationServices* simManager, DtComponentDescriptor* desc=0, 
      DtReaderWriterRegistry *parentRegistry=0);

   virtual ~DtSpotReportGeneratorController();

   virtual bool init();

   virtual const char* type() const;

   virtual void tick();

   static void setSpotReportingCallback(DtSimMessage * msg, void * usr);

   virtual void processSetSpotReporting(DtSimMessage * msg);

   virtual void setLocalEnabled(bool on);

   virtual void setGlobalEnabledOverridingLocal();

   virtual void resendSpotReports(unsigned long requestId);

   static DtSimComponent * creator(const DtString& name, 
      DtLocalObject* owner,
      DtSimulationServices* simManager, 
      DtComponentDescriptor* desc = 0,
      DtReaderWriterRegistry* parentRegistry = 0);

protected:

   virtual void turnSpotReportingOn();
   virtual void turnSpotReportingOff();

   virtual bool createPorts();

   virtual bool createPSR();

   virtual void processObjectAboutToBeRemoved(const DtSimObject* object);

   virtual void registerRadioMessageCallbacks();

   virtual void sendDestroyedReports(unsigned long resendId, bool queueMissing = false);

   virtual DtSpotReport* createDestroyedReport(unsigned long resendId, const DtUUID& entity, bool& objectIsNoLongerDestroyed);

   virtual void generateAndSendSpotReports();

   virtual bool isTypeAndForceForReport(
      DtRwSensorContactInfo* contact);

   virtual DtSpotReport* createSpotReportForContact(
      const DtRwSensorContactInfo& contactInfo);

   virtual void updateSpotReportForContact(DtSpotReport& spotReport, 
      const DtRwSensorContactInfo& contact);

   virtual void sendSpotReport(DtSpotReport& spotReport, bool superiorOnly);

   std::vector<DtUUID> getSpotReportSuperiorPeers();

   virtual void sendSpotReports(const std::vector<DtSimReport*>& spotReports, bool superiorOnly);

   virtual void sendStopSpottingReports(const std::set<DtUUID>& stoppedSpotting);

   virtual bool spotReportNeedsUpdateAndResend(const DtSpotReport& spotRep,
      const DtRwSensorContactInfo& contact, DtSpotReport::Reason& reason) const;

   virtual double heartbeatDeltaFor(const DtSpotReport& spotRep,
      const DtRwSensorContactInfo& contact) const;

   virtual const DtSimReportMessageType& spotReportTypeString() const;

   virtual const DtSimReportMessageType& stopSpottingReportTypeString() const;

   static void settingConsumerCallback(const DtSettingsObject* settingsObject,
      void* usr);
   virtual void readGlobalEnabledSetting(const DtBoolSetting* enabledSetting);
   

   static void hostilitiesChangedCallback(DtU8 force, void* usr);
   virtual void processHostilitiesChanged(DtU8 force);

   virtual bool reportingEnabled() const;

   virtual bool checkSpotReportUpdateConditions(const DtSpotReport& spotRep,
      const DtRwSensorContactInfo& contact, DtSpotReport::Reason& reason) const;

   virtual bool checkDeltaDistanceConditions(const DtSpotReport& spotRep,
      const DtRwSensorContactInfo& contact) const;

   virtual bool checkDeltaHeartbeatConditions(const DtSpotReport& spotRep,
      const DtRwSensorContactInfo& contact) const;

   virtual bool entityHasUpdateRate(const DtRwSensorContactInfo& contactInfo) const;

   virtual void timedTick();

   virtual void processSimObjectAdded(DtSimObjectReference);

   static void requestSpotReportsCallback(DtSimMessage* msg, void* usr);
   virtual void processRequestSpotReports(DtSimMessage* msg);

   virtual void processSetRemoteSensorReceiver(DtSimMessage* msg);

   static void setRemoteSensorReceiverCallback(DtSimMessage* msg, void* usr);

protected:


   DtObjectTypesListOutputPort*  myTypesToDetectOutputPort;

   const DtSpotReportGeneratorControllerDescriptor* myDescriptor;

   DtSpotReportGeneratorControllerPSR* myProcessState;

   int myCurrentForceType; 
   DtSensorContactInfoListChangeMonitor myContactListMonitor;

   bool myHostilitiesChangeFlag;

   bool myGlobalEnabled;

   double myLastHeartbeatTime;

   bool myNeedsSpotReportFlush;

   typedef std::map<DtUUID, std::vector<unsigned long> > MissingDestroyedObjectsMap;
   MissingDestroyedObjectsMap myMissingDestroyedObjectsMap;

   typedef std::map<DtUUID, boost::signals2::connection> RemovalSignalsMap;
   RemovalSignalsMap myRemovalSignalsMap;

   boost::signals2::scoped_connection mySimObjectAddedConnection;
};