VRF Message Printer

This subclass of DtVrfMessageInterface creates and registers with the various factories to be able to create and print interactions.

How to Run

This example demonstrates how to listen for and display VR-Forces-specific interface messages.

Usage:

(Release) vrfMsgDump

(Debug) vrfMsgDumpd

To run the application:

1. Start VR-Forces from the start menu.
2. Start vrfMsgDump

The contents of all VR-Forces-specific interface messages (e.g. tasks, set data requests) will be displayed in the vrfMsgDump console window. As you run VR-Forces, any task or set data request messages that get created over the course of a scenario will be displayed by vrfMsgDump.

---

Header file:

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

#pragma once

#include "vrfmodel/fixedWingPilotController.h"

//class DtSimpleRadarWarningResponse:
//
//Instances of DtSimpleRadarWarningResponse are an example of a controller
//that implements a reactive behavior when a it receives sensor input that
//a radar has been detected.  It receives a list of emitter systems (hostile
//radar systems).  It takes the first emitter in the list and flys away to
//a location in the opposite direction.

class DtEntityListInputPort;   
class DtUUID;

class DtSimpleRadarWarningResponse : public DtFixedWingPilotController
{
public:
   
   //constructor
   DtSimpleRadarWarningResponse(const DtString& name, DtLocalObject* owner,
      DtSimulationServices* simManager, DtComponentDescriptor* desc = NULL,
      DtReaderWriterRegistry* const parentRegistry = 0);


   //destructor
   virtual ~DtSimpleRadarWarningResponse();

   //This returns a string that uniquely identifies this type of component.
   //(must be unique with respect to the component types defined in compTypes.h
   //as well as any additional user-defined components).  Returns the string
   //"simple-radar-warning-response".
   virtual const char* type() const;

   //Calculate new control values.
   virtual void tick();

   //Returns a newly created instance of this class.  We need to provide
   //this function so that we can register this class with the component
   //factory.
   static DtSimComponent* creator(const DtString& name, DtLocalObject* owner,
      DtSimulationServices* simManager, DtComponentDescriptor* desc,
      DtReaderWriterRegistry* parentRegistry);

protected:

   //Called by DtSimComponent::init to create myEntityListPort used to manage
   //multiple sensors that might provide targets to this controller.
   virtual bool createPorts();

   //Looks up safe control point by name.  If the object exists and it has
   //a valid state repository, returns the object.  Otherwise returns NULL.
   virtual DtSimObjectReference getControlPoint(const DtUUID& name);

   //Returns true if we are in the vicinity of the given position.  To be
   //in the vicinity of the position means that we are within 5 seconds of
   //the given location, given our ordered speed.
   virtual bool inVicinity(const DtVector& localPosition);

protected:

   //default constructor
   DtSimpleRadarWarningResponse();

   //copy constructor, not implemented
   DtSimpleRadarWarningResponse(const DtSimpleRadarWarningResponse& orig);

   //assignment operator, not implemented
   DtSimpleRadarWarningResponse& operator=(const DtSimpleRadarWarningResponse& orig);

protected:

   //Port though which the list of hostile emitter systems will be received.
   DtEntityListInputPort* myEmitterListPort; 
   
   //true while in state of reacting to the detection of an emitter.
   bool myReactingToWarning;

   //Name of the safe location (a control point) we can retreat to.
   DtUUID mySafeControlPointName;

   DtVector myLocalGoal;
};

---

Implementation:

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

#include "simpleRdrWrnResp.h"
#include <vlutil/vlPrint.h>
#include "vrfobjcore/fixedWingEntityStateRepository.h"
#include "vrfobjcore/entListIOPort.h"
#include "vrfobjcore/fixedWingFlightPSR.h"
#include "vrfobjcore/outputPortGroup.h"
#include <vrfutil/profiler.h>

DtSimpleRadarWarningResponse::DtSimpleRadarWarningResponse(
   const DtString & name, DtLocalObject* owner, DtSimulationServices* simManager,
   DtComponentDescriptor* desc, DtReaderWriterRegistry * const parentRegistry) :
   DtFixedWingPilotController(name, owner, simManager, desc, parentRegistry),
   myEmitterListPort(NULL),
   myReactingToWarning(false),
   mySafeControlPointName("Safe Haven")
{
}

DtSimpleRadarWarningResponse::~DtSimpleRadarWarningResponse()
{
   if (myEmitterListPort)
   {
      delete myEmitterListPort;
      myEmitterListPort = NULL;
   }
}

namespace
{
   const char* SimpleRadarWarningResponseType = "simple-radar-warning-response";
}

const char* DtSimpleRadarWarningResponse::type() const
{
   return SimpleRadarWarningResponseType;
}

bool DtSimpleRadarWarningResponse::createPorts()
{
   if (!(myEmitterListPort = new DtEntityListInputPort("emitter-list")))
   {
      return false;
   }

   addInputPort(myEmitterListPort);

   return DtFixedWingPilotController::createPorts();
}

