Source/System/FileIO/OSB/OSGOSBGenericElement.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *                   Copyright (C) 2007 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 _OSGOSBGENERICELEMENT_H_
  40 #define _OSGOSBGENERICELEMENT_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGConfig.h"
  46 #include "OSGFileIODef.h"
  47 #include "OSGOSBCommonElement.h"
  48 #include "OSGOSBElementFactoryHelper.h"
  49
  50 #include "OSGFieldContainer.h"
  51
  52 #include <string>
  53
  54 OSG_BEGIN_NAMESPACE
  55
  56 class OSBRootElement;
  57
  58 /*! \ingroup GrpFileIOOSB
  59     \nohierarchy
  60  */
  61
  62 class OSG_FILEIO_DLLMAPPING OSBGenericElement : public OSBCommonElement
  63 {
  64     /*==========================  PUBLIC  =================================*/
  65   public:
  66     /*---------------------------------------------------------------------*/
  67     /*! \name Types                                                        */
  68     /*! \{                                                                 */
  69
  70     typedef OSBCommonElement  Inherited;
  71     typedef OSBGenericElement Self;
  72
  73     /*! \}                                                                 */
  74     /*---------------------------------------------------------------------*/
  75     /*! \name Constructor                                                  */
  76     /*! \{                                                                 */
  77
  78     OSBGenericElement(OSBRootElement *root);
  79
  80     /*! \}                                                                 */
  81     /*---------------------------------------------------------------------*/
  82     /*! \name Destructor                                                   */
  83     /*! \{                                                                 */
  84
  85     virtual ~OSBGenericElement(void);
  86
  87     /*! \}                                                                 */
  88     /*---------------------------------------------------------------------*/
  89     /*! \name Reading                                                      */
  90     /*! \{                                                                 */
  91
  92     virtual void read    (const std::string &typeName);
  93     virtual void postRead(      void                 );
  94
  95     /*! \}                                                                 */
  96     /*---------------------------------------------------------------------*/
  97     /*! \name Writing                                                      */
  98     /*! \{                                                                 */
  99
 100     virtual void preWrite(FieldContainer * const fc);
 101     virtual void write   (void                     );
 102
 103     /*! \}                                                                 */
 104     /*==========================  PRIVATE  ================================*/
 105   private:
 106     /*!\brief prohibit default function (move to 'public' if needed)       */
 107     OSBGenericElement(const OSBGenericElement &source);
 108     /*!\brief prohibit default function (move to 'public' if needed)       */
 109     void operator =(const OSBGenericElement &source);
 110
 111     static OSBDefaultElementRegistrationHelper<OSBGenericElement> _regHelper;
 112 };
 113
 114 OSG_END_NAMESPACE
 115
 116 #endif /* _OSGOSBGENERICELEMENT_H_ */