Add Comm Model (addCommModel)

Table of Contents

• How to Run the Example
• Classes
• Plugin Entry Points

The Add Comm Model example demonstrates the following:

• How to create a new radio communications model and install it in VR-Forces Sim.
• How to use transmitter power to determine if a radio message should pass between two entities.

VR-Forces includes an architecture for plug-in communication models. Communication Models are used by VR-Forces to pass simulated messages such as spot reports from one entity to another. The communication model determines what messages can get through to their destination, and how long that takes.

This example creates a communcation model that uses the radio transmitter power of sending entities, and the range between the entities to determine if a message can get through.

Since this example is loaded as a plugin, it can be used in conjunction with the released VR-Forces application

How to Run the Example

• Modify the commModelParams.mtl file in data/simulationModelSets/EntityLevel with the following changes in the default-internal-radio-model section:
• Change (comm-model-type "simple-radio-comm-model") to (comm-model-type "my-comm-model")
• Change (publish-transmitters False) to (publish-transmitters True)
• In the Launcher, click the Plug-ins button to bring up the Plug-ins Selection dialog. Enable the plugin. Then launch VR-Forces.
• To view the new behavior, load the scenario data\scenarios\developer_toolkit_examples\addCommModel\addCommModel.scn. With the stock comms model SmWhel 2 and SmWhel 3 will both get the message from SmWhel 1 to move, but with the new comms model only SmWhel 2 will receive the message.

Classes

MyCommModel

New comm model code, derived from VRF DtSimpleRadioCommModel.

---

Plugin Entry Points

/*******************************************************************************
** Copyright (c) 2011 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: plugin.cxx,v $ $Revision: 1.1 $ $State: Exp $
*******************************************************************************/

#include "vrfcgf/vrfPluginExtension.h"
#include "myCommsModel.h"

#include "vrfcgf/cgf.h"
#include "vrfcgf/factoryManager.h"

extern "C" {

   DT_VRF_DLL_PLUGIN void DtPluginInformation(DtVrfPluginInformation& info)
   {
      info.pluginName = "addCommModel";
      info.pluginVersion = "1.00";
      info.pluginDescription = "An example of how to add a new internal comms model showing how to override radio connectivity";
      info.pluginCreator = "MAK Technologies";
      info.pluginCreatorEmail = "sales@mak.com";
      info.pluginContactWebPage = "www.mak.com";
      info.pluginContactMailingAddress = "150 Cambridge Park Drive 3rd Floor - Cambridge, MA 02140 USA";
      info.pluginContactPhone = "(617) 876 8085";
   }

   DT_VRF_DLL_PLUGIN bool DtInitializeVrfPlugin(DtCgf* cgf)
   {
      //Register new comms model
     cgf->factoryManager()->commModelFactory()->addCreatorFcn(MyCommModelType,MyCommModel::create);
      
      return true;
   }
}