Source/Base/FieldContainer/Fields/MemObjPointerFields/OSGMemObjPointerMFieldBase.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *           Copyright (C) 2008 by the OpenSG Forum                          *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
  10  *                                                                           *
  11 \*---------------------------------------------------------------------------*/
  12 /*---------------------------------------------------------------------------*\
  13  *                                License                                    *
  14  *                                                                           *
  15  * This library is free software; you can redistribute it and/or modify it   *
  16  * under the terms of the GNU Library General Public License as published    *
  17  * by the Free Software Foundation, version 2.                               *
  18  *                                                                           *
  19  * This library is distributed in the hope that it will be useful, but       *
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  22  * Library General Public License for more details.                          *
  23  *                                                                           *
  24  * You should have received a copy of the GNU Library General Public         *
  25  * License along with this library; if not, write to the Free Software       *
  26  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  27  *                                                                           *
  28 \*---------------------------------------------------------------------------*/
  29 /*---------------------------------------------------------------------------*\
  30  *                                Changes                                    *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35  *                                                                           *
  36  *                                                                           *
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef _OSGMEMOBJPOINTERMFIELDBASE_H_
  40 #define _OSGMEMOBJPOINTERMFIELDBASE_H_
  41
  42 #ifdef __sgi
  43 #pragma once
  44 #endif
  45
  46 #include "OSGBaseDef.h"
  47 #include "OSGMField.h"
  48 #include "OSGMemoryObjectFieldTraits.h"
  49
  50 OSG_BEGIN_NAMESPACE
  51
  52 /*! \ingroup GrpBaseMemoryObjectsFields
  53     \ingroup GrpLibOSGBase
  54  */
  55
  56 class OSG_BASE_DLLMAPPING MemObjPointerMFieldBase : public Field
  57 {
  58     /*==========================  PUBLIC  =================================*/
  59
  60   public:
  61
  62     /*---------------------------------------------------------------------*/
  63     /*! \name Public Types                                                 */
  64     /*! \{                                                                 */
  65
  66     typedef Field                                       Inherited;
  67     typedef MemObjPointerMFieldBase                     Self;
  68
  69     // storage
  70     typedef MemoryObject                        *       StoredType;
  71     typedef MFieldVector<StoredType>                    StorageType;
  72
  73     typedef StorageType::const_iterator                 const_iterator;
  74     typedef StorageType::const_reverse_iterator         const_reverse_iterator;
  75
  76     typedef StorageType::const_iterator                 StorageConstIt;
  77
  78     typedef MemoryObject                        * const const_value;
  79     typedef MemoryObject                        *       value_type;
  80
  81     typedef StorageType::size_type                      size_type;
  82     typedef StorageType::difference_type                difference_type;
  83
  84
  85     typedef FieldTraits<MemoryObject *, 0>              MFieldTraits;
  86
  87
  88     // handles
  89     typedef EditMFieldHandle <Self      >               EditHandle;
  90     typedef boost::shared_ptr<EditHandle>               EditHandlePtr;
  91
  92     typedef GetMFieldHandle  <Self     >                GetHandle;
  93     typedef boost::shared_ptr<GetHandle>                GetHandlePtr;
  94
  95     /*---------------------------------------------------------------------*/
  96
  97     static const bool isSField       = false;
  98     static const bool isMField       = true;
  99
 100     static const bool isPointerField = true;
 101
 102     /*---------------------------------------------------------------------*/
 103     /*! \name                   Class Get                                  */
 104     /*! \{                                                                 */
 105
 106     static const FieldType &getClassType(void);
 107
 108     /*! \}                                                                 */
 109     /*---------------------------------------------------------------------*/
 110     /*! \name                   Binary Interface                           */
 111     /*! \{                                                                 */
 112
 113     SizeT  getBinSize(void                   ) const;
 114
 115     void   copyToBin (BinaryDataHandler &pMem) const;
 116
 117     /*! \}                                                                 */
 118     /*---------------------------------------------------------------------*/
 119     /*! \name Std Library Const Interface                                  */
 120     /*! \{                                                                 */
 121
 122     const_iterator         begin    (void             ) const;
 123     const_iterator         end      (void             ) const;
 124
 125     const_reverse_iterator rbegin   (void             ) const;
 126     const_reverse_iterator rend     (void             ) const;
 127
 128     value_type             front    (void             ) const;
 129     value_type             back     (void             ) const;
 130
 131     bool                   empty    (void             ) const;
 132     size_type              size     (void             ) const;
 133     size_type              max_size (void             ) const;
 134     size_type              capacity (void             ) const;
 135
 136     difference_type        findIndex(const_value value) const;
 137
 138     /*! \}                                                                 */
 139     /*---------------------------------------------------------------------*/
 140     /*! \name                  Index Operator                              */
 141     /*! \{                                                                 */
 142
 143     value_type operator[](const size_type index) const;
 144     value_type at        (const size_type index) const;
 145
 146     /*! \}                                                                 */
 147     /*---------------------------------------------------------------------*/
 148     /*! \name Raw Store Access                                             */
 149     /*! \{                                                                 */
 150
 151     bool operator ==(const Self &source) const;
 152
 153     /*! \}                                                                 */
 154     /*---------------------------------------------------------------------*/
 155     /*! \name                      MT Sync                                 */
 156     /*! \{                                                                 */
 157
 158     void dump(      UInt32    uiIndent = 0,
 159               const BitVector bvFlags  = 0) const;
 160
 161     /*! \}                                                                 */
 162     /*---------------------------------------------------------------------*/
 163     /*! \name                      MT Sync                                 */
 164     /*! \{                                                                 */
 165
 166 #ifdef OSG_MT_CPTR_ASPECT
 167     void beginEdit      (UInt32              uiAspect,
 168                          AspectOffsetStore  &oOffsets    );
 169
 170     Self *resolveShare  (UInt32              uiAspect,
 171                          AspectOffsetStore  &oOffsets    );
 172
 173     void  terminateShare(UInt32              uiAspect,
 174                          AspectOffsetStore  &oOffsets    );
 175
 176     bool  isShared      (void                            );
 177 #endif
 178
 179     /*! \}                                                                 */
 180     /*=========================  PROTECTED  ===============================*/
 181
 182   protected:
 183
 184     typedef StorageType::iterator iterator;
 185     typedef StorageType::iterator StorageIt;
 186
 187     /*---------------------------------------------------------------------*/
 188     /*! \name Members                                                      */
 189     /*! \{                                                                 */
 190
 191     static FieldType   _fieldType;
 192            StorageType _ptrStore;
 193
 194     /*! \}                                                                 */
 195     /*---------------------------------------------------------------------*/
 196     /*! \name Constructors                                                 */
 197     /*! \{                                                                 */
 198
 199     MemObjPointerMFieldBase(void);
 200
 201     /*! \}                                                                 */
 202     /*---------------------------------------------------------------------*/
 203     /*! \name Destructor                                                   */
 204     /*! \{                                                                 */
 205
 206     ~MemObjPointerMFieldBase(void);
 207
 208     /*! \}                                                                 */
 209     /*---------------------------------------------------------------------*/
 210     /*! \name                  Assignment                                  */
 211     /*! \{                                                                 */
 212
 213     void reserve(size_type newSize);
 214
 215     /*! \}                                                                 */
 216     /*---------------------------------------------------------------------*/
 217     /*! \name                  Assignment                                  */
 218     /*! \{                                                                 */
 219
 220     void operator =(const Self &source);
 221
 222     /*! \}                                                                 */
 223     /*---------------------------------------------------------------------*/
 224     /*! \name Cast Store Access                                            */
 225     /*! \{                                                                 */
 226
 227     /*! \nohierarchy */
 228     template <class TargetStoredTypeT>
 229     struct rebindStore
 230     {
 231         typedef MFieldVector<TargetStoredTypeT> type;
 232     };
 233
 234     template <class TargetStoredTypeT>
 235     typename rebindStore<TargetStoredTypeT>::type       &editStore(void);
 236
 237     template <class TargetStoredTypeT>
 238     typename rebindStore<TargetStoredTypeT>::type const &getStore (void) const;
 239
 240     StorageType       &editRawStore(void);
 241     StorageType const &getRawStore (void) const;
 242
 243     /*! \}                                                                 */
 244     /*==========================  PRIVATE  ================================*/
 245
 246   private:
 247
 248     MemObjPointerMFieldBase(const Self &obj);
 249 };
 250
 251 typedef MemObjPointerMFieldBase MemoryObjectPtrMFieldBase;
 252
 253 OSG_END_NAMESPACE
 254
 255 #include "OSGMemObjPointerMFieldBase.inl"
 256
 257 #endif // _OSGMEMOBJPOINTERMFIELDBASE_H_