reflectedExtEntity.h

Go to the documentation of this file.

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

#pragma once

#include <vl/reflectedEntity.h>

#define DtEntReflectedObjectType DtReflectedEntity

#include <vrfExtObjects/extEntityStateRepository.h>

// Callback function that takes a DtReflectedExtEntity 
// and usr data.

class DtReflectedExtEntity;

typedef void (*DtExtEntityCallbackFunction)
(
   DtReflectedExtEntity* obj, void* userData
);

class DtExerciseConn;

#include <vrfExtObjects/vrfExtObjectsDefines.h>

/*
   This class extends DtReflectedEntity from VR-Link.

   In VR-Forces, on the Gui side, instances are created instead of instances of DtReflectedEntity.

   Additional note: this class is also responsible for setting up extended DI-Guy decoders, which 
   allow the contents of DI-Guy related packets to be controlled from VrfVrlExt, so that modifications 
   don't need to be made to code in VR-Link.
*/
class DT_DLL_vrfExtObjects DtReflectedExtEntity : public DtEntReflectedObjectType
{
public:

#if DtHLA
   DtReflectedExtEntity
   (
      DtHlaObject* obj,
      DtExerciseConn* conn
   );
   DtReflectedExtEntity(DtExerciseConn* conn, DtEntityStateRepository* esrToUse);
#elif (DtDIS || DtTENA)
   // constructor
   DtReflectedExtEntity
   (
      DtExerciseConn* conn,
      const DtEntityIdentifier& id,
      const DtEntityType& type
   );
#endif

   // destructor
   virtual ~DtReflectedExtEntity();

   // Returns ptr to environmentProcessStateRepository --
   // through which you can inspect current state info.
   virtual DtExtEntityStateRepository* extEntityStateRep() const;

   // Synonym for extEntityStateRep().
   virtual DtExtEntityStateRepository* eesr() const;

   // Implementation for abstract base class.  Calls cosr().
   virtual DtStateRepository* stateRep() const;

#if DtDIS
   // Process an environment process state PDU.  
   // Calls processEnvironmentProcess().
   virtual void processStateMessage(const DtStateMsg& msg);
#endif

   // Get the next and previous elements in the reflected 
   // cwenvironment process list.
   virtual DtReflectedExtEntity* nextEE() const;
   virtual DtReflectedExtEntity* prevEE() const;

   // Get the next and previous elements, wrap at the ends of the list.
   virtual DtReflectedExtEntity* wrapNextEE() const;
   virtual DtReflectedExtEntity* wrapPrevEE() const;

   // Environment Process callback registration/deregistration.
   virtual void addPostUpdateCallback
   (
      DtExtEntityCallbackFunction cb, void* userData
   );
   virtual void removePostUpdateCallback
   (
      DtExtEntityCallbackFunction cb, void* userData
   );

   static void postUpdateCallback
   (
      DtReflectedExtEntity* ent, void* userData
   );

   virtual void processPostUpdate();

#if DtHLA
   virtual void diGuyObjectUpdated();
#endif

   virtual void updateExtensions();

   // Overridden from bast class to make public.
   virtual void processPostUpdateCallbacks();

protected:

private:

   // copy constructor
   DtReflectedExtEntity(const DtReflectedExtEntity& orig);

   // assignment operator
   DtReflectedExtEntity& operator=(const DtReflectedExtEntity& orig);
};