Display Metrics (displayMetrics)

Table of Contents

• Processing Formatted Text Messages
• How to Run the Example
  • Usage
• Plugin Entry Points

The Display Metrics example demonstrates the following:

• How to build a plugin module for the VR-Forces 3D GUI
• How to add a toolbar and buttons to the GUI
• How to create a simple dialog to display some scenario metrics
• How to process text messages in the GUI

Processing Formatted Text Messages

The Display Metrics example demonstrates how to add a button to the toolbar which will display a new dialog containing scenario metrics. Metrics are updated by sending specially formatted text messages that are processed by the GUI plugin. Metrics are reset on scenario close or rewind. The formatted text messages are sent by lua scripts that are part of the scenario.

How to Run the Example

Usage

In the Launcher, click the Plug-ins button to bring up the Plug-ins Selection dialog. Enable the plugin.

To view the new behavior:

1. Start VR-Forces GUI and SIM.
2. Load the displayMetrics.scnx example scenario from userData.
3. Run the scenario. The UAV will monitor the warehouse area. When vehicles or people arrive or depart, it will update metrics. The latest metrics can be viewed by clicking Show Metrics on the toolbar.
4. Click the "Show Metrics" button to display the current metrics dialog. The dialog will update and display the counts of the arrived and departed people and vehicles.

  Note: If the metrics do not update in the dialog while open - close and reopen the metrics dialog to view updated metrics.
  Note: The metrics dialog will be blank before any metrics are received.

Plugin Entry Points

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

#include <vrvUtil/DtSignalConnectionManager.h>
#include <QPushButton>
#include <QDialog>
#include <map>

namespace makVrv
{
   class DtDe;
}

class DtString;
class QGridLayout;
class QVBoxLayout;
class QLabel;
class DtVrfObjectMessage;

class DtMetricsDialog
   : public QDialog
{
public:
   DtMetricsDialog(QWidget* parent = 0);

   virtual ~DtMetricsDialog() override;

   virtual void initialize(const std::map<DtString, int>& metrics);

   virtual void emptyMetric();

protected:

   QVBoxLayout* myLayout;
   QGridLayout* myMetricsLayout;
   QPushButton* myCloseButton;

   struct LabelAndValue
   {
      QLabel* lbl;
      QLabel* val;
   };
   std::vector<LabelAndValue> myMetrics;
};

class DtMetricsButton
   : public QPushButton
{
   Q_OBJECT

public:
   DtMetricsButton( makVrv::DtDe& de, const QString & text, QWidget* parent = 0);

   virtual ~DtMetricsButton() override;

   virtual void processTextReport(const DtVrfObjectMessage* msg);

   virtual void clearMetrics();

   public slots:
      void slot_onClicked();

protected:
   makVrv::DtDe& myDe;
   DtMetricsDialog* myDialog;
   std::map<DtString, int> myMetrics;
   makVrv::DtSignalConnectionManager myConnections;
};

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

//\file displayMetricsPlugin.cxx

//This file defines the generic DT_DLL_VRF_PLUGIN_EXPORT_MACRO.  Use that macro when
//you want to export symbols.  Also, in your CMakeLists.txt file, make sure to
//define the VRFPLUGIN_EXPORTS define to tell the compiler to define the macro as an
//export
#include <vrfGuiCore/vrfGuiExportPlugin.h>

#include <vrvCore/DtToolbarConfiguration.h>
#include <vrvCore/DtToolbarPath.h>
#include <vrvCoreQt/DtToolbar.h>
#include <vrvCoreQt/DtWidgetBuilder.h>
#include <vrvCoreQt/DtQApplicationProvider.h>
#include <vrvCoreQt/DtQtToolbarAssembler.h>

#include <vrfGuiCore/vrfContextMenuManagerSignaler.h>
#include <vrfGuiCore/objectSettingsManager.h>
#include <vrfGuiCore/vrfObjectManipulationManager.h>
#include <vrfGuiCoreQt/vrfContextMenuManager.h>
#include <vrfGuiCoreQt/entityMenu.h>
#include <vrfGuiCore/guiThreadNetworkCallbackManager.h>
#include <vrfGuiCore/scenarioSignaler.h>

#include <vrfmsgs/reportMessage.h>
#include <vrftasks/textReport.h>

#include <vrvCore/DtDe.h>
#include <vrvCore/DtDriverManager.h>
#include <vrvCore/DtInputDriver.h>
#include <vrvCore/DtVrvApplication.h>
#include <vrvUtil/DtDeInitializer.h>

#include <QtWidgets/QApplication>
#include <QtWidgets/QDialog>
#include <QtWidgets/QLayout>
#include <QtWidgets/QPushButton>
#include <QtWidgets/QLabel>
#include <QtWidgets/QComboBox>
#include <QtWidgets/QToolBar>

