DtEntityList.h

Go to the documentation of this file.

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

//\file DtEntityList.h
//\brief Contains makVrf::makVrfEntityListExample::DtEntityList class.

#pragma once

#include <vrvUtil/signalslib.h>

#include "entityListUi.hpp"

#include <vrvCoreQt/DtPage.h>
#include <vrvCore/DtUserInterfaceAssembler.h>
#include <vrfGuiCore/guiSimObject.h>
#include <vrftasks/simTask.h>
#include <vrvUtil/DtSignalConnectionManager.h>

namespace makVrv
{
   class DtDe;
}

namespace makVrfEntityListExample
{

   //A widget class that displays all existing entities
   //as well as their current task and, if available, their destination.
   class DtEntityList : public makVrv::DtPage
   {
   public:
      DtEntityList( makVrv::DtDe& de, QWidget* parent = 0, Qt::WindowFlags flags = 0);

      virtual ~DtEntityList() override;

      //Get the icon of the page.
      virtual QIcon icon() override;

      virtual makVrv::DtQIconConfigurations qIconConfigurations() const override;

      //Get the title of the page.
      virtual QString title() override;

      //Get the class name of the page.
      virtual const std::string& pageClassName() const override;

      //Called when the page is displayed.
      virtual void activate() override;

      //Called when the page is hidden.
      virtual void deactivate() override;

      static std::string thePageClassName();

      //Goes through the entire list of entities and populates the tree
      virtual void populateEntityList();

   protected:
      //Sets up the contents of the widget onto the supplied parent
      void setupUi(QWidget* p);

      //Clears out widget
      virtual void clear();


   protected:
      virtual void slot_onObjectAdded(makVrf::DtSimObjectReference);
      virtual void slot_onObjectUpdated(makVrf::DtSimObjectReference);
      virtual void slot_onObjectAboutToBeRemoved(makVrf::DtSimObjectReference);
      virtual void slot_onCurrentTaskChanged(DtUUID entityName);

      //Using the known task, fill in the destination line in the entity list
      void fillDestinationLine(DtSimTask* task,QTreeWidgetItem* displayEntityItem);

   public:
      Ui_DtEntityListUi myUi;

      //This maps keeps track of each line in the target list
      struct LineToStateView
      {
         QTreeWidgetItem* item;
         boost::signals2::scoped_connection connection;
      };

      std::map<makVrv::DtUniqueID, LineToStateView> myLineToStateViewMap;
      makVrv::DtSignalConnectionManager myConnections;
   };

   //Create a "creator" helper class using the template.
   typedef makVrv::DtPageCreatorTemplate<DtEntityList> DtEntityListWidgetCreator;
}