Source/Base/Field/OSGField.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *             Copyright (C) 2000-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 _OSGFIELD_H_
  40 #define _OSGFIELD_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGBaseTypes.h"
  46 #include "OSGFieldForwards.h"
  47
  48 #include <string>
  49
  50 OSG_BEGIN_NAMESPACE
  51
  52 /*! Base class for all fields
  53     \ingroup GrpBaseField
  54     \ingroup GrpLibOSGBase
  55  */
  56
  57 class OSG_BASE_DLLMAPPING Field
  58 {
  59     /*==========================  PUBLIC  =================================*/
  60
  61   public:
  62
  63     static const UInt32 MFShareMask      = 0x000F;
  64     static const UInt32 FLocalMask       = 0x00F0;
  65     static const UInt32 FAccessMask      = 0x0F00;
  66
  67     static const UInt32 MFSharedSync     = 0x0000;
  68     static const UInt32 MFCopySync       = 0x0001;
  69     static const UInt32 MFNullCheckSync  = 0x0002;
  70
  71     static const UInt32 FGlobal          = 0x0000;
  72     static const UInt32 FThreadLocal     = 0x0010;
  73     static const UInt32 FClusterLocal    = 0x0020;
  74
  75     static const UInt32 FStdAccess       = 0x0100;
  76     static const UInt32 FNullCheckAccess = 0x0200;
  77     static const UInt32 FCustomAccess    = 0x0400;
  78
  79     static const UInt32 MFDefaultFlags   = (MFSharedSync |
  80                                             FGlobal      |
  81                                             FStdAccess    );
  82     static const UInt32 SFDefaultFlags   = (FGlobal      |
  83                                             FStdAccess    );
  84     static const UInt32  FDefaultFlags   = (FGlobal      |
  85                                             FStdAccess    );
  86
  87     /*---------------------------------------------------------------------*/
  88     /*! \name                   Destructor                                 */
  89     /*! \{                                                                 */
  90
  91     ~Field(void);
  92
  93     /*! \}                                                                 */
  94     /*---------------------------------------------------------------------*/
  95     /*! \name                      Get                                     */
  96     /*! \{                                                                 */
  97
  98     /*! \}                                                                 */
  99     /*---------------------------------------------------------------------*/
 100     /*! \name                   String IO                                  */
 101     /*! \{                                                                 */
 102
 103     /*! \}                                                                 */
 104     /*---------------------------------------------------------------------*/
 105     /*! \name                      Set                                     */
 106     /*! \{                                                                 */
 107
 108     /*! \}                                                                 */
 109     /*---------------------------------------------------------------------*/
 110     /*! \name                        Dump                                  */
 111     /*! \{                                                                 */
 112
 113     /*! \}                                                                 */
 114     /*=========================  PROTECTED  ===============================*/
 115
 116   protected:
 117
 118     /*---------------------------------------------------------------------*/
 119     /*! \name                   Constructors                               */
 120     /*! \{                                                                 */
 121
 122     Field(void);
 123     Field(const Field &source);
 124
 125     /*! \}                                                                 */
 126     /*==========================  PRIVATE  ================================*/
 127
 128   private:
 129
 130     /*!\brief prohibit default function (move to 'public' if needed) */
 131     void operator =(const Field &source);
 132 };
 133
 134 OSG_END_NAMESPACE
 135
 136 #endif /* _OSGFIELD_HPP_ */
 137
 138