vrfTDLMessageManager.h

Go to the documentation of this file.

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


#pragma once

#include <vrfGuiCore/vrfGuiCore.h>
#include <vrvUtil/signalslib.h>
#include <vrfGuiCore/vrfTDLSettingsRecord.h>

#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrvUtil/DtUnicode.h>

#include <vlpi/entityType.h>

#include <boost/signals2.hpp>

class DtVrfTDLMessage;

namespace makVrv
{
   class DtDe;
   class DtRecordSettingsBackupInterface;
}

namespace makVrf
{
   class DtTDLGenericNetworkMessage;
   class DtExternalDataVisualHandlerCreatorInterface;

   class DT_DLL_VRFGUICORE DtVrfTDLMessageManager : public makVrv::DtVirtualBaseClass
   {
   public:
      DtVrfTDLMessageManager(makVrv::DtDe&);
      virtual ~DtVrfTDLMessageManager();

      static DtVrfTDLMessageManager& instance(makVrv::DtDe& de);

      static void registerInstance(makVrv::DtDe& de, DtVrfTDLMessageManager*);

      virtual void setProcessTDLMessages(bool);
      virtual bool processTDLMessages() const;

      virtual void loadDefaults(bool fromFactory = false);

      virtual void saveAsDefaults();

      virtual void addTranslatedDomain(const std::string&, const makVrv::DtUnicode&);
      virtual makVrv::DtUnicode domainTranslation(const std::string&) const;

      virtual void addDomain(const std::string&);
      virtual const std::map<std::string, bool>& domains() const;

      virtual void setEntityTypeForDomain(const std::string&, const DtEntityType&);
      virtual DtEntityType entityTypeForDomain(const std::string&) const;

      virtual void setShowDomain(const std::string&, bool);
      virtual bool domainShown(const std::string&) const;

      virtual void addTranslatedProtocol(const std::string&, const makVrv::DtUnicode&);
      virtual makVrv::DtUnicode protocolTranslation(const std::string&) const;

      virtual void addProtocol(const std::string&);
      virtual const std::map<std::string, bool>& protocols() const;

      virtual void setShowProtocol(const std::string&, bool);
      virtual bool protocolShown(const std::string&) const;

      virtual void setKeepReportsForTimePeriod(bool);
      virtual bool keepReportsForTimePeriod() const;

      virtual void setKeepReportsForTime(int);
      virtual int keepReportsForTime() const;

      const makVrv::DtRecordSettingsBackupInterface* settingsBackup() const
      {
         return mySettingsBackup;
      }

      makVrv::DtRecordSettingsBackupInterface* settingsBackup()
      {
         return mySettingsBackup;
      }

      virtual void getSplitRecord(std::vector<DtVrfTDLSettingsRecord>& rec,
         std::vector<std::string>& fileNames) {};

      virtual void addRecords(DtVrfTDLSettingsRecord& recs,
         DtVrfTDLSettingsRecord& combinedRec) {};

      virtual void setFromRecord(const DtVrfTDLSettingsRecord& rec, bool updateFilter = true);

      virtual void getRecord(DtVrfTDLSettingsRecord& rec) const;

      void exportSettings(const std::string& fileName);

      void importSettings(const std::string& fileName);

      virtual void setAutoSave(bool);
      virtual bool autoSave() const;

      virtual void addShowTDLMessagesForForce(int);
      virtual void removeShowTDLMessagesForForce(int);
      virtual void setShowTDLMessagesForForce(const std::set<int>&);
      virtual const std::set<int>& showTDLMessagesForForce() const;

      virtual bool showTDLMessagesForForce(int) const;

      virtual void setCanShowNumberOfSymbolDecorations(int);
      virtual int canShowNumberOfSymbolDecorations() const;

      virtual void setTimeout(int);
      virtual int timeout() const;

      virtual void setFlushDataRate(double);
      virtual double flushDataRate() const;

      virtual void setFilterTDLMessagesByForce(bool);

      virtual bool filterTDLMessagesByForce() const;

      virtual void addTDLMessageDataVisualHandler(const std::string& s, DtExternalDataVisualHandlerCreatorInterface*);

      virtual void removeTDLMessageDataVisualHandler(const std::string& s);

      virtual bool headingIndicatorEnabled() const;
      virtual void enableHeadingIndicator(bool b);

      virtual bool timeSinceLastReportEnabled() const;
      virtual void enableTimeSinceLastTeport(bool b);

      virtual bool tdlLineEnabled(int) const;
      virtual void enableTDLLine(int, bool b);

      virtual void setShowTrackHistories(bool);
      virtual bool showTrackHistories() const;

      virtual void setShowTrackHistoriesForSelected(bool);
      virtual bool showTrackHistoriesForSelected() const;

      virtual void setNumberOfTrackReports(int);
      virtual int numberOfTrackReports() const;

      boost::signals2::signal<void (const DtVrfTDLSettingsRecord&)> signal_tdlOptionsChanged;
      boost::signals2::signal<void (const DtVrfTDLSettingsRecord&)> signal_tdlForceOptionsChanged;
      boost::signals2::signal<void (const std::string&)> signal_protocolAdded;
      boost::signals2::signal<void (const std::string&, bool)> signal_protocolShown;

      boost::signals2::signal<void (const std::string&)> signal_domainAdded;
      boost::signals2::signal<void (const std::string&, bool)> signal_domainShown;

      boost::signals2::signal<void (bool)> signal_showTrackHistoryForSelectedItemsChanged;

      boost::signals2::signal<void (int)> signal_numberOfTrackReportsChanged;

      boost::signals2::signal<void (bool)> signal_keepReportsForTimePeriodChanged;

      boost::signals2::signal<void (int)> signal_keepReportsForTimeChanged;


   protected:

      virtual void slot_observerModeAdded(int);

      virtual void setTrackHistoriesVisible(bool);

      virtual void enableMessageProcessing();
      virtual void disableMessageProcessing();

      virtual void setup();

      virtual void slot_tdlMessageReceived(const DtTDLGenericNetworkMessage&);

      virtual void setupVariableTDLSymbolDecorations(int numDec);

   protected:
      makVrv::DtSignalConnectionManager myConnections;
      makVrv::DtSignalConnectionManager myTDLConnectionManager;
      makVrv::DtRecordSettingsBackupInterface* mySettingsBackup;
      DtVrfTDLSettingsRecord myTDLSettings;
      std::map<std::string, makVrv::DtUnicode> myTranslatedProtocols;
      std::map<std::string, makVrv::DtUnicode> myTranslatedDomains;
      std::map<std::string, DtEntityType> myEntityTypeForDomain;

      makVrv::DtDe& myDe;
   };
}