Source/Contrib/ComputeBase/Base/OSGAlgorithmComputeElementBase.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-2013 by the OpenSG Forum                 *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  * contact: dirk@opensg.org, gerrit.voss@vossg.org, carsten_neumann@gmx.net  *
  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 /*****************************************************************************\
  40  *****************************************************************************
  41  **                                                                         **
  42  **                  This file is automatically generated.                  **
  43  **                                                                         **
  44  **          Any changes made to this file WILL be lost when it is          **
  45  **           regenerated, which can become necessary at any time.          **
  46  **                                                                         **
  47  **     Do not change this file, changes should be done in the derived      **
  48  **     class AlgorithmComputeElement
  49  **                                                                         **
  50  *****************************************************************************
  51 \*****************************************************************************/
  52
  53
  54 #ifndef _OSGALGORITHMCOMPUTEELEMENTBASE_H_
  55 #define _OSGALGORITHMCOMPUTEELEMENTBASE_H_
  56 #ifdef __sgi
  57 #pragma once
  58 #endif
  59
  60
  61 #include "OSGConfig.h"
  62 #include "OSGContribComputeBaseDef.h"
  63
  64 //#include "OSGBaseTypes.h"
  65
  66 #include "OSGComputeElement.h" // Parent
  67
  68 #include "OSGComputeAlgorithmFields.h"  // Algorithm type
  69
  70 #include "OSGAlgorithmComputeElementFields.h"
  71
  72 OSG_BEGIN_NAMESPACE
  73
  74
  75 class AlgorithmComputeElement;
  76
  77 //! \brief AlgorithmComputeElement Base Class.
  78
  79 class OSG_CONTRIBCOMPUTEBASE_DLLMAPPING AlgorithmComputeElementBase : public ComputeElement
  80 {
  81   public:
  82
  83     typedef ComputeElement Inherited;
  84     typedef ComputeElement ParentContainer;
  85
  86     typedef Inherited::TypeObject TypeObject;
  87     typedef TypeObject::InitPhase InitPhase;
  88
  89     OSG_GEN_INTERNALPTR(AlgorithmComputeElement);
  90
  91     /*==========================  PUBLIC  =================================*/
  92
  93   public:
  94
  95     enum
  96     {
  97         AlgorithmFieldId = Inherited::NextFieldId,
  98         NextFieldId = AlgorithmFieldId + 1
  99     };
 100
 101     static const OSG::BitVector AlgorithmFieldMask =
 102         (TypeTraits<BitVector>::One << AlgorithmFieldId);
 103     static const OSG::BitVector NextFieldMask =
 104         (TypeTraits<BitVector>::One << NextFieldId);
 105
 106     typedef SFUnrecComputeAlgorithmPtr SFAlgorithmType;
 107
 108     /*---------------------------------------------------------------------*/
 109     /*! \name                    Class Get                                 */
 110     /*! \{                                                                 */
 111
 112     static FieldContainerType &getClassType   (void);
 113     static UInt32              getClassTypeId (void);
 114     static UInt16              getClassGroupId(void);
 115
 116     /*! \}                                                                 */
 117     /*---------------------------------------------------------------------*/
 118     /*! \name                FieldContainer Get                            */
 119     /*! \{                                                                 */
 120
 121     virtual       FieldContainerType &getType         (void);
 122     virtual const FieldContainerType &getType         (void) const;
 123
 124     virtual       UInt32              getContainerSize(void) const;
 125
 126     /*! \}                                                                 */
 127     /*---------------------------------------------------------------------*/
 128     /*! \name                    Field Get                                 */
 129     /*! \{                                                                 */
 130
 131             const SFUnrecComputeAlgorithmPtr *getSFAlgorithm      (void) const;
 132                   SFUnrecComputeAlgorithmPtr *editSFAlgorithm      (void);
 133
 134
 135                   ComputeAlgorithm * getAlgorithm      (void) const;
 136
 137     /*! \}                                                                 */
 138     /*---------------------------------------------------------------------*/
 139     /*! \name                    Field Set                                 */
 140     /*! \{                                                                 */
 141
 142             void setAlgorithm      (ComputeAlgorithm * const value);
 143
 144     /*! \}                                                                 */
 145     /*---------------------------------------------------------------------*/
 146     /*! \name                Ptr Field Set                                 */
 147     /*! \{                                                                 */
 148
 149     /*! \}                                                                 */
 150     /*---------------------------------------------------------------------*/
 151     /*! \name                Ptr MField Set                                */
 152     /*! \{                                                                 */
 153
 154     /*! \}                                                                 */
 155     /*---------------------------------------------------------------------*/
 156     /*! \name                   Binary Access                              */
 157     /*! \{                                                                 */
 158
 159     virtual SizeT  getBinSize (ConstFieldMaskArg  whichField);
 160     virtual void   copyToBin  (BinaryDataHandler &pMem,
 161                                ConstFieldMaskArg  whichField);
 162     virtual void   copyFromBin(BinaryDataHandler &pMem,
 163                                ConstFieldMaskArg  whichField);
 164
 165
 166     /*! \}                                                                 */
 167     /*---------------------------------------------------------------------*/
 168     /*! \name                   Construction                               */
 169     /*! \{                                                                 */
 170
 171     static  AlgorithmComputeElementTransitPtr  create          (void);
 172     static  AlgorithmComputeElement           *createEmpty     (void);
 173
 174     static  AlgorithmComputeElementTransitPtr  createLocal     (
 175                                                BitVector bFlags = FCLocal::All);
 176
 177     static  AlgorithmComputeElement            *createEmptyLocal(
 178                                               BitVector bFlags = FCLocal::All);
 179
 180     static  AlgorithmComputeElementTransitPtr  createDependent  (BitVector bFlags);
 181
 182     /*! \}                                                                 */
 183     /*---------------------------------------------------------------------*/
 184     /*! \name                       Copy                                   */
 185     /*! \{                                                                 */
 186
 187     virtual FieldContainerTransitPtr shallowCopy     (void) const;
 188     virtual FieldContainerTransitPtr shallowCopyLocal(
 189                                        BitVector bFlags = FCLocal::All) const;
 190     virtual FieldContainerTransitPtr shallowCopyDependent(
 191                                                       BitVector bFlags) const;
 192
 193     /*! \}                                                                 */
 194     /*=========================  PROTECTED  ===============================*/
 195
 196   protected:
 197
 198     static TypeObject _type;
 199
 200     static       void   classDescInserter(TypeObject &oType);
 201     static const Char8 *getClassname     (void             );
 202
 203     /*---------------------------------------------------------------------*/
 204     /*! \name                      Fields                                  */
 205     /*! \{                                                                 */
 206
 207     SFUnrecComputeAlgorithmPtr _sfAlgorithm;
 208
 209     /*! \}                                                                 */
 210     /*---------------------------------------------------------------------*/
 211     /*! \name                   Constructors                               */
 212     /*! \{                                                                 */
 213
 214     AlgorithmComputeElementBase(void);
 215     AlgorithmComputeElementBase(const AlgorithmComputeElementBase &source);
 216
 217     /*! \}                                                                 */
 218     /*---------------------------------------------------------------------*/
 219     /*! \name                   Destructors                                */
 220     /*! \{                                                                 */
 221
 222     virtual ~AlgorithmComputeElementBase(void);
 223
 224     /*! \}                                                                 */
 225     /*---------------------------------------------------------------------*/
 226     /*! \name                     onCreate                                */
 227     /*! \{                                                                 */
 228
 229     void onCreate(const AlgorithmComputeElement *source = NULL);
 230
 231     /*! \}                                                                 */
 232     /*---------------------------------------------------------------------*/
 233     /*! \name                    Generic Field Access                      */
 234     /*! \{                                                                 */
 235
 236      GetFieldHandlePtr  getHandleAlgorithm       (void) const;
 237      EditFieldHandlePtr editHandleAlgorithm      (void);
 238
 239     /*! \}                                                                 */
 240     /*---------------------------------------------------------------------*/
 241     /*! \name                       Sync                                   */
 242     /*! \{                                                                 */
 243
 244 #ifdef OSG_MT_CPTR_ASPECT
 245     virtual void execSyncV(      FieldContainer    &oFrom,
 246                                  ConstFieldMaskArg  whichField,
 247                                  AspectOffsetStore &oOffsets,
 248                                  ConstFieldMaskArg  syncMode  ,
 249                            const UInt32             uiSyncInfo);
 250
 251             void execSync (      AlgorithmComputeElementBase *pFrom,
 252                                  ConstFieldMaskArg  whichField,
 253                                  AspectOffsetStore &oOffsets,
 254                                  ConstFieldMaskArg  syncMode  ,
 255                            const UInt32             uiSyncInfo);
 256 #endif
 257
 258     /*! \}                                                                 */
 259     /*---------------------------------------------------------------------*/
 260     /*! \name                       Edit                                   */
 261     /*! \{                                                                 */
 262
 263     /*! \}                                                                 */
 264     /*---------------------------------------------------------------------*/
 265     /*! \name                     Aspect Create                            */
 266     /*! \{                                                                 */
 267
 268 #ifdef OSG_MT_CPTR_ASPECT
 269     virtual FieldContainer *createAspectCopy(
 270                                     const FieldContainer *pRefAspect) const;
 271 #endif
 272
 273     /*! \}                                                                 */
 274     /*---------------------------------------------------------------------*/
 275     /*! \name                       Edit                                   */
 276     /*! \{                                                                 */
 277     /*! \}                                                                 */
 278     /*---------------------------------------------------------------------*/
 279     /*! \name                       Sync                                   */
 280     /*! \{                                                                 */
 281
 282     virtual void resolveLinks(void);
 283
 284     /*! \}                                                                 */
 285     /*==========================  PRIVATE  ================================*/
 286
 287   private:
 288     /*---------------------------------------------------------------------*/
 289
 290     // prohibit default functions (move to 'public' if you need one)
 291     void operator =(const AlgorithmComputeElementBase &source);
 292 };
 293
 294 typedef AlgorithmComputeElementBase *AlgorithmComputeElementBaseP;
 295
 296 typedef CoredNodeRefPtr  <AlgorithmComputeElement> AlgorithmComputeElementNodeRefPtr;
 297 typedef CoredNodeMTRefPtr<AlgorithmComputeElement> AlgorithmComputeElementNodeMTRefPtr;
 298
 299 OSG_END_NAMESPACE
 300
 301 #endif /* _OSGALGORITHMCOMPUTEELEMENTBASE_H_ */