#include <vlpi/entityType.h>

#include <boost/bind/bind.hpp>

#include "displayMetricsPlugin.h"


// Toolbar for holding new pushbuttons
class DtMetricsToolbar : public makVrv::DtToolbar
{
public:
   DtMetricsToolbar (makVrv::DtDe& de);
   virtual ~DtMetricsToolbar() override;
   virtual QToolBar* createToolbar(makVrv::DtDe&, QWidget* parent) override;
};

DtMetricsToolbar::DtMetricsToolbar(makVrv::DtDe& de)
   : makVrv::DtToolbar(de, std::string("MetricsToolbar") )
{
}

DtMetricsToolbar::~DtMetricsToolbar()
{
}

QToolBar* DtMetricsToolbar::createToolbar(makVrv::DtDe&, QWidget* parent)
{
   QToolBar* tb = new QToolBar("Metrics", parent);
   tb->setWindowTitle("Metrics Toolbar");
   return tb;
}

//  Dialog for showing metrics
DtMetricsDialog::DtMetricsDialog(QWidget* parent)
   : QDialog(parent, Qt::Tool)
{
   setWindowTitle("Metrics");

   // Create the top level layout for the dialog as well as a
   // child layout which will contain the metrics themselves.
   myLayout = new QVBoxLayout(this);
   myMetricsLayout = new QGridLayout;
   myLayout->addLayout(myMetricsLayout);

   // Create the close button and position to the right of
   // dialog using a layout and a spacer.
   QHBoxLayout* closeLayout = new QHBoxLayout;
   QSpacerItem* closeSpacer = new QSpacerItem(100, 10, QSizePolicy::Expanding, QSizePolicy::Minimum);
   closeLayout->addItem(closeSpacer);
   myCloseButton = new QPushButton("Close", this);
   closeLayout->addWidget(myCloseButton);
   myLayout->addLayout(closeLayout);

   QSpacerItem* heightSpacer = new QSpacerItem(200, 0, QSizePolicy::Minimum, QSizePolicy::MinimumExpanding);
   myLayout->addItem(heightSpacer);

   // Dialog should be hidden when close button is pressed.
   connect(myCloseButton, SIGNAL(released()),
      this, SLOT(hide()));
}

DtMetricsDialog::~DtMetricsDialog()
{
}

void DtMetricsDialog::initialize(const std::map<DtString, int>& metrics)
{
   // Clear out existing metrics
   std::vector<LabelAndValue>::iterator lvIter = myMetrics.begin();
   std::vector<LabelAndValue>::iterator lvEnd = myMetrics.end();
   for (; lvIter != lvEnd; ++lvIter)
   {
      myMetricsLayout->removeWidget(lvIter->lbl);
      myMetricsLayout->removeWidget(lvIter->val);

      delete lvIter->lbl;
      delete lvIter->val;
   }
   myMetrics.clear();

   // Update metrics with new values
   if ( metrics.size() == 0 )
      emptyMetric();
   std::map<DtString, int>::const_iterator mIter = metrics.begin();
   std::map<DtString, int>::const_iterator mEnd = metrics.end();
   for (int i = 0; mIter != mEnd; ++mIter, ++i)
   {
      LabelAndValue lv;
      lv.lbl = new QLabel(mIter->first.c_str(), this);
      lv.val = new QLabel(QString::number(mIter->second), this);
      myMetricsLayout->addWidget(lv.lbl, i, 0);
      myMetricsLayout->addWidget(lv.val, i, 1);
      myMetrics.push_back(lv);
   }
}

void DtMetricsDialog::emptyMetric()
{
   LabelAndValue lv;
      lv.lbl = new QLabel("Awaiting Input", this);
      lv.val = new QLabel(0, this);
      myMetricsLayout->addWidget(lv.lbl, 0, 0);
      myMetricsLayout->addWidget(lv.val, 0, 1);
      myMetrics.push_back(lv);
}
//  Push button for showing metrics
DtMetricsButton::DtMetricsButton(makVrv::DtDe& de,
   const QString & text, QWidget* parent /* = 0 */)
   : QPushButton(text, parent)
   , myDe(de)
{
   connect(
      this, SIGNAL(clicked()),
      this, SLOT(slot_onClicked()) );

   CONNECT_FOR_RADIO_MESSAGE(DtTextReportType,
      boost::bind(&DtMetricsButton::processTextReport, this, boost::placeholders::_1));

   // Register connections for signals indicating that the current scenario
   // has closed or been rewound. When a scenario is closed, we will clear our
   // metrics.
   myConnections += makVrf::DtScenarioSignaler::instance(myDe).signal_scenarioRewound.connect(
      boost::bind(&DtMetricsButton::clearMetrics, this));
   myConnections += makVrf::DtScenarioSignaler::instance(myDe).signal_scenarioClosed.connect(
      boost::bind(&DtMetricsButton::clearMetrics, this));
   myConnections += makVrf::DtScenarioSignaler::instance(myDe).signal_allBackendsClosed.connect(
      boost::bind(&DtMetricsButton::clearMetrics, this));

   // Create the dialog and keep it hidden for now.
   myDialog = new DtMetricsDialog(this);
   myDialog->hide();
}

