mlObjMgr.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef ML_OBJ_MGR_H
#define ML_OBJ_MGR_H
 
 
 
#include "MLObjMgrSystem.h"
#include "mlObjMgrBase.h"
#include "mlObjMgrObjectContainer.h"
#include "mlObjMgrEvent.h"
#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() override;
 
         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:
 
         void activateAttachments() override;
 
         void handleNotification(Field *field) override;
 
         void  addClient(ObjMgrClient *client);
         void  removeClient(ObjMgrClient *client);
 
         void  sendNotification(ObjMgrBase *sendingClient);
 
         void  sendNotificationOnNextOpportunity();
 
         std::string getDebugComment() const override {
            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