Scenario Metrics (scenarioMetrics)

Table of Contents

• Registering Callbacks
• How to Run the Example
  • Usage
• Classes
• Plugin Entry Points

The Scenario Metrics example demonstrates the following:

• How to export backend scenario metrics to a text file for later use.
• How to create callbacks on the backend to collect the scenario metrics.

Registering Callbacks

VR-Forces includes an architecture for registering callbacks on the backend( DtCgf class). This allows one to regestier pre and post tick callbacks.

This example creates a DtMetricCollector class. It registers a postTickCallback on the DtCgf class to be able to query for scenario metrics each tick.

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

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 scenarioMetrics.scnx scenario from the userData.
3. Run the scenario.
4. The R 1 will move around with spot reports enabled and the metric collector will collect his location and his sensor contracts.
5. A metrics.txt file will get created in the /bin64/ folder. It will contain the collected data.
6. After running the scenario for a while - open the "metrics.txt" to see the metrics collected from the scenario.

Classes

DtMetricCollector

New code

Plugin Entry Points

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

#include "vrfcgf/vrfPluginExtension.h"

#include <vrfcgf/cgf.h>
#include "metricCollector.h"

void tickMetricCollector()
{

}

DtMetricCollector* theMetricCollector = 0;

extern "C" {

   DT_VRF_DLL_PLUGIN void DtPluginInformation(DtVrfPluginInformation& info)
   {
      info.pluginName = "Scenario Metrics";
      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";
   }

   DT_VRF_DLL_PLUGIN bool DtInitializeVrfPlugin(DtCgf* cgf)
   {
      theMetricCollector = new DtMetricCollector(cgf);
      return true;
   }
}