disBroker/libDisBroker/objectTrans.h

Go to the documentation of this file.

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


#pragma once

#include <broker/translator.h>

#include <list>
#include <set>
#include <map>

class DtReflectedObject;
class DtStateRepository;
class DtEntityIdentifier;

namespace MAKVrExchange
{

   class DtPortalObject;
   class DtPortalReflectedObject;
   class DtRequestTranslationDiagnosticMessage;

   namespace DtDisBroker
   {

      class DtDisBroker;
      class DtBrokerObject;

      class DT_DLL_DISBROKER DtObjectTranslator : public DtTranslator
      {
      public:

         typedef enum
         {
            none = 0,
            discover = 1, 
            update = 2,   
            remove = 3    
         } UpdateType;

         typedef void (*BrokerObjectCbPtr)
            ( const DtBrokerObject *brokerObjectPointer,
               void *userData);

      public:

         DtObjectTranslator( DtDisBroker* broker, const DtString& name,
            DtPortalMessageKind kind );

         virtual ~DtObjectTranslator();

         virtual DtBrokerObject *releaseBrokerObject(
            const DtReflectedObject* reflectedObj);
         virtual DtBrokerObject *releaseBrokerObject(
            const DtPortalReflectedObject* reflectedObj);

         virtual DtBrokerObject *findBrokerObject(
            const DtReflectedObject* reflectedObj);
         virtual DtBrokerObject *findBrokerObject(
            const DtPortalReflectedObject* reflectedObj);

         virtual DtBrokerObject *createBrokerObject(
            const DtReflectedObject* reflectedObj);
         virtual DtBrokerObject *createBrokerObject(
            const DtPortalReflectedObject* reflectedObj);

         virtual bool isDisDiscoverable( const DtReflectedObject* reflectedObj );

         virtual bool isPortalDiscoverable( const DtPortalReflectedObject* reflectedObj );

         virtual void removeDisObject( const DtReflectedObject* reflectedObj );

         virtual void tick() = 0;

         virtual void printIncomingOutgoingStateReps(
            const DtPortalObject& incoming, const DtStateRepository& outgoing );

         virtual void printIncomingOutgoingStateReps(
            const DtStateRepository& incoming, const DtPortalObject& outgoing );

         virtual void performPortalDebugging( const DtPortalObject& incoming,
            const DtStateRepository& outgoing );

         virtual void performPortalDebugging( const DtStateRepository& incoming,
            const DtPortalObject& outgoing );

         virtual void addObjectDiscoveredCallback(
            BrokerObjectCbPtr funcPtr, void *userData);

         virtual void addObjectUpdatedCallback(
            BrokerObjectCbPtr funcPtr, void *userData);

         virtual void addObjectRemovedCallback(
            BrokerObjectCbPtr funcPtr, void *userData);

         // For logging
         virtual void logObjectActionUpdate(const DtBrokerObject* go,
            UpdateType ut);

         virtual unsigned int numObjects() const;

      protected:

         static void requestTransDiagCb( const DtRequestTranslationDiagnosticMessage& msg, void* usr );

         virtual void requestTransDiagCb( const DtRequestTranslationDiagnosticMessage& msg );

         virtual void callObjectDiscoverCallbacks( const DtBrokerObject* brokerObject );

         virtual void callObjectUpdateCallbacks( const DtBrokerObject* brokerObject );

         virtual void callObjectRemoveCallbacks( const DtBrokerObject* brokerObject );

         virtual void createPortalPublisher( DtBrokerObject* brokerObject ) = 0;
         virtual void createDisPublisher( DtBrokerObject* brokerObject ) = 0;

         virtual void deletePortalPublisher( DtBrokerObject* brokerObject ) = 0;
         virtual void deleteDisPublisher( DtBrokerObject* brokerObject ) = 0;

         virtual bool isPortalPublishable( const DtBrokerObject* brokerObject ) const = 0;

         virtual bool isDisPublishable( const DtBrokerObject* brokerObject ) const = 0;

         virtual void removePortalObject( const DtPortalReflectedObject* reflectedObj );

         virtual DtEntityIdentifier mapObjectId( const DtEntityIdentifier& identifier );

      private:

         DtObjectTranslator( const DtObjectTranslator& other );

         DtObjectTranslator& operator = ( const DtObjectTranslator& other );

         bool operator == ( const DtObjectTranslator& );

         bool operator != ( const DtObjectTranslator& );

      protected:

         struct CallbackPair { BrokerObjectCbPtr fcn; void *userData; };
         typedef std::list<CallbackPair> CallbackPairList;

         typedef std::map<const DtReflectedObject*, DtBrokerObject *>
            DisToPortalReflectedMap;
         typedef std::map<const DtPortalReflectedObject*, DtBrokerObject *>
            PortalToDisReflectedMap;

         typedef std::set<DtString> TransDebugObjectNamesSet;
         TransDebugObjectNamesSet myTransDebugNames;

         CallbackPairList myDiscoverCallbacks;
         CallbackPairList myUpdateCallbacks;
         CallbackPairList myRemoveCallbacks;

         DisToPortalReflectedMap myPortalPublisherMap;
         PortalToDisReflectedMap myDisPublisherMap;

         DtDisBroker* myDisBroker;

      };


      DT_DLL_DISBROKER std::ostream& operator << (std::ostream& os, const DtObjectTranslator::UpdateType &ut);

   }
}