MeVisLab/Standard/Sources/ML/MLObjMgr/ObjMgr/mlObjMgr.h

Go to the documentation of this file.

// **InsertLicense** code
//-------------------------------------------------------------------------

//-------------------------------------------------------------------------

#ifndef __mlObjMgr_H
#define __mlObjMgr_H

#ifndef __MLObjMgrSystem_H
#include "MLObjMgrSystem.h"
#endif
#ifndef __mlObjMgrBase_H
#include "mlObjMgrBase.h"
#endif
#ifndef __mlObjMgrObjectContainer_H
#include "mlObjMgrObjectContainer.h"
#endif
#ifndef __mlObjMgrEvent_H
#include "mlObjMgrEvent.h"
#endif
#include <mlCallOnNextOpportunity.h>

ML_START_NAMESPACE

   class ObjMgrClient;

#ifdef WITH_NETCOM

   class omSServer;
   class omSClient;
   class omEventComm;

#endif

   class MLOBJMGR_EXPORT ObjMgr : public ObjMgrBase
   {
      friend class ObjMgrBase;
      friend class ObjMgrClient;

#ifdef WITH_NETCOM

      friend class omEventComm;

#endif

      typedef ObjMgrBase inherited;

      ML_CLASS_HEADER(ObjMgr)

      public:

#ifdef WITH_NETCOM

         enum NetworkModes {
            NET_NONE= 0,
            NET_SERVER,
            NET_CLIENT,
            NUM_NETWORK_MODES
         };

         static const char *NetworkModeStrings[NUM_NETWORK_MODES];

#endif

      public:

         BoolField *eventLoggingFld;

         BoolField *eventFilterFld;

         BoolField *permitRecursiveNotificationFld;

         BoolField *clientsReceiveOwnNotifyFld;

         NotifyField *clearObjContainerFld;

         StringField *infoFileNameFld;

         NotifyField *saveInfoFld;

#ifdef WITH_NETCOM

         EnumField   *netModeFld;

         StringField *netAddrFld;

         IntField    *netPortFld;

         BoolField *commOnlyMarkedInfoFld;

#endif

         ObjMgr();

         ~ObjMgr();

         void  setDefaultAddressFlags(const omFlags &flags) {
            _defaultAddressFlags = flags;
         }
         const omFlags &getDefaultAddressFlags() const {
            return _defaultAddressFlags;
         }
         
         void  addEvent(const ObjMgrEvent &event);

         inline void  disableEventRecording() {
            _silent = true;
         }
         inline void  enableEventRecording() {
            _silent = false;
         }

         inline void  disableEventRecordingForSocketDistribution() {
            _preventSocketDistribution = true;
         }
         inline void  enableEventRecordingForSocketDistribution() {
            _preventSocketDistribution = false;
         }
     
         const omObjectContainer *getObjectContainer() const  { return _objects; }

         void  saveNetworkInfo(const std::string &filename);

      protected:

         virtual void activateAttachments();

         virtual void handleNotification(Field *field);

         void  addClient(ObjMgrClient *client);
         void  removeClient(ObjMgrClient *client);

         void  sendNotification(ObjMgrBase *sendingClient);
      
         void  sendNotificationOnNextOpportunity();

         virtual std::string getDebugComment() const {
            return "ObjMgr";
         }
         
         omObjectContainer  *_objects;

         MLint32 _notifyRecursionDepth;
     
         CallOnNextOpportunity  _callLater;
         
#ifdef WITH_NETCOM

         omSServer  *_serverSocket;
         omSClient  *_clientSocket;

#endif

      private:

         omFlags  _defaultAddressFlags;
         
         std::set<ObjMgrClient *>  _clientModules;

         omEventContainer  _events;

         std::list<omEventContainer>  _undoBuffer;
         std::list<omEventContainer>  _redoBuffer;

         bool  _silent;
     
         bool _preventSocketDistribution;

         bool  _networkInitialized;

         void  evalClient(std::fstream &info, ObjMgrClient *client);
         void  evalNetwork(std::fstream &info, const std::multimap<ObjMgrBase *, ObjMgrBase *> &graph, ObjMgrBase *current);
      
         // Callback for sendNotification without providing a sender
         static void sendNotificationCB(void *self);
   };

ML_END_NAMESPACE

#endif // __mlObjMgr_H