disBroker/objectTrans.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 1992-2010 VT MAK
** All rights reserved.
*********************************************************************/

#ifndef objectTrans_H_
#define objectTrans_H_


#include "translator.h"

#include <map>
#include <list>

class DtReflectedObject;
class DtStateRepository;


namespace MAKVrExchange { 
class DtPortalMessage;
class DtPortalReflectedObject;
namespace 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);

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

   virtual bool isPortalDiscoverable(const DtPortalReflectedObject* reflectedObj);

   virtual void removeDisObject(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 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);


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

public:

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

protected:

   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);

protected:

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

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

   CallbackPairList myDiscoverCallbacks;
   CallbackPairList myUpdateCallbacks;
   CallbackPairList myRemoveCallbacks;

   DisToPortalReflectedMap myPortalPublisherMap;
   PortalToDisReflectedMap myDisPublisherMap;
};


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

}}

#endif //end #ifndef objectTrans_H_