Source/System/FieldContainer/Attachments/OSGStringAttributeMap.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-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 _OSGSTRINGATTRIBUTEMAP_H_
  40 #define _OSGSTRINGATTRIBUTEMAP_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGStringAttributeMapBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 /*! \brief StringAttributeMap class. See \ref
  50     PageSystemStringAttributeMap for a description.
  51     \ingroup GrpSystemFieldContainerAttachments
  52     \ingroup GrpLibOSGSystem
  53     \includebasedoc
  54  */
  55
  56 class OSG_SYSTEM_DLLMAPPING StringAttributeMap : public StringAttributeMapBase
  57 {
  58   protected:
  59
  60     /*==========================  PUBLIC  =================================*/
  61
  62   public:
  63
  64     typedef StringAttributeMapBase Inherited;
  65     typedef StringAttributeMap     Self;
  66
  67     /*---------------------------------------------------------------------*/
  68     /*! \name                      Sync                                    */
  69     /*! \{                                                                 */
  70
  71     virtual void changed(ConstFieldMaskArg whichField,
  72                          UInt32            origin,
  73                          BitVector         details);
  74
  75     /*! \}                                                                 */
  76     /*---------------------------------------------------------------------*/
  77     /*! \name                     Output                                   */
  78     /*! \{                                                                 */
  79
  80     virtual void dump(      UInt32     uiIndent = 0,
  81                       const BitVector  bvFlags  = 0) const;
  82
  83
  84     /*! \}                                                                 */
  85
  86     inline const MFString& getKeys() const;
  87
  88     void setAttribute(const std::string& key, const std::string& value);
  89
  90     inline bool hasAttribute(const std::string& key) const;
  91
  92     bool getAttribute(const std::string& key, std::string& value) const;
  93
  94     inline const std::string getAttribute(const std::string& key) const;
  95
  96     inline std::string& operator[](const std::string& key);
  97
  98
  99     /*=========================  PROTECTED  ===============================*/
 100
 101   protected:
 102
 103     // Variables should all be in StringAttributeMapBase.
 104
 105     /*---------------------------------------------------------------------*/
 106     /*! \name                  Constructors                                */
 107     /*! \{                                                                 */
 108
 109     StringAttributeMap(void);
 110     StringAttributeMap(const StringAttributeMap &source);
 111
 112     /*! \}                                                                 */
 113     /*---------------------------------------------------------------------*/
 114     /*! \name                   Destructors                                */
 115     /*! \{                                                                 */
 116
 117     virtual ~StringAttributeMap(void);
 118
 119     /*! \}                                                                 */
 120     /*---------------------------------------------------------------------*/
 121     /*! \name                      Init                                    */
 122     /*! \{                                                                 */
 123
 124     static void initMethod(InitPhase ePhase);
 125
 126     /*! \}                                                                 */
 127     /*==========================  PRIVATE  ================================*/
 128
 129   private:
 130
 131     friend class FieldContainer;
 132     friend class StringAttributeMapBase;
 133
 134     // prohibit default functions (move to 'public' if you need one)
 135     void operator =(const StringAttributeMap &source);
 136 };
 137
 138 typedef StringAttributeMap *StringAttributeMapP;
 139
 140 /*---------------------------------------------------------------------*/
 141 /*! \name              StringAttributeMap Util                         */
 142 /*! \{                                                                 */
 143
 144 /*! \ingroup GrpSystemFieldContainerUtils
 145  */
 146
 147 OSG_SYSTEM_DLLMAPPING
 148 StringAttributeMapTransitPtr stringAttributeMap(
 149     AttachmentContainer *container);
 150
 151 /*! \}                                                                 */
 152
 153 OSG_END_NAMESPACE
 154
 155 #include "OSGStringAttributeMapBase.inl"
 156 #include "OSGStringAttributeMap.inl"
 157
 158 #endif /* _OSGSTRINGATTRIBUTEMAP_H_ */