Source/Base/FieldContainer/Fields/OSGFieldContainerFieldTraits.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *           Copyright (C) 2003 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 _OSGFIELDCONTAINERFIELDTRAITS_H_
  40 #define _OSGFIELDCONTAINERFIELDTRAITS_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGFieldTraits.h"
  46 #include "OSGDataType.h"
  47
  48 #include "OSGContainerForwards.h"
  49 #include "OSGFieldContainerFactory.h"
  50 #include "OSGFieldContainer.h"
  51 #include "OSGBaseRefCountPoliciesFwd.h"
  52 #include "OSGContainerRefCountPoliciesFwd.h"
  53
  54 OSG_BEGIN_NAMESPACE
  55
  56
  57 /*! \ingroup GrpBaseFieldContainerFieldTraits
  58     \ingroup GrpLibOSGBase
  59  */
  60
  61 template<class ValueT, Int32 iNamespace = 0>
  62 struct FieldTraitsFCPtrBase :
  63     public FieldTraitsTemplateBase<ValueT, iNamespace>
  64 {
  65     static const bool bIsPointerField = true;
  66
  67     static const Char8 *getSPName(void)
  68     {
  69         return "FieldContainerPtrSFieldBase";
  70     }
  71
  72     static const Char8 *getMPName(void)
  73     {
  74         return "FieldContainerPtrMFieldBase";
  75     }
  76
  77     static SizeT  getBinSize(FieldContainer * const &)
  78     {
  79         return sizeof(UInt32);
  80     }
  81
  82     static SizeT  getBinSize(FieldContainer * const *,
  83                              SizeT                   uiNumObjects)
  84     {
  85         return sizeof(UInt32) * uiNumObjects;
  86     }
  87
  88     static void copyToBin(BinaryDataHandler         &pMem,
  89                           FieldContainer    * const &pObject)
  90     {
  91         UInt32 containerId;
  92
  93         if(pObject == NULL)
  94         {
  95             // containerId=0 indicates an Null Ptr
  96             containerId = 0;
  97         }
  98         else
  99         {
 100             containerId = pObject->getId();
 101         }
 102
 103         pMem.putValue(containerId);
 104     }
 105
 106     static void copyToBin(BinaryDataHandler         &pMem,
 107                           FieldContainer    * const *pObjectStore,
 108                           SizeT                      uiNumObjects)
 109     {
 110         for(SizeT i = 0; i < uiNumObjects; i++)
 111         {
 112             copyToBin(pMem, pObjectStore[i]);
 113         }
 114     }
 115
 116     static void copyFromBin(BinaryDataHandler  &pMem,
 117                             FieldContainer    *&pObject)
 118     {
 119         UInt32 containerId;
 120
 121         pMem.getValue(containerId);
 122
 123         if(0 != containerId)
 124         {
 125             pObject =
 126                 FieldContainerFactory::the()->getMappedContainer(containerId);
 127         }
 128         else
 129         {
 130             pObject = NULL;
 131         }
 132     }
 133
 134     static void copyFromBin(BinaryDataHandler & pMem,
 135                             FieldContainer    **pObjectStore,
 136                             SizeT               uiNumObjects)
 137     {
 138         for(SizeT i = 0; i < uiNumObjects; i++)
 139         {
 140             copyFromBin(pMem, pObjectStore[i]);
 141         }
 142     }
 143 };
 144
 145
 146 /*! \ingroup GrpBaseFieldContainerFieldTraits
 147     \ingroup GrpLibOSGBase
 148  */
 149
 150 template <>
 151 struct FieldTraits<FieldContainer *> :
 152     public FieldTraitsFCPtrBase<FieldContainer *>
 153 {
 154   private:
 155
 156     static  PointerType                    _type;
 157     static  DataType                       _mapType;
 158
 159   public:
 160
 161     static const bool bIsPointerField = true;
 162
 163     typedef FieldTraits<FieldContainer *>  Self;
 164
 165
 166     enum             { Convertible = Self::NotConvertible                 };
 167
 168     static OSG_BASE_DLLMAPPING
 169                  DataType &getType (void);
 170     static OSG_BASE_DLLMAPPING
 171                  DataType &getMapType (void);
 172
 173     template<typename RefCountPolicy> inline
 174     static const Char8    *getSName(void);
 175
 176     template<typename RefCountPolicy> inline
 177     static const Char8    *getMName(void);
 178 };
 179
 180
 181 template<> inline
 182 const Char8 *FieldTraits<FieldContainer *,
 183                          0               >::getSName<RecordedRefCountPolicy>(
 184                              void)
 185 {
 186     return "SFRecFieldContainerPtr";
 187 }
 188
 189 template<> inline
 190 const Char8 *FieldTraits<FieldContainer *,
 191                          0               >::getSName<UnrecordedRefCountPolicy>(
 192                              void)
 193 {
 194     return "SFUnrecFieldContainerPtr";
 195 }
 196
 197 template<> inline
 198 const Char8 *FieldTraits<FieldContainer *,
 199                          0               >::getSName<WeakRefCountPolicy>(void)
 200 {
 201     return "SFWeakFieldContainerPtr";
 202 }
 203
 204 template<> inline
 205 const Char8 *FieldTraits<FieldContainer *,
 206                          0               >::getSName<NoRefCountPolicy>(void)
 207 {
 208     return "SFUnrefdFieldContainerPtr";
 209 }
 210
 211
 212
 213 template<> inline
 214 const Char8 *FieldTraits<FieldContainer *,
 215                          0               >::getMName<RecordedRefCountPolicy>(
 216                              void)
 217 {
 218     return "MFRecFieldContainerPtr";
 219 }
 220
 221 template<> inline
 222 const Char8 *FieldTraits<FieldContainer *,
 223                          0               >::getMName<UnrecordedRefCountPolicy>(
 224                              void)
 225 {
 226     return "MFUnrecFieldContainerPtr";
 227 }
 228
 229 template<> inline
 230 const Char8 *FieldTraits<FieldContainer *,
 231                          0               >::getMName<WeakRefCountPolicy>(void)
 232 {
 233     return "MFWeakFieldContainerPtr";
 234 }
 235
 236 template<> inline
 237 const Char8 *FieldTraits<FieldContainer *,
 238                          0               >::getMName<NoRefCountPolicy>(void)
 239 {
 240     return "MFUnrefdFieldContainerPtr";
 241 }
 242
 243
 244 /*! \ingroup GrpBaseFieldContainerFieldTraits
 245     \ingroup GrpLibOSGBase
 246  */
 247
 248 template <>
 249 struct FieldTraits<FieldContainer *, 1> :
 250     public FieldTraitsFCPtrBase<FieldContainer *, 1>
 251 {
 252   private:
 253
 254 //    static  DataType                                _type;
 255
 256   public:
 257
 258     static const bool bIsPointerField = true;
 259
 260     typedef FieldTraits<FieldContainer *, 1>        Self;
 261
 262
 263     enum             { Convertible = Self::NotConvertible };
 264
 265     static OSG_BASE_DLLMAPPING
 266                  DataType &getType (void);
 267
 268     static const Char8    *getSName(void)
 269     {
 270         return "SFParentFieldContainerPtr";
 271     }
 272
 273     static const Char8    *getMName(void)
 274     {
 275         return "MFParentFieldContainerPtr";
 276     }
 277 };
 278
 279 OSG_END_NAMESPACE
 280
 281 #endif /* _OSGFIELDCONTAINERFIELDTRAITS_H_ */