Add FOM Class (addFomClassGui)

The Add FOM Class GUI example demonstrates the following:

• How to build a plugin module for the VR-Forces Gui
• How to add new FOM object class that can be mapped to an existing object type supported by VR-Forces
• How to receive and process FOM attributes that cannot be mapped to existing object attributes in VR-Forces
• How to add new items to the entity Information dialog

The Add FOM Class example shows how to add a new FOM object class that is not part of the RPR FOM and is therefore not typically supported by VR-Forces. It shows how to map this new object class to an existing RPR-based object, assuming the concepts being simulated are similar, which can then be displayed in the GUI. It also shows how additional attributes that cannot be mapped can be received and displayed in the Information dialog. For more details on this example, please see the Add FOM Class Sim example plugin, which configures the sim to also publish and subscribe this object class.

This example creates a new accessory that is used to configure the VR-Link FOM mapper so that instances of the AlternateEntity FOM class can be decoded to an entity state repository, which is based on the RPR FOM entity classes. It also adds the AlternateEntity FOM class as a supported class of the DtExtendedPropertiesEntityPublisher and DtExtendedPropertiesEntityList classes in order to process additional FOM attributes as state properties.

This example then registers a new page data item to display the SomeOtherAttribute state property. This property is populated by updates to the attribute of the same name in the AlternateEntity object class. This page data item queries the state view of the DtVrfObjectDataState to get the latest state property values.

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

//\file examplePlugin.cxx
//\brief Loads the plugin and initializes menu items


//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 "addFomClassGuiAccessory.h"
#include "attributePageItem.h"
#include <vrfGuiObjectInformationQt/informationDialogManager.h>
#include <vrvCore/DtDe.h>
#include <vrvCore/DtAccessoryManager.h>

using namespace makVrv;
using namespace makVrf;

// Entry point that must be defined by all plugins, this is called as part of the process that loads the plugin, before the de
// is fully initialized
bool initDeModule(DtDe* de)
{
   // Add the accessory to the accessory manager. It will get the option
   // to install itself into any DtDriver objects that are created.
   // The accessory will configure the FOM mapper.
   DtAccessoryManager::instance(*de).addAccessory(new DtAddFomClassGuiAccessory());

   // Add the new menu items into the state page path of the entity information page.
   // Pages are now prefaced by the section they are in (if they are in a section)
   // so must reference the page as <section name>.<page name>
   makVrfGuiObjectInformationQt::DtInformationDialogManager::instance(*de).informationPageConfiguration().
      addPagePathBefore(DtInformationPagePath::page("DtEntityExpandedData.DtEntityInformationPage").informationItem("DtSomeOtherAttributePageItem"),
      DtInformationPagePath::page("DtEntityExpandedData.DtEntityInformationPage").informationItem("DtEntityAcceleration"));

   // And now add the information item creators to be created when these items want to be displayed
   makVrfGuiObjectInformationQt::DtInformationDialogManager::instance(*de).informationPageAssembler().
      registerPageDataItemCreator(new DtSomeOtherAttributePageItemCreator);

   return true;
}

void DtPluginInformation(DtVrfPluginInformation& info)
{
   info.pluginName = "addFomClassGui";
   info.pluginDescription = "Example on adding a new FOM class that maps to an entity.";
   info.pluginVersion = "1.00";
   info.pluginCreator = "MAK Technologies";
   info.pluginCreatorEmail = "support@mak.com";
   info.pluginContactWebPage = "www.mak.com";
   info.pluginContactMailingAddress = "150 Cambridge Park Drive 3rd Floor - Cambridge, MA 02140 USA";
   info.pluginContactPhone = "(617) 876 8085";
}

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

#include "addFomClassGuiAccessory.h"

#include "../addFomClassSim/configFomMap.h"

#include <vrvVrl/DtVrlinkConnection.h>
#include <vrvVrl/DtVrlinkDriver.h>
#include <vrvVrl/DtEntitySimDataProcessor.h>
#include <vrvVrl/DtVrlinkEntityStateListener.h>
#include <vrvVrl/DtEntityStateInterceptor.inl>
#include <vrvVrl/DtEntityStateInterceptorCreator.h>
#include <vrvVrl/DtEntityExistenceListener.h>

#include <vrfExtObjects/extEntityStateRepository.h>
#include <readerWriter/propertyUtils.h>
#include <vrfExtProtocol/rangeItem.h>

#include <boost/bind.hpp>
#include <iostream>

using namespace makVrv;
using namespace makVrf;


