Source/System/FileIO/OSB/OSGOSBNameElement.h

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