lgrSimDriver.h

Go to the documentation of this file.

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


#pragma once

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

class DtExerciseConnInitializer;

namespace MAKLogger
{
   class DtLgrSimCommandFactory;
   class DtLgrSimInterface;
   class DtLgrSimManager;
   class DtLgrSystemDriver;
   class DtLgrPacketFilter;
   class DtLgrEntityIdFilter;
   class DtLgrMarkingFilter;
   class DtLgrVRFMessageFilter;
   class DtMessagePipeline;
   class DtLgrPlaybackDriver;
   class DtLgrRecordDriver;

   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 releasePipeline();

      bool getPipeline();

      bool hasPipeline() const;

      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 DtLgrSystemDriver* systemDriver();
      virtual const DtLgrSystemDriver* systemDriver() const;

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

      virtual DtLgrPlaybackDriver* getPlaybackDriver(bool checkForFileOpen) const;

      virtual DtLgrRecordDriver* getRecordDriver(bool checkForFileOpen) const;

      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 bool useLegacyPdu() const;

      virtual bool saveConnectConfiguration() const;

      virtual bool saveIndexConfiguration() const;

      virtual bool saveProtocolConfiguration() const;

      virtual bool listenWhenIdle() const;

      virtual bool staticDRAlgorithmWhenPaused() const;

      virtual void activateIdleListening();

      virtual bool isSimTimeAdjusted() const;

      virtual DtTime connectSendInterval() const;

      virtual DtTime heartbeatSendInterval() const;

      virtual bool useSimChannel() const;

      virtual bool useBackChannel() const;

      virtual const DtString& backChannelAddress() const;

      virtual int backChannelPort() const;

      virtual const DtString& backChannelInterface() 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);

      virtual void addTemporaryTrackedMarking(const DtString& marking);

   protected:

      virtual void setActivity(bool activity);

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

      virtual void configureConnectionInitalizer(DtExerciseConnInitializer& connInitializer) = 0;


      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 setSaveConnectConfiguration(const DtCommand& command);
      virtual DtResponse setSaveIndexConfiguration(const DtCommand& command);
      virtual DtResponse setSaveProtocolConfiguration(const DtCommand& command);
      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 setPlaybackFilesUseRandomAccess(const DtCommand& command);
      virtual DtResponse setExtendedStopTimeoutInterval(const DtCommand& command);
      virtual DtResponse setListenWhenIdle(const DtCommand& command);
      virtual DtResponse setAdjustSimTime(const DtCommand& command);
      virtual DtResponse setStaticDRAlgorithmWhenPaused(const DtCommand& command);
      virtual DtResponse filterMarkings(const DtCommand& command);

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



   protected:

      bool myUseSimChannel;
      bool myUseBackChannel;
      bool myRecordRemoteControls;
      bool myAllowAllRemoteControls;
      bool myAllowRemoteDelete;
      bool mySendResponses;
      bool myCrippleGui;
      bool myUseLegacyPdu;
      bool mySaveConnectConfiguration;
      bool mySaveIndexConfiguration;
      bool mySaveProtocolConfiguration;
      DtString myBackChannelAddress;
      DtString myBackChannelInterface;
      int myBackChannelPort;
      DtTime myConnectSendInterval;
      DtTime myHeartbeatSendInterval;
      bool myActivity;
      DtLgrVRFMessageFilter* myVRFMessageFilter;
      DtLgrEntityIdFilter* myEntityIdFilter;
      DtLgrMarkingFilter* myMarkingFilter;
      DtLgrSystemDriver* myDriver;
      DtMessagePipeline* myPipeline;

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

}