Param.hh

Go to the documentation of this file.

/*
 * Copyright 2012 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/

#ifndef _SDF_PARAM_HH_
#define _SDF_PARAM_HH_

// See: https://bugreports.qt-project.org/browse/QTBUG-22829
#ifndef Q_MOC_RUN
  #include <boost/lexical_cast.hpp>
  #include <boost/any.hpp>
  #include <boost/variant.hpp>
#endif

#include <memory>
#include <functional>
#include <algorithm>
#include <typeinfo>
#include <string>
#include <vector>
#include <ignition/math.hh>

#include "sdf/Console.hh"
#include "sdf/system_util.hh"

#ifndef _WIN32
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
#endif
#include "sdf/Types.hh"
#ifndef _WIN32
#pragma GCC diagnostic pop
#endif

namespace sdf
{
  class SDFORMAT_VISIBLE Param;

  typedef std::shared_ptr<Param> ParamPtr;

  typedef std::vector<ParamPtr> Param_V;

  class ParamPrivate;

  class SDFORMAT_VISIBLE Param
  {
    public: Param(const std::string &_key, const std::string &_typeName,
                  const std::string &_default, bool _required,
                  const std::string &_description = "");

    public: virtual ~Param();

    public: std::string GetAsString() const;

    public: std::string GetDefaultAsString() const;

    public: bool SetFromString(const std::string &_value);

    public: void Reset();

    public: const std::string &GetKey() const;

    public: const std::type_info &GetType() const SDF_DEPRECATED(4.0);

    public: template<typename Type>
            bool IsType() const;

    public: const std::string &GetTypeName() const;

    public: bool GetRequired() const;

    public: bool GetSet() const;

    public: ParamPtr Clone() const;

    public: template<typename T>
            void SetUpdateFunc(T _updateFunc);

    public: void Update();

    public: template<typename T>
            bool Set(const T &_value);

    public: bool GetAny(boost::any &_anyVal) const;

    public: template<typename T>
            bool Get(T &_value) const;

    public: template<typename T>
            bool GetDefault(T &_value) const;

    public: Param &operator=(const Param &_param);

    public: void SetDescription(const std::string &_desc);

    public: std::string GetDescription() const;

    public: friend std::ostream &operator<<(std::ostream &_out,
                                             const Param &_p)
            {
              _out << _p.GetAsString();
              return _out;
            }

    private: template<typename T>
             void Init(const std::string &_value);

    private: ParamPrivate *dataPtr;
  };

  class ParamPrivate
  {
    public: std::string key;

    public: bool required;

    public: bool set;

    public: std::string typeName;

    public: std::string description;

    public: std::function<boost::any ()> updateFunc;

#ifndef _WIN32
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
#endif
    public: typedef boost::variant<bool, char, std::string, int, uint64_t,
               unsigned int, double, float, sdf::Time, sdf::Color,
               sdf::Vector3, sdf::Vector2i, sdf::Vector2d,
               sdf::Quaternion, sdf::Pose,
               ignition::math::Vector3d, ignition::math::Vector2i,
               ignition::math::Vector2d, ignition::math::Quaterniond,
               ignition::math::Pose3d> ParamVariant;
#ifndef _WIN32
#pragma GCC diagnostic pop
#endif

    public: ParamVariant value;

    public: ParamVariant defaultValue;
  };

  template<typename T>
  void Param::SetUpdateFunc(T _updateFunc)
  {
    this->dataPtr->updateFunc = _updateFunc;
  }

  template<typename T>
  bool Param::Set(const T &_value)
  {
    try
    {
      this->SetFromString(boost::lexical_cast<std::string>(_value));
    }
    catch(...)
    {
      sdferr << "Unable to set parameter["
             << this->dataPtr->key << "]."
             << "Type type used must have a stream input and output"
             << "operator, which allow boost::lexical_cast to"
             << "function properly.\n";
      return false;
    }
    return true;
  }

  template<typename T>
  bool Param::Get(T &_value) const
  {
    try
    {
      if (typeid(T) == typeid(bool) &&
          this->dataPtr->typeName == "string")
      {
        std::string strValue =
          boost::lexical_cast<std::string>(this->dataPtr->value);
        if (strValue == "true" || strValue  == "1")
          _value = boost::lexical_cast<T>("1");
        else
          _value = boost::lexical_cast<T>("0");
      }
      else
      {
        _value = boost::lexical_cast<T>(this->dataPtr->value);
      }
    }
    catch(...)
    {
      sdferr << "Unable to convert parameter["
             << this->dataPtr->key << "] "
             << "whose type is["
             << this->dataPtr->typeName << "], to "
             << "type[" << typeid(T).name() << "]\n";
      return false;
    }
    return true;
  }

  template<typename T>
  bool Param::GetDefault(T &_value) const
  {
    try
    {
      _value = boost::lexical_cast<T>(this->dataPtr->defaultValue);
    }
    catch(...)
    {
      sdferr << "Unable to convert parameter["
             << this->dataPtr->key << "] "
             << "whose type is["
             << this->dataPtr->typeName << "], to "
             << "type[" << typeid(T).name() << "]\n";
      return false;
    }
    return true;
  }

  template<typename T>
  void Param::Init(const std::string &_value)
  {
    try
    {
      this->dataPtr->value = boost::lexical_cast<T>(_value);
    }
    catch(...)
    {
      if (this->dataPtr->typeName == "bool")
      {
        std::string strValue = _value;
        std::transform(strValue.begin(), strValue.end(),
                       strValue.begin(), ::tolower);
        if (strValue == "true" || strValue == "1")
          this->dataPtr->value = true;
        else
          this->dataPtr->value = false;
      }
      else
      {
        sdferr << "Unable to init parameter value from string["
               << _value << "]\n";
      }
    }

    this->dataPtr->defaultValue = this->dataPtr->value;
    this->dataPtr->set = false;
  }

  template<typename Type>
  bool Param::IsType() const
  {
    return this->dataPtr->value.type() == typeid(Type);
  }
}
#endif