Overview

This example shows how to create a very simple plug-in that creates a Hla1516e driver and automatically connects to a Hla1516e exercise.

Expected Result

Select the RTI connection

New HLA connection from the connection dialog

Example details

It shows how to create a new Hla1516e Driver object, add it to the driver manager and set it up to start automatically.

Building the Example

VR-Vantage includes pre-built versions of the example plug-in. To build it yourself, follow the instructions at Building VR-Vantage Examples, Applications, and Plug-ins.

Running the Example

This example is an application. You can run it by running ./bin64/exampleHla1516eConnection_stealth.bat (on Windows) or ./bin64/exampleHla1516eConnection_stealth.sh (on Linux). When Vantage start it will ask you to select an RTI connection (select the loopback connection). From the menu "Settings->Connections..." you can see the new HLA connection that was added by the plugin. For more information about running examples, please see Running Applications and Examples.

Example Source Files

exampleHla1516eConnectionInit.cxx

/******************************************************************************
 * Copyright (c) 2024 MAK Technologies, Inc.
 * All rights reserved.
 *****************************************************************************/
#include "exampleHla1516eConnection.h"
#include "exampleHla1516eConnectionInit.h"
#include <makArchives/DtDriverRecord.h>
#include <vrvUtil/DtDeError.h>
#include <vrvUtil/DtDePathConfiguration.h>
#include <vrvCore/DtDe.h>
#include <vrvCore/DtDriverFactory.h>
#include <vrvCore/DtDriverManager.h>
#include <vrvHla1516e/DtHla1516eDriver.h>
#include <vl/exerciseConnInitializer.h>
#include <makArchives/DtXmlFileIo.h>
#include <boost/filesystem.hpp>
#include <functional>
bool initDeModule(makVrv::DtDe* de)
{
   makVrv::vrvExampleHla1516eConnection::init(*de);
   return true;
}
// Use the VR-Vantage namespace. All classes in VR-Vantage are in this namespace.
namespace makVrv
{
   namespace vrvExampleHla1516eConnection
   {
      static vrvSignalsLib::connection postInitializeConnection;
      //name for example driver that this example creates
      static const std::string exampleDriverName = "myHla1516eDriver";
      //Create the example HLA1516E driver
      void createDriver(DtDe* de)
      {
         // We're done with the signal, so disconnect from it
         postInitializeConnection.disconnect();
         //Step 1: Create the HLA1516E driver.
         DtHla1516eDriver* hla1516eDriver = dynamic_cast<DtHla1516eDriver*>(
            DtDriverFactory::instance(*de).
            createDriver(std::string("DtHla1516eDriver"), exampleDriverName));
         // Step 2:
         // Start by loading in our current default HLA 1516e configuration file to get the latest
         // fom modules in use.  The remaining parameters are provided as examples and can be commented out / 
         // removed to use the values that came from the config file
         boost::filesystem::path loadPath = boost::filesystem::system_complete(
            de->dePathConfiguration().driverPath());
         loadPath += "/HLA 1516 Evolved.DtHla1516eDriver";
         makArchives::DtDriverRecord record;
         if (makArchives::DtXmlFileIo::read(loadPath.string(), record, "DtDriverRecord"))
         {
            DtConfiguration settings;
            settings.setName("HLA 1516 Evolved.DtHla1516eDriver");
            std::string federateName = "VR-Vantage HLA 1516 Evolved Example Driver";
            settings.setOptionalParameters(record.settings());
            //  Now we can make changes to what came from the config file
            settings.setOptionalParameter("federateName", "VR-Vantage 3.1 Example");
            settings.setOptionalParameter("federateType", "VR-Vantage HLA 1516 Evolved Example Driver");
            settings.setOptionalParameter("fedFileName", "RPR_FOM_v2.0_1516-2010.xml");
            settings.setOptionalParameter("rprFomVersion", "2");
            settings.setOptionalParameter("useAdvisories", "1");
            settings.setOptionalParameter("useGeographicDdm", "0");
            hla1516eDriver->realizeConfiguration(settings);
         }
         else
         {
            DtDeError error(DtDeError::Error_UnableToLoadDriverFile);
            error << loadPath.string();
            de->emitDeError(error, true);
            return;
         }
         // Step 3: Add the Hla1516e driver to the display engine.
         // The driver is now owned by the display engine. Do not delete it.
         de->driverManager().addDriver(hla1516eDriver);
      }
      void init(DtDe& de)
      {
         DT_DE_INIT_ONCE(de);
         try
         {
            //connect to the post initialize signal so the driver is created at 
            // the proper time
            postInitializeConnection = de.signal_postInitialize.connect(std::bind(
               &createDriver, &de));
            //Add the example drivers name to the list of drivers to start when 
            // the De starts all the drivers. 
            DtDeInitializer initializer = de.deInitializer();
            std::vector< std::string > autoStartList = initializer.autoStartDrivers();
            //this name needs to match the name used in createDriver() above
            // when the driver is created
            autoStartList.push_back(exampleDriverName);
            initializer.setAutoStartDrivers(autoStartList);
            de.setDeInitializer(initializer);
         }
         DtCATCH_AND_PROPAGATE(DtCorruptedState)
      }
   
   }
}

exampleHla1516eConnectionInit.h

/******************************************************************************
** Copyright (c) 2024 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
#pragma once
// Get proper local export symbol
#include "exampleHla1516eConnection.h"
// Setup proper plugin export symbol
#define DT_DE_PLUGIN_EXPORT_MACRO DT_DLL_EXAMPLEHLA1516ECONNECTION
// Export plugging function bool initDeModule(DtDe* de);
#include <vrvCore/exportPlugin.h>
namespace makVrv
{
   class DtDe;
   namespace vrvExampleHla1516eConnection
   {
      DT_DLL_EXAMPLEHLA1516ECONNECTION void init(DtDe& anIG);
   }
}

exampleHla1516eConnection.h

/******************************************************************************
** Copyright (c) 2024 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
#ifndef exampleHla1516eConnection_H_
#define exampleHla1516eConnection_H_
#ifdef _WIN32
#ifdef EXAMPLEHLA1516ECONNECTION_EXPORTS
#define DT_DLL_EXAMPLEHLA1516ECONNECTION __declspec ( dllexport )
#else
#define DT_DLL_EXAMPLEHLA1516ECONNECTION __declspec ( dllimport )
#endif
#else
#define DT_DLL_EXAMPLEHLA1516ECONNECTION
#endif
#endif

[<< Examples] [Home] [Top of Page]

Table of Contents