//The accessory used by the VR-Vantage network drivers to add the new extended state data
//item (mass) to VR-Forces extended state data
DtAddFomClassGuiAccessory::DtAddFomClassGuiAccessory(): DtBaseAccessory()
, myDriver(0)
{
#ifdef DtHLA
#ifdef DtHLA_1516
#ifdef DtHLA_1516_EVOLVED
   myName="DtAddFomClassGuiHLA1516eAccessory";
#else
   myName="DtAddFomClassGuiHLA1516Accessory";
#endif
#else
   myName="DtAddFomClassGuiHLA13Accessory";
#endif
#endif
}

DtAddFomClassGuiAccessory::~DtAddFomClassGuiAccessory()
{
   if (myDriver)
   {
      uninstall(myDriver);
   }
}

//Called when the driver is first installed.  Set up some
//signals to be notified when the driver is connected to the
//network
void DtAddFomClassGuiAccessory::install(makVrv::DtDriver* driver)
{
   myDriver = dynamic_cast<makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfDriver*>(driver);

   if (myDriver)
   {
      myDriver->signal_simulationCreated.connect(
         boost::bind(&DtAddFomClassGuiAccessory::slot_onSimulationCreated, this, _1));
   }
}

void DtAddFomClassGuiAccessory::uninstall(makVrv::DtDriver* baseConn)
{
   if (myDriver)
   {
      DT_PROTOCOL_NAMESPACE::DtVrlinkConnection* vrlCon = dynamic_cast < DT_PROTOCOL_NAMESPACE::DtVrlinkConnection* >
         (myDriver->connection());

      myDriver->signal_simulationCreated.disconnect(
         boost::bind(&DtAddFomClassGuiAccessory::slot_onSimulationCreated, this, _1));

      if (vrlCon)
      {
         vrlCon->signal_exerciseConnectionCreated.disconnect(
            boost::bind(&DtAddFomClassGuiAccessory::slot_onReflectedListAboutToBeCreated, this));
      }
   }

   myDriver = 0;
}

//Override to make sure that this accessory is compatible with the driver being created
bool DtAddFomClassGuiAccessory::isCompatible(makVrv::DtDriver* driver)
{
   makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfDriver* dd = dynamic_cast<makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfDriver*>(driver);

   if(dd)
   {
      return true;
   }

   return false;
}

void DtAddFomClassGuiAccessory::slot_onSimulationCreated(DtConnection * connection)
{
   DT_PROTOCOL_NAMESPACE::DtVrlinkConnection* vrlCon = dynamic_cast <DT_PROTOCOL_NAMESPACE::DtVrlinkConnection*>
      (myDriver->connection());

   if (vrlCon)
   {
      vrlCon->signal_exerciseConnectionCreated.connect(
         boost::bind(&DtAddFomClassGuiAccessory::slot_onReflectedListAboutToBeCreated, this));
   }
}

void DtAddFomClassGuiAccessory::slot_onReflectedListAboutToBeCreated()
{
   DT_PROTOCOL_NAMESPACE::DtVrlinkConnection* vrlCon = dynamic_cast < DT_PROTOCOL_NAMESPACE::DtVrlinkConnection* >
      (myDriver->connection());

   if (vrlCon)
   {
      configFomMapper(vrlCon->exerciseConn(), true);
   }
}

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

#include "attributePageItem.h"
#include <vrfGuiCore/vrfStateViewCollectionManager.h>
#include <vrfGuiCore/vrfObjectDataState.h>
#include <readerWriter/propertyUtils.h>


using namespace makVrf;

DtSomeOtherAttributePageItem::~DtSomeOtherAttributePageItem()
{
}

std::string DtSomeOtherAttributePageItem::creatorName()
{
   return "DtSomeOtherAttributePageItem";
}

QString DtSomeOtherAttributePageItem::value(makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>* state)
{
   const makVrv::DtStateView<DtVrfObjectDataState>* objDataView =
      DtVrfStateViewCollectionManager::instance(myLogic->de()).
      objectDataStateViewCollection()->findStateView(state->id());

   if (objDataView)
   {
      // Lookup the current value of the state property for SomeOtherAttribute
      const DtRwPropertiesStructure* someOtherAttr = 
         objDataView->state().myStateProperties.findProperty<DtRwPropertiesStructure>("SomeOtherAttribute");

      if (someOtherAttr)
      {
         // Find each field within the structure
         boost::optional<double> field1 =
            someOtherAttr->findFieldValue<double>("Field1");
         boost::optional<int> field2 =
            someOtherAttr->findFieldValue<int>("Field2");

         if (field1 && field2)
         {
            return (QString::number(*field1) + " | " + QString::number(*field2));
         }
      }
   }

   return "";
}

QString DtSomeOtherAttributePageItem::title(makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>*)
{
   return QObject::tr("Some Other Attribute");
}