src/utl/utlManager.h

   1 //-----------------------------------------------------------------------------
   2 // This file is a part of the Qanava and LTM software.
   3 //
   4 // \file        utlManager.h
   5 // \author      Benoit Autheman (benoit@faktiss.net)
   6 // \date        2003 June 02
   7 //-----------------------------------------------------------------------------
   8
   9
  10 #ifndef qan_utlManager_h
  11 #define qan_utlManager_h
  12
  13
  14 // Change the BOOST signals namespace name to avoid clash with QT MOC 'signals' keyword
  15 #undef BOOST_SIGNALS_NAMESPACE
  16 #define BOOST_SIGNALS_NAMESPACE boost_signals
  17
  18
  19 // LTM headers
  20 #include "./utlConfig.h"
  21
  22
  23 // Standard includes
  24 #include <list>
  25 #include <vector>
  26
  27
  28 //  Boost headers
  29 #ifndef QANAVA_NOBOOST
  30         #include <signals/signal0.hpp>
  31         #include <signals/signal1.hpp>
  32 #endif
  33
  34
  35 //-----------------------------------------------------------------------------
  36 namespace QAN_UTL_ROOT_NAMESPACE // ::QAN_UTL_ROOT_NAMESPACE
  37 {
  38         namespace utl // ::QAN_UTL_ROOT_NAMESPACE::utl
  39         {
  40                 //! Empty glue class for all generic managers.
  41                 /*!
  42                         \nosubgrouping
  43                 */
  44                 class ManagerBase
  45                 {
  46                 public:
  47
  48                         //! Mode of maangement.
  49                         enum Mode
  50                         {
  51                                 //! Mode undefined.
  52                                 UNDEFINED               = 1,
  53
  54                                 //! Elements are just shared by the manager and left unmodified after manager destruction.
  55                                 SHARED                  = 2,
  56
  57                                 //! Elements are owned by the manager and freed during the manager destruction.
  58                                 OWNED                   = 4
  59                         };
  60                 };
  61
  62
  63                 //! Manage a group of generic object instances.
  64                 /*!
  65                         Support the virtual model behaviour trought the apropriate signals.
  66
  67                         \nosubgrouping
  68                 */
  69                 template < class Item >
  70                         class Manager : public ManagerBase
  71                 {
  72                         /*! \name Manager Constructor/Destructor *///----------------------
  73                         //@{
  74                 public:
  75
  76                         //! Manager constructor.
  77                         Manager( Mode mode = OWNED );
  78
  79                         //! Manager destructor.
  80                         virtual ~Manager( );
  81
  82                 private:
  83
  84                         //! Manager empty private copy constructor.
  85                         Manager( const Manager< Item >& manager ) : _mode( manager.mode ) { }
  86                         //@}
  87                         //-----------------------------------------------------------------
  88
  89
  90
  91                         /*! \name Items management *///------------------------------------
  92                         //@{
  93                 public:
  94
  95                         //!     STL vector of pointer to item type definition.
  96                         typedef                         std::list< Item* >      Items;
  97
  98                         //! Shortcut to the equivalent stl container member.
  99                         typedef typename        Items::iterator                 iterator;
 100
 101                         //! Shortcut to the equivalent stl container member.
 102                         typedef typename        Items::const_iterator   const_iterator;
 103
 104                         //! Shortcut to the equivalent stl container member.
 105                         unsigned int    size( ) const { return ( unsigned int )_items.size( ); }
 106
 107                         //! Shortcut to the equivalent stl container member.
 108                         iterator                begin( ) { return _items.begin( ); }
 109
 110                         //! Shortcut to the equivalent stl container member.
 111                         const_iterator  begin( ) const { return _items.begin( ); }
 112
 113                         //! Shortcut to the equivalent stl container member.
 114                         iterator                end( ) { return _items.end( ); }
 115
 116                         //! Shortcut to the equivalent stl container member.
 117                         const_iterator  end( ) const { return _items.end( ); }
 118
 119                         //! Get a const reference on the manager items list.
 120                         /*!     \return Manager items list const reference.                                      */
 121                         const Items&    getItems( ) const { return _items; }
 122
 123                         //! Get a reference on the manager items list.
 124                         /*!     \return Manager items list reference.                                            */
 125                         Items&                  getItems( ) { return _items; }
 126
 127                         //! Register an item by adding its reference to manager item list.
 128                         virtual void    add( Item& item );
 129
 130                         //! Register a list of items by adding their references to this manager.
 131                         virtual void    add( Items& items );
 132
 133                         //! Remove an item from this manager.
 134                         virtual void    remove( Item& item );
 135
 136                         //! Test if an item is registered in the manager.
 137                         bool                    has( Item& item ) const;
 138
 139                         //! Clear the database of all managed items.
 140                         void                    clear( bool destroy = false );
 141
 142                         //! Return the manager first item pointer (0 if manager is empty).
 143                         Item*                   first( );
 144
 145                         //! Return a pointer on th ith managed object.
 146                         Item*                   get( unsigned int index );
 147
 148                         //! Return a const pointer on th ith managed object.
 149                         const Item*             get( unsigned int index ) const;
 150
 151                         //! Return the manager mode.
 152                         Mode                    getMode( ) const { return _mode; }
 153
 154                 private:
 155
 156                         //! Management mode.
 157                         Mode            _mode;
 158
 159                         //! Internal list of item registered in the manager.
 160                         Items           _items;
 161                         //@}
 162                         //-----------------------------------------------------------------
 163
 164
 165
 166                         /*! \name Model Signals Management *///----------------------------
 167                         //@{
 168                 public:
 169
 170 #ifndef QANAVA_NOBOOST
 171                         //! .
 172                         boost::signal0< void >  modified;
 173 #else
 174                         void                                    modified( ) { }
 175 #endif
 176 #ifndef QANAVA_NOBOOST
 177                         //! .
 178                         boost::signal0< void >  destroyed;
 179 #else
 180                         void                                    destroyed( ) { }
 181 #endif
 182                         //@}
 183                         //-----------------------------------------------------------------
 184                 };
 185         } // ::ROOT_NAMESPACE::utl
 186 } // ::ROOT_NAMESPACE
 187 //-----------------------------------------------------------------------------
 188
 189
 190 #include "./utlManager.hpp"
 191
 192
 193 #endif // qan/ltm_utlManager_h
 194