DtMetricsButton::~DtMetricsButton()
{
};

void DtMetricsButton::slot_onClicked()
{
   // Update the metrics and show the dialog.
   myDialog->initialize(myMetrics);
   myDialog->show();
}

void DtMetricsButton::clearMetrics()
{
   myMetrics.clear();
   myDialog->initialize(myMetrics);
}

void DtMetricsButton::processTextReport(const DtVrfObjectMessage *msg)
{
   // Examine text messages looking for metrics reports.
   if (msg->contentCategoryType() == DtReportMessageType)
   {
      const DtReportMessage *repMsg = static_cast<const DtReportMessage*>(msg);
      if (repMsg->report()->type() == DtTextReportType)
      {
         DtTextReport* textRep = static_cast<DtTextReport*>(repMsg->report());

         // Text messages containing a metric update contain three fields
         // separated by the token ';'. The first field will be the text
         // "[Metric]". The second is the name of the metric. The third is
         // the amount by which the metric should be updated (can be positive
         // or negative).
         std::vector<DtString> tokens;
         textRep->text().tokenize(';', tokens);
         if (tokens.size() == 3 && tokens[0] == "[Metric]")
         {
            std::map<DtString, int>::iterator mIter = 
               myMetrics.find(tokens[1]);
            if (mIter == myMetrics.end())
            {
               myMetrics.insert(std::make_pair(tokens[1], tokens[2].toInt()));
            }
            else
            {
               mIter->second += tokens[2].toInt();
            }

            // Update the dialog
            myDialog->initialize(myMetrics);
         }
      }
   }
}

class DtMetricsButtonBuilder : public makVrv::DtWidgetBuilder
{
public:
   DtMetricsButtonBuilder(makVrv::DtDe& de);
   virtual ~DtMetricsButtonBuilder() override;
   virtual QWidget* create(makVrv::DtDe& de, QWidget* parent, const Qt::WindowFlags& flags = 0) override;
};
//......................................................................
DtMetricsButtonBuilder::DtMetricsButtonBuilder(makVrv::DtDe& de)
   : DtWidgetBuilder()
{
}

DtMetricsButtonBuilder::~DtMetricsButtonBuilder()
{
}

QWidget* DtMetricsButtonBuilder::create( makVrv::DtDe& de, QWidget* parent, 
   const Qt::WindowFlags& flags)
{
   return new DtMetricsButton(de, "Show Metrics", parent);
}


void setupNewToolbar(makVrv::DtVrvApplication& app, makVrv::DtDe& de)
{
   makVrv::DtToolbar * tb = new DtMetricsToolbar(de);
   makVrv::DtQtToolbarAssembler::instance(de).registerToolbar(tb);

   DtMetricsButtonBuilder* bwb = new DtMetricsButtonBuilder(de);
   makVrv::DtQtToolbarAssembler::instance(de).registerWidgetBuilder(
      "ShowMetrics", bwb);
   app.masterModeToolbarConfiguration().addToolbarPath(
      makVrv::DtToolbarPath::toolbar("MetricsToolbar").widget("ShowMetrics"));

}

void postInitDeModule(makVrv::DtDe& de)
{
}

void setupInterface(makVrv::DtVrvApplication& app, makVrv::DtDe& de)
{
   //Create the qApplication if it has not already been created
   if (!qApp)
   {
      makVrv::DtQApplicationProvider& appProvider = makVrv::DtQApplicationProvider::instance(de);

      appProvider.qAppInstance();
   }

   setupNewToolbar(app, de);
}

bool initDeModule(makVrv::DtDe* de)
{
   makVrv::DtVrvApplication* igApp = makVrv::DtVrvApplication::findFromDe(*de);
   if(igApp)
   {
      setupInterface(*igApp, *de);
      return true;
   }
   else
   {
      return false;
   }
}

void DtPluginInformation(DtVrfPluginInformation& info)
{
   info.pluginName = "Display Metrics";
   info.pluginDescription = "Compiles and display metrics received via specially formatted text messages.";
   info.pluginVersion = "1.00";
   info.pluginCreator = "MAK Technologies";
   info.pluginCreatorEmail = "sales@mak.com";
   info.pluginContactWebPage = "www.mak.com";
   info.pluginContactMailingAddress = "10 Fawcett Street, Suite 204, Cambridge, MA 02138 USA";
   info.pluginContactPhone = "(617) 876 8085";
}