Source/Base/FieldContainer/Fields/PointerFields/OSGPointerMFieldCommon.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 _OSGPOINTERMFIELDCOMMON_H_
  40 #define _OSGPOINTERMFIELDCOMMON_H_
  41
  42 #ifdef __sgi
  43 #pragma once
  44 #endif
  45
  46 #include "OSGConfig.h"
  47 #include "OSGPointerMFieldBase.h"
  48 #include "OSGBinaryDataHandler.h"
  49
  50 OSG_BEGIN_NAMESPACE
  51
  52 // forward declarations
  53 template <Int32 NamespaceI>
  54 class PointerFieldTraitsBase;
  55
  56 /*! \ingroup GrpBaseFieldContainerFields
  57     \ingroup GrpLibOSGBase
  58  */
  59
  60 template <class AccessHandlerT,
  61           Int32 NamespaceI     = 0>
  62 class PointerMFieldCommon : public PointerMFieldBase
  63 {
  64     /*==========================  PUBLIC  =================================*/
  65
  66   public:
  67
  68     /*---------------------------------------------------------------------*/
  69     /*! \name Public Types                                                 */
  70     /*! \{                                                                 */
  71
  72     typedef          AccessHandlerT                      AccessHandler;
  73     typedef          PointerMFieldBase                   Inherited;
  74
  75     typedef typename Inherited::StorageIt                PtrStoreItType;
  76     typedef typename Inherited::StorageConstIt           PtrStoreConstItType;
  77
  78     typedef typename Inherited::StoredType               StoredType;
  79     typedef typename Inherited::StorageType              PtrStoreType;
  80
  81     typedef typename Inherited::const_value              const_value;
  82     typedef typename Inherited::value_type               value_type;
  83
  84     typedef typename Inherited::size_type                size_type;
  85     typedef typename Inherited::difference_type          difference_type;
  86
  87   protected:
  88
  89     typedef          PointerMFieldCommon                 Self;
  90
  91     typedef          FieldTraitsFCPtrBase<
  92                          FieldContainer *,
  93                          NamespaceI       >              PtrBaseTraitsType;
  94
  95     /*! \}                                                                 */
  96     /*---------------------------------------------------------------------*/
  97     /*! \name Constants                                                    */
  98     /*! \{                                                                 */
  99
 100     static Int32 const Namespace = NamespaceI;
 101
 102     /*! \}                                                                 */
 103     /*=========================  PROTECTED  ===============================*/
 104
 105   protected:
 106
 107     /*---------------------------------------------------------------------*/
 108     /*! \name Constructors                                                 */
 109     /*! \{                                                                 */
 110
 111              PointerMFieldCommon(void                  );
 112              PointerMFieldCommon(const Self   &source  );
 113     explicit PointerMFieldCommon(const UInt32  initSize);
 114
 115     /*! \}                                                                 */
 116     /*---------------------------------------------------------------------*/
 117     /*! \name Destructor                                                   */
 118     /*! \{                                                                 */
 119
 120     ~PointerMFieldCommon(void);
 121
 122     /*! \}                                                                 */
 123     /*---------------------------------------------------------------------*/
 124     /*! \name Store Interface                                              */
 125     /*! \{                                                                 */
 126
 127     // reading values
 128     value_type ptrStoreGet(const size_type           index) const;
 129     value_type ptrStoreGet(      PtrStoreItType      pos  ) const;
 130     value_type ptrStoreGet(      PtrStoreConstItType pos  ) const;
 131
 132     /*---------------------------------------------------------------------*/
 133     // adding values
 134
 135     void           ptrStoreAppend (      const_value    pNewObj);
 136
 137     template <class InputIteratorT>
 138     void           ptrStoreAssign (      InputIteratorT first,
 139                                          InputIteratorT last   );
 140
 141     void           ptrStoreInsert (const size_type      index,
 142                                          const_value    pNewObj);
 143     void           ptrStoreInsert (      PtrStoreItType pos,
 144                                          size_type      n,
 145                                          const_value    pNewObj);
 146     PtrStoreItType ptrStoreInsert (      PtrStoreItType pos,
 147                                          const_value    pNewObj);
 148
 149     template <class InputIteratorT>
 150     void           ptrStoreInsert (      PtrStoreItType pos,
 151                                          InputIteratorT first,
 152                                          InputIteratorT last   );
 153
 154
 155     /*---------------------------------------------------------------------*/
 156     // changing values
 157
 158     void ptrStoreReplace(const size_type      index,
 159                                const_value    pNewObj);
 160     void ptrStoreReplace(      PtrStoreItType pos,
 161                                const_value    pNewObj);
 162
 163     /*---------------------------------------------------------------------*/
 164     // removing values
 165
 166     void           ptrStoreErase  (const size_type      index     );
 167     void           ptrStoreErase  (const size_type      beginIndex,
 168                                    const size_type      endIndex  );
 169
 170     PtrStoreItType ptrStoreErase  (      PtrStoreItType pos       );
 171     PtrStoreItType ptrStoreErase  (      PtrStoreItType beginIt,
 172                                          PtrStoreItType endIt     );
 173
 174     void           ptrStoreClear  (      void                     );
 175
 176     /*---------------------------------------------------------------------*/
 177     // resizing
 178
 179     void ptrStoreResize(const size_type   newSize,
 180                               const_value pNewObj);
 181
 182     /*---------------------------------------------------------------------*/
 183     // finding values
 184
 185     PtrStoreItType      ptrStoreFind(const_value pObj);
 186     PtrStoreConstItType ptrStoreFind(const_value pObj) const;
 187
 188     /*! \}                                                                 */
 189     /*---------------------------------------------------------------------*/
 190     /*! \name Std library interface                                        */
 191     /*! \{                                                                 */
 192
 193
 194     /*! \}                                                                 */
 195     /*---------------------------------------------------------------------*/
 196     /*! \name FieldDesc creation                                           */
 197     /*! \{                                                                 */
 198
 199     static FieldDescriptionBase *
 200         createFieldDescription   (const Char8                *szFieldname,
 201                                         UInt32                uiFieldFlags,
 202                                         FieldEditMethod       fEditMethod,
 203                                         FieldGetMethod        fGetMethod  );
 204
 205     static FieldDescriptionBase *
 206         createIdxFieldDescription(const Char8                *szFieldname,
 207                                         UInt32                uiFieldFlags,
 208                                         FieldIndexEditMethod  fEditMethod,
 209                                         FieldIndexGetMethod   fGetMethod  );
 210
 211     /*! \}                                                                 */
 212     /*---------------------------------------------------------------------*/
 213     /*! \name Binary IO                                                    */
 214     /*! \{                                                                 */
 215
 216     void copyFromBin(BinaryDataHandler &pMem);
 217
 218     /*! \}                                                                 */
 219     /*---------------------------------------------------------------------*/
 220     /*! \name MT Sync                                                      */
 221     /*! \{                                                                 */
 222
 223     void syncWith(Self               &source,
 224                   ConstFieldMaskArg   syncMode,
 225                   UInt32              uiSyncInfo,
 226                   AspectOffsetStore  &oOffsets  );
 227
 228     /*! \}                                                                 */
 229     /*==========================  PRIVATE  ================================*/
 230
 231   private:
 232
 233     void operator =(const Self &other);
 234 };
 235
 236 OSG_END_NAMESPACE
 237
 238 #include "OSGPointerMFieldCommon.inl"
 239
 240 #endif // _OSGPOINTERMFIELDCOMMON_H_