Source/System/FileIO/Base/OSGIOFileTypeBase.inl

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *                   Copyright (C) 2008 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 OSG_BEGIN_NAMESPACE
  40
  41 /*! Returns whether an option with the given \a name is present in \a optSet.
  42
  43     \param[in] optSet OptionSet to check.
  44     \param[in] name   Name of the option.
  45     \return Whether the option is present.
  46  */
  47 inline bool
  48 IOFileTypeBase::hasOption(const OptionSet &optSet, const std::string &name)
  49 {
  50     return (optSet.find(name) != optSet.end());
  51 }
  52
  53 /*! Attempts to set option \a name to \a value in \a optSet.
  54     If successful \c true is returned, false otherwise.
  55     For the operation to succeed a \c boost::lexical_cast<> from the given type
  56     has to succeed, usually that means an appropriate overload of
  57     \c operator<< has to be available.
  58
  59     \param[in] optSet OptionSet to modify.
  60     \param[in] name Name of the option.
  61     \param[in] value Value of the option.
  62     \return Whether the value was set successfully.
  63  */
  64 template <class ValueTypeT>
  65 inline bool
  66 IOFileTypeBase::setOptionAs(
  67     OptionSet &optSet, const std::string &name, const ValueTypeT &value)
  68 {
  69     bool retVal = false;
  70
  71     try
  72     {
  73         setOption(optSet, name, boost::lexical_cast<std::string>(value));
  74         retVal = true;
  75     }
  76     catch(boost::bad_lexical_cast &blc)
  77     {
  78         SWARNING << "IOFileTypeBase::setOptionAs: Failed to store value "
  79                  << "for option [" << name << "] : "
  80                  << blc.what() << std::endl;
  81     }
  82
  83     return retVal;
  84 }
  85
  86 /*! Attempts to return the \a value associated with option \a name in \a optSet
  87     as the requested type.
  88     If the option is not present \c false is returned, \c true otherwise and
  89     only in this case value is being set.
  90     For the operation to succeed a \c boost::lexical_cast<> to the requested
  91     type has to succeed, usually that means an appropriate overload of
  92     \c operator>> has to be available.
  93
  94     \param[in]  optSet OptionSet to read.
  95     \param[in]  name Name of the option.
  96     \param[out] value Value of option.
  97     \return Whether the option is present.
  98  */
  99 template <class ValueTypeT>
 100 inline bool
 101 IOFileTypeBase::getOptionAs(
 102     const OptionSet &optSet, const std::string &name, ValueTypeT &value)
 103 {
 104     bool        retVal   = false;
 105     std::string valueStr;
 106
 107     if(getOption(optSet, name, valueStr) == true)
 108     {
 109         try
 110         {
 111             value  = boost::lexical_cast<ValueTypeT>(valueStr);
 112             retVal = true;
 113         }
 114         catch(boost::bad_lexical_cast &blc)
 115         {
 116             SWARNING << "IOFileTypeBase::getOptionAs: Failed to extract "
 117                      << "value of option [" << name << "] from string ["
 118                      << valueStr << "] : "
 119                      << blc.what() << std::endl;
 120         }
 121     }
 122
 123     return retVal;
 124 }
 125
 126
 127 /*! Returns the currently active option set, i.e. the top of the options stack.
 128  */
 129 inline IOFileTypeBase::OptionSet const  &
 130     IOFileTypeBase::getOptions(void) const
 131 {
 132     return _optStack.top();
 133 }
 134
 135 /*! Returns the currently active option set, i.e. the top of the options stack.
 136  */
 137 inline IOFileTypeBase::OptionSet &
 138     IOFileTypeBase::editOptions(void)
 139 {
 140     return _optStack.top();
 141 }
 142
 143 /*! Returns whether an option with the given \a name is present.
 144
 145     \param[in] name Name of the option.
 146     \return Whether the option is present.
 147  */
 148 inline bool
 149     IOFileTypeBase::hasOption(std::string const &name) const
 150 {
 151     return hasOption(_optStack.top(), name);
 152 }
 153
 154 /*! Attempts to set option \a name to \a value.
 155     If successful \c true is returned, false otherwise.
 156     For the operation to succeed a \c boost::lexical_cast<> from the given type
 157     has to succeed, usually that means an appropriate overload of
 158     \c operator<< has to be available.
 159
 160     \param[in] name Name of the option.
 161     \param[in] value Value of the option.
 162     \return Whether the value was set successfully.
 163  */
 164 template <class ValueTypeT>
 165 inline bool
 166     IOFileTypeBase::setOptionAs(
 167         const std::string &name, const ValueTypeT &value)
 168 {
 169     return setOptionAs(_optStack.top(), name, value);
 170 }
 171
 172 /*! Sets the option \a name to \a value overwriting any previous value.
 173
 174     \param[in] name Name of the option.
 175     \param[in] value Value of the option.
 176  */
 177 inline void
 178 IOFileTypeBase::setOption(const std::string &name, const std::string &value)
 179 {
 180     setOption(_optStack.top(), name, value);
 181 }
 182
 183 /*! Removes the option \a name. If the option is not present
 184     \c false is returned, \c true otherwise.
 185
 186     \param[in] name   Name of the option.
 187     \return Whether the option was successfully removed.
 188  */
 189 inline bool
 190 IOFileTypeBase::unsetOption(const std::string &name)
 191 {
 192     return unsetOption(_optStack.top(), name);
 193 }
 194
 195 /*! Attempts to return the value associated with option \a name in \a value
 196     as the requested type.
 197     If the option is not present \c false is returned, \c true otherwise and
 198     only in this case value is being set.
 199     For the operation to succeed a \c boost::lexical_cast<> to the requested
 200     type has to succeed, usually that means an appropriate overload of
 201     \c operator>> has to be available.
 202
 203     \param[in]  name Name of the option.
 204     \param[out] value Value of option.
 205     \return Whether the option is present.
 206  */
 207 template <class ValueTypeT>
 208 inline bool
 209     IOFileTypeBase::getOptionAs(
 210         const std::string &name, ValueTypeT &value) const
 211 {
 212     return getOptionAs(_optStack.top(), name, value);
 213 }
 214
 215 /*! Attempts to return the \a value associated with option \a name.
 216     If the option is not present \c false is returned,
 217     \c true otherwise and only in this case value is being set.
 218
 219     \param[in]  name   Name of the option.
 220     \param[out] value  Value of option.
 221     \return Whether the option is present.
 222  */
 223 inline bool
 224 IOFileTypeBase::getOption(const std::string &name, std::string &value) const
 225 {
 226     return getOption(_optStack.top(), name, value);
 227 }
 228
 229 OSG_END_NAMESPACE