tenaBroker.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2013 VT MAK
 * All rights reserved.
 ****************************************************************************/


#pragma once

#ifdef _WIN32
// The TENA Middleware requires an expanded FD_SETSIZE; let ACE #define it
// before <WinSock2.h> is #included as a side effect of one of the MFC headers
#include <ACE/config.h>
#endif

#include "throttle.h"
#include "globalIdMapper.h"
#include "translatorFactory.h"

#include <portal/pControlMessage.h>

#include <broker/vrlBroker.h>

#include <vl/exerciseConn.h>

#include <vlutil/vlStringUtil.h>
#include <vlutil/vlString.h>
#include <vlutil/vlTime.h>

#include <list>
#include <map>

class DtExerciseConn;

namespace MAKVrExchange
{

   class DtPortalReflectedObject;

   namespace DtTenaBroker
   {

      class DtBrokerObject;
      class DtEntityIdMapper;
      class DtObjectTranslator;
      class DtGenericUserInterface;
      class DtTenaBrokerInitializer;
      class DtInteractionTranslator;

      class DT_DLL_TENABROKER DtTenaBroker : public DtVrlBroker
      {
      public:

         static DtTenaBroker* create( DtTenaBrokerInitializer* init );

         virtual ~DtTenaBroker();

         virtual void initializeUi(DtGenericUserInterface *ui);

      protected:

         DtTenaBroker();

         virtual void initialize( DtTenaBrokerInitializer* init );

         virtual void logBrokerSettings( DtBrokerInitializer* init );

      private:

         DtTenaBroker( const DtTenaBroker& other );

         DtTenaBroker& operator = ( const DtTenaBroker& other );

      public:

         virtual void loadTranslators();

         virtual DtObjectTranslator* getObjectTranslator(const DtString& name);

         virtual DtInteractionTranslator* getInteractionTranslator(const DtString& name);

         virtual bool loadObjectTranslator(const DtString& translatorName);

         // disabled set but it couldn't be loaded.
         virtual bool loadInteractionTranslator(const DtString& translatorName);

         virtual void loadKnownObjectTranslators( DtStringSet* failedTranslators );

         virtual void loadKnownInteractionTranslators( DtStringSet* failedTranslators );

         virtual DtTenaBrokerInitializer* tenaInitializer();

         virtual bool fillOutgoingIds() const;

         virtual bool usePersistentIds() const;

         virtual bool forceUpdateFlag() const;

         virtual bool guiseIsEntityType() const;

         virtual bool useTenaObjectIdForMarkingText() const;

         virtual bool useMarkingTextForTenaObjectId() const;

         virtual bool generateFirePduForIndirectFire() const;

         virtual bool dumpGuiToText() const;

         virtual bool debugGlobalIdMapping() const;

         virtual DtGlobalIdMapper* globalIdMapper();

         virtual DtEntityIdMapper* entityIdMapper();

         virtual DtThrottle* throttle();

         virtual void tick();

         virtual DtTime simTime() const;

         virtual void launchGui();

         virtual void launchInfoGui();

         virtual void reloadBrokerSettings();

         virtual DtInteractionTranslatorFactory* interactionTranslatorFactory();

         virtual DtObjectTranslatorFactory* objectTranslatorFactory();

         virtual DtString portalNameFind(const DtString& name);

      protected:

         virtual void processEvents();

         void initTenaConnection(const DtTenaBrokerInitializer &init);

         void initializeTenaBroker();

         void shutdownBroker( );

         virtual void addTranslator(DtInteractionTranslator *intTrans, bool enabled);

         virtual void addTranslator(DtObjectTranslator *objTrans, bool enabled);

         void reportLoadTranslatorFailures( const DtStringSet& failedTranslators ) const;

         virtual void shutdownTranslators();

         virtual void objectDiscovered(const DtBrokerObject* brokerObject);

         virtual void objectUpdated(const DtBrokerObject* brokerObject);

         virtual void objectRemoved(const DtBrokerObject* brokerObject);

         virtual void initPortalNameMapper( const DtFilename& mapFile);

      protected:

         static void objectDiscoveredCallback(const DtBrokerObject* brokerObject,  void *usr);
         static void objectUpdatedCallback(const DtBrokerObject* brokerObject, void *usr);
         static void objectRemovedCallback(const DtBrokerObject* brokerObject, void *usr);

      protected:

         typedef std::map<const DtString, DtInteractionTranslator*> NamedInteractionTranslatorMap;
         typedef std::map<const DtString, DtObjectTranslator*> NamedObjectTranslatorMap;

         DtGenericUserInterface *myUi;
         NamedInteractionTranslatorMap myInteractionTranslatorMap;
         NamedObjectTranslatorMap myObjectTranslatorMap;

         DtThrottle myThrottle;

         DtObjectTranslatorFactory myObjectTranslatorFactory;
         DtInteractionTranslatorFactory myInteractionTranslatorFactory;
         DtGlobalIdMapper myGlobalIdMapper;
         DtEntityIdMapper* myEntityIdMapper;
         DtU16 myNextEntityId;
         std::map<DtString,DtString> myPortalNameMapper;

      };

      inline DtGlobalIdMapper* DtTenaBroker::globalIdMapper()
      {
         return &myGlobalIdMapper;
      }

      inline DtEntityIdMapper* DtTenaBroker::entityIdMapper()
      {
         return myEntityIdMapper;
      }

      inline DtThrottle* DtTenaBroker::throttle()
      {
         return &myThrottle;
      }

   }
}