federateTree.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2017 VT MAK
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include "rtiMsConfig.h"
#include "federationInfo.h"
#include <QTreeWidget>
#include <vlutil/vlString.h>
#include <vlutil/vlTime.h>
#include <vector>
#include <map>
#include <set>

class DtAssistantForwarderInfo;

class DT_DLL_ASSISTANTAPP DtFederateTree : public QTreeWidget
{  Q_OBJECT;
public:

   DtFederateTree( QWidget* parent );

   virtual ~DtFederateTree();

public:

   virtual QSize sizeHint() const;

   virtual void hideEvent( QHideEvent* event );

   virtual bool updateFederation( const DtAssistantFederationInfo* federation,
      const DtAssistantForwarderInfo* forwarderInfo,
      const std::vector<DtAssistantForwarderInfo>& peerInfos);

   virtual bool removeFederation( const QString& name );

   virtual void removeAllFederations();

   virtual void updateFederationColor( const MAKRti::DtString& federationName, const QColor& color );

   virtual bool updateFederate( const DtAssistantFederateInfo& federate,
      const DtAssistantForwarderInfo* forwarderInfo,
      const QString& fedexName,
      const std::vector<DtAssistantForwarderInfo>& peerInfos);

   virtual bool removeFederate( int federateHandle, const QString& fedexName,
      bool clearedDefunct = false );

   virtual void displayLoadingIndication();

   virtual void removeLoadingIndication();

   bool isFederateValid( int federateHandle, const QString& fedexName ) const;

   void processInvalidList();

   QMenu* columnViewMenu() { return myColViewMenu; };

   QMenu* federateMenu() { return myFederateMenu; };


   QAction* statisticsAction() { return myStatisticsAction; }
   QAction* latencyTestAction() { return myLatencyTestAction; }
   QAction* federateRidParamAction() { return myFederateRidParametersAction; }
   QAction* federateFomAction() { return myFederateFomAction; }
   QAction* federateLogAction() { return myFederateLogAction; }
   QAction* changeFederateIconAction() { return myChangeFederateIconAction; }
   QAction* resignFederateAction() { return myResignFederateAction; }


   QMenu* federationMenu() { return myFederationMenu; };


   QAction* federationFomAction() { return myFederationFomAction; }
   QAction* syncPointsAction() { return myDisplaySyncPointsAction; }
   QAction* destroyFederationAction() { return myDestroyFederationAction; }


   void setFederateRemovalTime( float newTime );

   float getFederateRemovalTime() const;

   void enableDeletion( bool enable );

   QString getTreeFederationName( const MAKRti::DtString& federationName );

   void forceFederateSelection( int federateHandle, const MAKRti::DtString& federation );

   void forceFederationSelection( const MAKRti::DtString& federation );

   void forceClearSelection();

   void saveGuiConfiguration( const MAKRti::DtFilename& configFile );

   void loadGuiConfiguration( const MAKRti::DtFilename& configFile );

   void initializeQtToolTips();

private:

   void clearDefunctFederate(QString fedexName, QTreeWidgetItem* federate);

   bool isFederateDefunct(QTreeWidgetItem* federate);

protected:

   virtual void updateFederateItems( const DtFederateInfoByHandleMap& federates,
      const DtAssistantForwarderInfo* forwarderInfo,
      QTreeWidgetItem* fedexItem,
      const std::vector<DtAssistantForwarderInfo>& peerInfos);

   virtual void updateFederateItem( const DtAssistantFederateInfo& federate,
      const DtAssistantForwarderInfo* forwarderInfo,
      const QString& fedexName, QTreeWidgetItem* fedItem,
      const std::vector<DtAssistantForwarderInfo>& peerInfos);

   virtual void updateFederateItemFromForwarderInformation(
      const DtAssistantFederateInfo& federate,
      const DtAssistantForwarderInfo* forwarderInfo,
      const QString& fedexName, QTreeWidgetItem* fedItem,
      const std::vector<DtAssistantForwarderInfo>& peerInfos);


   virtual void removeAllFederateItems( QTreeWidgetItem* fedexItem );

   virtual void removeFederateItem( QTreeWidgetItem* fedItem,
      QTreeWidgetItem* fedexItem, bool clearedDefunct = false );

   bool isFederateValid( QTreeWidgetItem* item ) const;

   bool isFederateLocal( QTreeWidgetItem* item ) const;

   bool isFederateLightweight( QTreeWidgetItem* item ) const;

   bool isFederationLightweight( QTreeWidgetItem* item ) const;

public:

   enum DtFederateTreeCol
   {
      FederationNameIndex = 0,
      FederateTypeAndHandleIndex = 0,   // Shares column with federation name
      FederateProcessIndex,
      FederateNameIndex,
      FederateHostNameIndex,
      FederateIPIndex,
      ConnectedForwarderIpIndex,
      HlaVersionIndex,
      FederateQueueStatusIndex,
      FederatePIDIndex,
      FederateCommandArgsIndex,
      RegulatingStateIndex,
      ConstrainedStateIndex,
      LbtsIndex,
      LookAheadIndex,
      CurrentTimeIndex,
      TestStatusIndex,
      TestCountIndex,
      NumFederateTreeCols
   };

