tenaBroker/objectTrans.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2003 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: objectTrans.h,v $ $Revision: 1.10 $ $State: Exp $
*********************************************************************/
#ifndef objectTrans_H_
#define objectTrans_H_


#include "translator.h"
 
#include <map>
#include <list>

class DtReflectedObject;
class DtStateRepository;
class DtString;

namespace MAKVrExchange {
class DtPortalMessage;
class DtPortalReflectedObject;
}

namespace MAKVrExchange 
{ 
   namespace DtTenaBroker 
   {

      class DtBrokerObject;

      class DT_DLL_TENABROKER DtObjectTranslator : public DtTranslator
      {
      public:
         typedef enum { 
            none = 0,
            discover, 
            update,   
            remove}   
         UpdateType;

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

      public:

         DtObjectTranslator(DtTenaBroker *broker);

         virtual ~DtObjectTranslator();

      private:

         DtObjectTranslator(const DtObjectTranslator& other);

         DtObjectTranslator& operator=(const DtObjectTranslator& other);

      public:

         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 isTenaDiscoverable(const DtReflectedObject* reflectedObj);

         virtual bool isPortalDiscoverable(const DtPortalReflectedObject* reflectedObj);

         virtual void removeTenaObject(const DtReflectedObject* reflectedObj);

         virtual void tick() = 0;

         virtual void printIncomingOutgoingStateReps(
            const DtPortalMessage& incoming, const DtStateRepository& outgoing, 
            const DtString& objectName);

         virtual void printIncomingOutgoingStateReps(
            const DtStateRepository& incoming, const DtPortalMessage& outgoing,
            const DtString& objectName);

         virtual bool printDumpGuiToText( const UpdateType action, 
            const DtBrokerObject& brokerObject ) const;

         virtual const char* virtualTranslatorName() const;

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

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

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


      public:

         static const char* translatorName() 
         { return "Base Object Translator"; }

      protected:

         DtTenaBroker* broker() const { return myBroker; }

         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 createTenaPublisher(DtBrokerObject* brokerObject) = 0;

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

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

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

         virtual void removePortalObject(const DtPortalReflectedObject* reflectedObj);

      protected:

         typedef std::map<const DtReflectedObject*, DtBrokerObject *> 
            TenaToPortalReflectedMap;
         typedef std::map<const DtPortalReflectedObject*, DtBrokerObject *> 
            PortalToTenaReflectedMap;

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

         CallbackPairList myDiscoverCallbacks;
         CallbackPairList myUpdateCallbacks;
         CallbackPairList myRemoveCallbacks;

         TenaToPortalReflectedMap myPortalPublisherMap;
         PortalToTenaReflectedMap myTenaPublisherMap;
      };
   }
}

#endif