examples/radarWarnRx/simpleRadarWarnRx.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2003 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: simpleRadarWarnRx.h,v $ $Revision: 1.9 $ $State: Exp $
*******************************************************************************/

#ifndef DtSimpleRadarWarningReceiver_H_
#define DtSimpleRadarWarningReceiver_H_

#include "vrfobjcore/simCmpnt.h"
#include <vl/globalObjDes.h>

//class DtSimpleRadarWarningReceiver:
//
//Instances of DtSimpleRadarWarningReceiver are an example of a simple radar
//warning reciever.  For the purposes of example this receiver determines
//that it has detected a remote radar if a given remote emitter system
//is located within a given distance from the entity configured with the 
//reciever.  The list of radar emitters sensed this tick is generated as 
//output.

class DtReflectedEmitterSystemList;
class DtEntityListOutputPort;
class DtRadarWarningReceiverDescriptor;

class DtSimpleRadarWarningReceiver : public DtSimComponent
{
public:
   //constructor
   DtSimpleRadarWarningReceiver(const DtString & name, DtVrfObject* owner,
      DtSimManager * simManager, DtComponentDescriptor* desc = NULL,
      DtReaderWriterRegistry * parentRegistry = 0);

   //destructor
   virtual ~DtSimpleRadarWarningReceiver();

   //Calls createRelfectedEmitterList() and createEmitterListPort().
   virtual bool init();

   //Called by init().  Creates the VR-Link list of all reflected emitter
   //objects in the simulation.
   virtual bool createReflectedEmitterList();

   //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-receiver".
   virtual DtString type();

   //This is the entity we're detecting for.  We override because we
   //want to grab and cache the global object designator.
   virtual void setEntity(DtVrfObject * entity);

   //Detects emitters and places them on our port.
   virtual void tick();

   //Returns the list of emitters we've detected.
   virtual DtEntityListOutputPort* emitterListPort() const;

   //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, DtVrfObject* owner,
      DtSimManager * simManager, DtComponentDescriptor* desc,
      DtReaderWriterRegistry * parentRegistry);

protected:
   
   //Overridden to create myEmitterListPort
   virtual bool createPorts();

protected:
   //Default constructor; should not be called.  Here because the compiler
   //will generate an unprotected one otherwise.
   DtSimpleRadarWarningReceiver();

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

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

protected:

   //List of all remote emitter systems.
   DtReflectedEmitterSystemList* myReflectedEmitterList;

   //Port used to communicate the list of detected emitter systems to
   //other components.
   DtEntityListOutputPort* myEmitterListPort;

   //The id of the entity this receiver is mounted on.
   DtGlobalObjectDesignator myGlobalId;

   //Pointer to the descriptor that holds the initialization parameters for this component.
   //This pointer is const because all instances of this component share a single
   //descriptor instance, so they should not be writing data back to it.
   const DtRadarWarningReceiverDescriptor* myDescriptor;
};

#endif