void DtSimpleRadarWarningResponse::tick()
{
   DtPROFILE("DtSimpleRadarWarningResponse::tick");
   DtFixedWingPilotController::tick();

   //If dT is > 0 (we're not paused), then do the work
   if (dT() > 0.) 
   {
      //Called each frame by the deriving controllers to set up need variables,
      //such as myNormalBodyVelocity and myLocalAngularVelocity.
      initializeControllerForTick();

      DtSimObjectReference safeControlPoint = getControlPoint(mySafeControlPointName);
      
      if (!safeControlPoint.isValid())
      {
         DtWarn << "DtSimpleRadarWarningResponse::tick() : Invalid safe control "
            "point " << mySafeControlPointName.markingText() << std::endl;

         return;
      }

      DtVector safeLocation = safeControlPoint->localPosition();

      //If I'm already reacting to a previous radar warning
      if (myReactingToWarning)
      {

         //Take control of the port group - this gives us exclusive control
         //over the fixed-wing actuator until we give that control up or a 
         //higher priority controller overrides us
         if (myFixedWingControlPortGroup->attemptToActivate())
         {
            if (inVicinity(safeLocation))
            {
               //We're done

               objectConsoleWarn() << "radarWarnRx Example - " << 
                  "We have reached the safe location!  " << std::endl;
               objectConsoleWarn() << "radarWarnRx Example - " << 
                  "Resume normal activity." << std::endl;

               myReactingToWarning = false;

               //Give up control of actuator's port group so other 
               //components may control it. 
               myFixedWingControlPortGroup->deactivate();
            }
            else
            {
               //Move toward the safe location
               flyTo(safeLocation, myFixedWingEntityState->orderedSpeed());
            }
         }
      }
      else
      {
         if (! myEmitterListPort || ! myEmitterListPort->activeConnection() ||
            !myEmitterListPort->value())
         {
            objectConsoleVerbose() << "radarWarnRx Example - " << 
            "No emitter list for radar warning reaction controller" <<
            std::endl;

            return;
         }

         //Get 1st emitter system on list of emitters on the port 
         const DtEntityTargetList* emitterList = myEmitterListPort->value();
      
         //If there aren't any emitters out there, there's nothing to react to
         if (!(emitterList->first() && emitterList->first()->data()))
         {
            //Mark the data as "old"
            myEmitterListPort->dataReceived();

            return;
         }

         //We have an emitter out there
         DtEntityTargetInformation * info = 
            (DtEntityTargetInformation *)emitterList->first()->data();

         //Look up the entity with the radar
         DtSimObjectReference emitterSystemHost = 
            simulationServices()->simObjectManager()->lookup(info->id());

         if (!emitterSystemHost)
         {
            //Mark the data as "old"
            myEmitterListPort->dataReceived();

            return;
         }

         //We're now reacting to an emitter
         myReactingToWarning = true;

         objectConsoleWarn() << "radarWarnRx Example - " << 
         "Simple radar warning rx detected emitter " << info->id().string() <<
         "." << std::endl;
         objectConsoleWarn() << "radarWarnRx Example - " << 
         "Move away from the source!" << std::endl;

         //Take control of port group - this gives us exclusive control
         //over the fixed-wing actuator for the duration of the frame (no other
         //controllers that come after this one will be able to control it).
         if (myFixedWingControlPortGroup->attemptToActivate())
         {
            //Move toward the safe location
            flyTo(safeLocation, myFixedWingEntityState->orderedSpeed());
         }
      
         //Mark the data as "old"
         myEmitterListPort->dataReceived();
      }
   }
}

DtSimComponent * DtSimpleRadarWarningResponse::creator(const DtString & name, 
   DtLocalObject* owner, DtSimulationServices * simManager, DtComponentDescriptor* desc,
   DtReaderWriterRegistry * parentRegistry)
{
   return new DtSimpleRadarWarningResponse(name, owner, simManager, desc, 
      parentRegistry);
}

DtSimObjectReference DtSimpleRadarWarningResponse::getControlPoint(const DtUUID& name)
{
   DtSimObjectReference controlPoint = simulationServices()->simObjectManager()->
      lookup(mySafeControlPointName);
   
   if (!controlPoint.isValid())
   {
      objectConsoleWarn() << "radarWarnRx Example - " << 
      "DtSimpleRadarWarningResponse::getControlPoint() : Can't find control point " <<
      name.markingText() << std::endl;
      return DtSimObjectReference::nullReference();
   }

   return controlPoint;
}

bool DtSimpleRadarWarningResponse::inVicinity(
   const DtVector& localPosition)
{
   DtLocalVector location = entity()->localPosition();

   myProcessState->setDistanceSquared(location.distSquaredTo2D(localPosition));
   
   if (myProcessState->lastDistanceSquared() == 0.0)
   {
      myProcessState->setLastDistanceSquared(myProcessState->distanceSquared());
   }

   if (myProcessState->distanceSquared() < (myFixedWingEntityState->orderedSpeed() * 
      myFixedWingEntityState->orderedSpeed() * 25.0)) //5 seconds away...
   {
      return true;
   }

   return false;
}