Source/System/FieldContainer/Attachments/OSGStringAttributeMap.inl

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-2006 by the OpenSG Forum                 *
   6  *                                                                           *
   7  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
   8  *                                                                           *
   9 \*---------------------------------------------------------------------------*/
  10 /*---------------------------------------------------------------------------*\
  11  *                                License                                    *
  12  *                                                                           *
  13  * This library is free software; you can redistribute it and/or modify it   *
  14  * under the terms of the GNU Library General Public License as published    *
  15  * by the Free Software Foundation, version 2.                               *
  16  *                                                                           *
  17  * This library is distributed in the hope that it will be useful, but       *
  18  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  20  * Library General Public License for more details.                          *
  21  *                                                                           *
  22  * You should have received a copy of the GNU Library General Public         *
  23  * License along with this library; if not, write to the Free Software       *
  24  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  25  *                                                                           *
  26 \*---------------------------------------------------------------------------*/
  27 /*---------------------------------------------------------------------------*\
  28  *                                Changes                                    *
  29  *                                                                           *
  30  *                                                                           *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35 \*---------------------------------------------------------------------------*/
  36
  37 //---------------------------------------------------------------------------
  38 //  Includes
  39 //---------------------------------------------------------------------------
  40
  41 OSG_BEGIN_NAMESPACE
  42
  43 /*! Provides read-only access to the keys multi-field of this attribute map.
  44     Among other things, this can be used for iterating over the contents of
  45     this attribute map.
  46  */
  47
  48 inline
  49 const MFString& StringAttributeMap::getKeys(void) const
  50 {
  51     return *StringAttributeMapBase::getMFKeys();
  52 }
  53
  54 /*! Queries this attribute map attachment to determine if it includes the
  55     named key. If it does, then true is returned. Otherwise, false is
  56     returned.
  57  */
  58
  59 inline
  60 bool StringAttributeMap::hasAttribute(const std::string &key) const
  61 {
  62     return getKeys().find(key) != getKeys().end();
  63 }
  64
  65 /*! Attempts to look up the value associated with the named key in this
  66     attribute map. If this attribute map does not include \p key, then an
  67     empty string is returned. Otherwise, a copy of the value associated
  68     with the named key is returned.
  69  */
  70
  71 inline
  72 const std::string StringAttributeMap::getAttribute(const std::string &key) const
  73 {
  74     std::string value;
  75     getAttribute(key, value);
  76     return value;
  77 }
  78
  79 /*! Provides index access to this attribute map following the semantics of
  80     the STL map type. If this attribute map contains \p key, a reference to
  81     the value associated with that key is returned. Otherwise, \p key is
  82     added to this attribute map with an empty string as the value, and a
  83     reference to that newly added value is returned.
  84
  85     It is the responsibility of the caller to use OSG::beginEditCP() and
  86     OSG::endEditCP() accordingly. Both fields of this container (Keys and
  87     Values) may be edited by this method depending on the usage. In the case
  88     when a key/value pair is being changed or added, the fields will be
  89     edited. In the case when an unknown key is used for querying a value,
  90     both fields will be edited. When this operator is used solely to query an
  91     existing key's value, then no fields will be edited.
  92
  93     @see hasAttribute()
  94     @see setAttribute()
  95     @see getAttribute()
  96  */
  97
  98 inline
  99 std::string &StringAttributeMap::operator[](const std::string &key)
 100 {
 101     MFString *keys   = this->StringAttributeMapBase::editMFKeys();
 102     MFString *values = this->StringAttributeMapBase::editMFValues();
 103
 104     unsigned int index(0);
 105     for (MFString::iterator i = keys->begin();
 106             i != keys->end(); ++i, ++index )
 107     {
 108         if ( *i == key )
 109         {
 110             return (*values)[index];
 111         }
 112     }
 113
 114     keys->push_back(key);
 115     values->push_back(std::string(""));
 116
 117     // The value we want to return is at the end of _mfValues.
 118     return (*values)[values->size() - 1];
 119 }
 120
 121 OSG_END_NAMESPACE