lgrSimDriver.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 1992-2010 VT MAK
** All rights reserved.
******************************************************************************/


#ifndef lgrSimDriver_H_
#define lgrSimDriver_H_

#include "lgrCore.h"
#include "lgrDriver.h"
#include "lgrEntityTracker.h"
#include <map>
#include <vlutil/vlTime.h>

namespace MAKLogger
{
   class DtLgrSimCommandFactory;
   class DtLgrSimInterface;
   class DtLgrSimManager;
   class DtLgrSystemDriver;
   class DtLgrPacketFilter;
   class DtLgrEntityIdFilter;
   class DtLgrVRFMessageFilter;

   class DT_DLL_LGRCORE DtLgrSimDriver : public DtLgrCommandHandler
   {
   public:
      typedef DtLgrSimCommandFactory Factory;
      typedef DtLgrSimInterface Interface;

      typedef std::pair<double, bool> HeartbeatTimeRecord;

      static DtLgrSimDriver* getFromLogger(const DtLogger& logger);

      DtLgrSimDriver(DtLgrSystemDriver& systemDriver);

      virtual ~DtLgrSimDriver();

      virtual void tick();

      virtual bool isConnected() const = 0;

      virtual void addPacketFilter(DtLgrPacketFilter* filter);

      virtual void removeFilter(const DtLgrPacketFilter* filter);

      virtual bool activity() const;

      virtual int filterCount() const;

      virtual const DtLgrPacketFilter* filter(int index) const;


      virtual DtLgrSimManager* simManager() = 0;
      virtual const DtLgrSimManager* simManager() const = 0;

      virtual bool processRemoteControls() const;

      virtual bool recordRemoteControls() const;

      virtual bool allowAllRemoteControls() const;

      virtual bool allowRemoteDelete() const;

      virtual bool sendResponses() const;

      virtual bool crippleGui() const;

      virtual DtTime connectSendInterval() const;

      virtual DtTime heartbeatSendInterval() const;

      virtual bool scaleAttributes() const;

      virtual const std::map<DtString, DtLgrSimDriver::HeartbeatTimeRecord>& heartbeatIntervals() const;

      virtual const std::map<DtString, DtLgrSimDriver::HeartbeatTimeRecord>& timeoutIntervals() const;

      virtual void updateEntityTracker(const DtString& tracker);

      virtual DtLgrEntityTracker* entityTracker();

      virtual void addTemporaryTrackedEntity(const DtString& name);

   protected:

      virtual void setActivity(bool activity);

      virtual void setVRFMessageFiltering(bool filter,int lowId,int hiId);



      virtual DtResponse addFilter(const DtCommand& command);
      virtual DtResponse connect(const DtCommand& command) = 0;
      virtual DtResponse connectShared(const DtCommand& command) = 0;
      virtual DtResponse disconnect(const DtCommand& command) = 0;
      virtual DtResponse setFilterSettings(const DtCommand& command);
      virtual DtResponse setScaleAttributes(const DtCommand& command);
      virtual DtResponse setVRFFiltering(const DtCommand& command);
      virtual DtResponse addFilteredEntityName(const DtCommand& command);
      virtual DtResponse clearFilteredEntityNames(const DtCommand& command);
      virtual DtResponse setHeartbeatIntervals(const DtCommand& command);
      virtual DtResponse setTimeoutIntervals(const DtCommand& command);
      virtual DtResponse addTemporaryTrackedEntity(const DtCommand& command);

      virtual DtResponse setRemoteControlSettings(const DtCommand& command);
      virtual DtResponse setRemoteControlId(const DtCommand& command);

   protected:

      bool myProcessRemoteControls;
      bool myRecordRemoteControls;
      bool myAllowAllRemoteControls;
      bool myAllowRemoteDelete;
      bool mySendResponses;
      bool myCrippleGui;
      DtTime myConnectSendInterval;
      DtTime myHeartbeatSendInterval;
      bool myActivity;
      DtLgrVRFMessageFilter* myVRFMessageFilter;
      DtLgrEntityIdFilter* myEntityIdFilter;
      DtLgrSystemDriver* myDriver;

      DtLgrEntityTracker::TrackerUpdateId myLastEntityTrackerUpdate;
      DtTime myLastEntityTrackerUpdateTime;
      DtClock myTrackerUpdateClock;
   };

}

#endif