   QString theLoadingText;

   QString theRegulatingEnabledToolTip;
   QString theRegulatingDisabledToolTip;
   QString theConstrainedEnabledToolTip;
   QString theConstrainedDisabledToolTip;
   QString theTestCapableEnabledToolTip;
   QString theTestCapableDisabledToolTip;
   QString theNoTestToolTip;
   QString theContinuousTestToolTip;
   QString theSingleTestToolTip;
   QString theFederateLogEnabledText;
   QString theFederateLogDisabledText;


public slots:

   void showColumns();

   void setAllColumns( const std::map<QString, std::pair<int,bool> >& columns );

   void allColumns( std::map<QString, std::pair<int,bool> >& columns  );

   void showColCustomizeDlg();

   void deleteSelectedFed();

   void destroySelectedFederations();

   void updateEnableNetworkTestingForSelectedFederations();

   void showLatencyTest();

   void clearAllDefunctFederates();

   bool hasValidFederates() const;

   void clearCurrDefunctFederates();

   void refreshMenus();

   void signalSelectionChange();

   void showContextMenu( const QPoint& );

   void copySelectionToClipboard();

signals:

   void fedDeleteRequest( int, const QString& );
   void federationDeleteRequest( const QString& fedexName );
   void enableNetworkTestingRequest( const QString& );
   void disableNetworkTestingRequest( const QString& );
   void showFedLatencyTest( const QString&, int );

   void federateSelected( const MAKRti::DtString& federation, int federateHandle );

   void federationSelected( const MAKRti::DtString& name );

   void nothingSelected();

   void multipleItemsSelected();

   void defunctFederateRemoved( const MAKRti::DtString& federation, int federateHandle );

private:

   DtFederateTree( const DtFederateTree& );

   DtFederateTree& operator = ( const DtFederateTree& );

protected:

   static const int FederateNameRole;
   static const int FederateHandleRole;
   static const int TestEnableRole;
   static const int IsLocalRole;
   static const int IsLightweightRole;

   class DtFederateTreeColDescr
   {
   public:

      DtFederateTreeColDescr()
         : shortName()
         , longName()
         , description()
         , defaultSize(50)
      {
      }

      DtFederateTreeColDescr(const QString& s, const QString& l,
         const QString& d, unsigned sz )
         : shortName(s)
         , longName(l)
         , description(d)
         , defaultSize(sz)
      {
      }

      ~DtFederateTreeColDescr()
      {
      }

      QString shortName;
      QString longName;
      QString description;
      unsigned defaultSize;

   };

   std::vector<DtFederateTreeColDescr> myColumnDescrs;

   QMenu* myColViewMenu;

   std::vector<QAction*> myColDispActions;
   QAction* myColCustomizeAction;

   QMenu* myContextMenu;
   QMenu* myFederateMenu;
   QMenu* myFederationMenu;

   QAction* myStatisticsAction;
   QAction* myLatencyTestAction;
   QAction* myFederateRidParametersAction;
   QAction* myFederateFomAction;
   QAction* myFederateLogAction;
   QAction* myChangeFederateIconAction;
   QAction* myResignFederateAction;
   QAction* myClearCurrDefunctFederate;

   QAction* myFederationFomAction;
   QAction* myDisplaySyncPointsAction;
   QAction* myEnableNetworkTestingAction;
   QAction* myDestroyFederationAction;
   QAction* myClearAllDeadFederates;

   QIcon myCheckIcon;
   QIcon myNoCheckIcon;
   QIcon myContTestIcon;
   QIcon mySingleTestIcon;
   QIcon myYellowAttention;
   QIcon myRedAttention;
   QIcon myWorldWideWeb;
   QIcon myTestIcon;
   QIcon myDroppedIcon;

   std::map<QString,QString> myFederationNamesToItemNames;

   std::map<QString,QString> myItemNamesToFederationNames;

   std::map<QTreeWidgetItem*, std::pair<MAKRti::DtTime, std::pair<QString,int> > > myDefunctFederateTreeWidgets;

   std::map<QTreeWidgetItem*, std::pair<QString,int> > myReconnectingFederates;

   std::map<QTreeWidgetItem*, std::pair<QString,int> > myReconnectedFederates;

   std::set< std::pair<QString,int> > myClearedDefunctFederates;

   std::set<QTreeWidgetItem*> myTestDisabledFederations;

   std::map<MAKRti::DtString,QColor> myFederationColors;

   float myFederateRemovalTime;

   QTreeWidgetItem* myLoadingIndicationItem;

   bool myDeletionEnabled;

   MAKRti::DtClock myTimer;

   QSize myLastVisibleSize;

   static const int theLastColDefaultedOn;

   bool myShouldAddShutdownAllToMenu;

};