tdlContactMessageGeneratorController.h

Go to the documentation of this file.

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

#pragma once

#include "vrfmodel/vrfTDLMessageGeneratorController.h"
#include "vrfutil/sensorContactInfoList.h"


class DtTDLContactMessageGeneratorControllerPSR;
class DtTDLContactMessageGeneratorControllerDescriptor;
class DtVrfTDLMessage;
class DtVrfTDLRemoveMessage;
class DtVrfTDLContactMessage;
class DtRwStringList;
class DtSpotReport;
class DtRwSensorContactInfo;

class DT_DLL_vrfmodel DtTDLContactMessageGeneratorController : public DtVrfTDLMessageGeneratorController
{
protected:
   typedef std::map<DtUUID, DtSpotReport*> SpotReportStdMap;

private:
   DtTDLContactMessageGeneratorController();
   DtTDLContactMessageGeneratorController(const DtTDLContactMessageGeneratorController& orig);
   DtTDLContactMessageGeneratorController& operator=(const DtTDLContactMessageGeneratorController& orig);

public:

   DtTDLContactMessageGeneratorController(const DtString& name, DtVrfObject* owner, 
      DtSimManager* simManager, DtComponentDescriptor* desc=0, 
      DtReaderWriterRegistry *parentRegistry=0);

   virtual ~DtTDLContactMessageGeneratorController();

   virtual const char* type() const;

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

protected:
   virtual bool messageNeedsUpdate() const;

   virtual bool createPSR();

   virtual int tdlMessageType() const;

   virtual bool sendMessage();

   virtual bool checkNeedsOverlayLayerSend(const DtUUID&) const;
   virtual bool checkNeedsOverlayLayerSend(DtVrfObject* obj) const;

   virtual void sendRemovalMessage(const DtUUID&);

   virtual void updateOrCreateContactReportsForObjectsOnOverlayLayers(const SpotReportStdMap& currentReports, 
      const DtRwStringList& overlayLayers);

   virtual DtSpotReport* createContactReportFor(DtVrfObject*, int) const;

   virtual void updateContactReport(DtSpotReport*, DtVrfObject*) const;

   virtual void sendContactReport(DtSpotReport*);

   virtual bool needsContactReportHeartbeatUpdate(DtSpotReport*) const;

   virtual void sendRemoveAllContactReports();

   virtual bool isTypeAndForceForReport(const DtUUID& contact) const;
   virtual bool isTypeAndForceForReport(DtVrfObject* contactEntity) const;

   virtual void turnTDLMessagingOff();

   virtual DtString domainFromType(const DtEntityType&) const;

protected:
   DtTDLContactMessageGeneratorControllerDescriptor* myTDLContactDescriptor;
   DtSensorContactInfoListChangeMonitor myContactListMonitor;
   DtVrfTDLRemoveMessage* myRemovalMessage;
   DtVrfTDLContactMessage* myContactMessage;
};