pReflectedObjectManager.h

Go to the documentation of this file.

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

#ifndef pReflectedObjectManager_H_
#define pReflectedObjectManager_H_


 
#include <vlutil/vlString.h>
#include <vlutil/vlNetTypes.h>
#include <matrix/vlVector.h>
#include <portal/pReflectedObject.h>
#include <portal/pConnection.h>
#include <portal/pEntity.h>
#include <portal/pGenericObject.h>
#include <portal/pControlMessage.h>
#include <portal/pAggregate.h>

#include <list>
#include <map>

namespace MAKVrExchange {

class DtPortalConnection;

template <class T_ReflectedObject>
class DtPortalReflectedObjectManager
{
public:

   typedef std::map<DtString, T_ReflectedObject *> ReflectedObjectMap;

   typedef void (*DtPortalObjectCallback)
      (const T_ReflectedObject &obj, void *usr);

   typedef bool (*DtDiscoveryCondition)
      (const DtPortalReflectedObject *refObj, void *usr);

public:

   DtPortalReflectedObjectManager( DtPortalConnection *conn, const bool ignoreFiltering = false );
   DtPortalReflectedObjectManager( DtPortalConnection *conn, DtPortalMessageKind messageType, const bool ignoreFiltering = false );

   virtual ~DtPortalReflectedObjectManager();

private:

   DtPortalReflectedObjectManager(const DtPortalReflectedObjectManager&other);

   DtPortalReflectedObjectManager& operator=(const DtPortalReflectedObjectManager&other);

public:



   virtual void addAdditionCallback(
      DtPortalObjectCallback cb, void* userData);

   virtual void removeAdditionCallback(
      DtPortalObjectCallback cb, void* userData);

   virtual void addRemovalCallback(
      DtPortalObjectCallback cb, void* userData);

   virtual void removeRemovalCallback(
      DtPortalObjectCallback cb, void* userData);


   virtual void setDiscoveryCondition(DtDiscoveryCondition fn, void* usr);

   virtual const ReflectedObjectMap& reflectedObjectMap() const;

   virtual bool isFilteringIgnored() const;

protected:

   virtual void discoverObject(T_ReflectedObject *pObj);

   virtual void processNewObject(
      const typename T_ReflectedObject::TheTypeOfThisObject &obj);

   virtual void processUpdate(
      const typename T_ReflectedObject::TheTypeOfThisObject &obj);

   virtual void processRemoval( const DtPortalObject &obj);

   virtual bool readyToAdd(const DtPortalReflectedObject *refObj);

   virtual void removeObjectsForBroker(const DtU32& brokerId);

protected:

   static void objectUpdateCb(
      const typename T_ReflectedObject::TheTypeOfThisObject &obj, void *user);

   static void abnormalRemovalCb(
      const DtAbnormalBrokerExitMessage &msg, void *usrData);

   static void removeBrokerCb(
      const DtBrokerExitingMessage &msg, void *usrData);

protected:

   struct CallbackPair
   {
      DtPortalObjectCallback fcn;
      void *userData;
   };

   typedef std::list<CallbackPair> CallbackPairList;
   typedef std::map<DtString, CallbackPairList> OjbectUpdateCallbackMap;

   CallbackPairList myObjectAdditionCallbacks;
   CallbackPairList myObjectRemovalCallbacks;

   ReflectedObjectMap myReflectedObjectMap;
   ReflectedObjectMap myWaitListObjectMap;
   DtPortalConnection *myConn;

   DtDiscoveryCondition myDiscoveryCondition;
   void* myDiscoveryConditionParameter;

   const bool myFilteringIgnored;
   DtPortalMessageKind myKind;

};
}

#define pReflectedObjectManager_INL_
#include "pReflectedObjectManager.inl"
#undef pReflectedObjectManager_INL_

#endif //end pReflectedObjectManager_H_