lgrSimInterface.h

Go to the documentation of this file.

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


#ifndef lgrSimInterface_H_
#define lgrSimInterface_H_

#include <lgrCore/lgrCore.h>
#include <lgrCore/lgrInterface.h>
#include <lgrCore/lgrEntityTracker.h>
#include <lgrUtil/signalSlot.h>
#include <lgrUtil/virtualConstructor.h>

#include <vlutil/vlString.h>
#include <vlutil/vlTime.h>
#include <list>

class DtExerciseConn;

namespace MAKLogger
{
   class DtLgrSimDriver;
   class DtLgrSimCommandFactory;
   class DtLgrPacketFilter;

   class DT_DLL_LGRCORE DtLgrSimInterface : public DtCommandInterface
   {
   public:

      typedef DtLgrSimCommandFactory Factory;

   public:

      DT_PURE_VIRTUAL_CTR(DtLgrSimInterface,(DtLogger&))

      
      DtLgrSimInterface(DtLogger&,const DtLgrSimDriver&);

   public:

      virtual ~DtLgrSimInterface();

      virtual DtLgrProtocolId protocolId() const = 0;

      virtual DtString protocolName() const;

      virtual void connect() const;

      virtual void connectToSharedExerciseConn(DtExerciseConn* exconn,
         bool allowDrainInput,bool allowSetSimTime,bool allowUnsubscribe) const;

      virtual void disconnect() const;

      virtual void getLoggerName(DtString& name) const = 0;

      virtual bool isConnected() const;

      virtual void setDumpFilename(const DtString&);

      virtual bool processRemoteControls() const;

      virtual bool recordRemoteControls() const;

      virtual bool allowAllRemoteControls() const;

      virtual bool allowRemoteDelete() const;

      virtual int remoteControlId() const;

      virtual bool sendResponses() const;

      virtual bool crippleGui() const;

      virtual bool useLegacyPdu() const;

      virtual DtTime connectSendInterval() const;

      virtual DtTime heartbeatSendInterval() const;

      virtual bool useBackChannel() const;

      virtual const DtString& backChannelAddress() const;

      virtual int backChannelPort() const;

      virtual const DtString& backChannelInterface() const;

      virtual void setRemoteControlSettings(bool process, bool record,
         bool allowDelete, bool allowAll, bool sendResponses, bool crippleGui, bool useLegacyPdu,
         DtTime connectSendInterval, DtTime heartbeatSendInterval) const;

      virtual void addFilteredEntityName(const DtString& name) const;

      virtual void clearFilteredEntityNames() const;

      virtual void addFilter(DtLgrPacketFilter*) const;

      virtual void setFilterSettings(const DtLgrPacketFilter*) const;

      virtual int filterCount() const;

      virtual int filterIndex( const DtLgrPacketFilter* filter ) const;

      virtual void setScaleAttributes(bool scale) const;

      virtual bool scaleAttributes() const;

      virtual bool networkActivity() const;

      virtual void setSaveConnectionConfiguration(bool saveConnectConfig) const;

      virtual bool saveConnectConfiguration() const;

      virtual void setSaveIndexConfiguration(bool saveIndexConfig) const;

      virtual bool saveIndexConfiguration() const;

      virtual void setSaveProtocolConfiguration(bool saveProtocolConfig) const;

      virtual bool saveProtocolConfiguration() const;

      virtual void setListenWhenIdle(bool listen) const;

      virtual bool listenWhenIdle() const;

      virtual bool staticDROnPause() const;

      virtual void setStaticDROnPause(bool staticDRAlgorithm) const;


      DtLgrPacketFilter* filter(int index);
      const DtLgrPacketFilter* filter(int index) const;

      virtual const DtLgrEntityTracker* entityTracker() const;

      virtual void addTemporaryTrackedEntity(const DtString& name) const;

      virtual bool connectionSettingsMatchInputFile( DtString& filename);

      virtual void useRecommendedSettings();

      typedef int EntityTrackerUpdateId;
      virtual EntityTrackerUpdateId entityTrackerUpdateId() const;

   public:

      DtValueSignal<int> filterCountChangedSignal;

      DtValueSignal<bool> connectedStatusChangedSignal;

      DtValueSignal<bool> unableToConnectSignal;

      DtValueSignal<bool> activityChangedSignal;

      DtValueSignal<bool> crippleGuiChangedSignal;

   protected:

      void connectResponseHandlers();

      virtual void connectResponseHandler(DtLgrCommandId,
         void (DtLgrSimInterface::*)(DtResponse));


      void updatedEntityTracker(DtResponse response);
      void connected(DtResponse);
      void disconnected(DtResponse);
      void unableToConnect(DtResponse);
      void lostConnection(DtResponse);
      void filterAdded(DtResponse);
      void filterRemoved(DtResponse);
      void filterModified(DtResponse);
      void remoteControlsChanged(DtResponse);
      void activityChanged(DtResponse);
      void scaleAttributesChanged(DtResponse);
      void remoteControlIdChanged(DtResponse);
      void backChannelConnectionChanged(DtResponse);
      void saveConnectConfigurationChanged(DtResponse response);
      void saveIndexConfigurationChanged(DtResponse response);
      void saveProtocolConfigurationChanged(DtResponse response);
      void listenWhenIdleChanged(DtResponse response);
      void staticDROnPauseChanged(DtResponse response);


   protected:
      bool myConnectedFlag;
      bool myFailedConnectFlag;
      bool myActivityFlag;
      bool myProcessRemoteControls;
      bool myRecordRemoteControls;
      bool myAllowAllRemoteControls;
      bool myAllowRemoteDelete;
      bool mySendResponses;
      bool myCrippleGui;
      bool myUseLegacyPdu;
      bool myUseBackChannel;
      bool mySaveConnectConfiguration;
      bool mySaveIndexConfiguration;
      bool mySaveProtocolConfiguration;
      bool myListenWhenIdle;
      bool myStaticDROnPause;
      DtString myBackChannelAddress;
      DtString myBackChannelInterface;
      int myBackChannelPort;
      DtTime myConnectSendInterval;
      DtTime myHeartbeatSendInterval;

      bool myScaleAttributes;
      int  myFilterCount;
      DtString myDumpFilename;
      typedef std::list<DtLgrPacketFilter*> FilterTypeList;
      FilterTypeList myFilterList;
      DtLgrEntityTracker* myEntityTracker;
      int myEntityTrackerUpdateId;
      int myRemoteControlId;
   };

}

#endif