parameter.hh

Go to the documentation of this file.

//
// Copyright 2018 CNRS
//
// Author: Florent Lamiraux, Joseph Mirabel
//
 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
// DAMAGE.
 
#ifndef HPP_CORE_PARAMETER_HH
#define HPP_CORE_PARAMETER_HH
 
#include <cassert>
#include <hpp/core/config.hh>
#include <hpp/core/fwd.hh>
#include <iostream>
#include <string>
#include <typeinfo>
 
namespace hpp {
namespace core {
/*
class Parameter;
class DYNAMIC_GRAPH_DLLAPI EitherType {
public:
  EitherType(const Parameter& value);
  ~EitherType();
  operator bool () const;
  operator unsigned () const;
  operator int () const;
  operator float () const;
  operator double () const;
  operator std::string () const;
  operator Vector () const;
  operator Eigen::MatrixXd () const;
  operator Eigen::Matrix4d () const;
private:
  const Parameter* value_;
};
*/
 
class HPP_CORE_DLLAPI Parameter {
 public:
  enum Type {
    NONE,
    BOOL,
    INT,
    FLOAT,
    STRING,
    VECTOR,
    MATRIX,
    NB_TYPES
  };
  ~Parameter();
  void deleteValue();
  explicit Parameter(const bool& value);
  explicit Parameter(const size_type& value);
  explicit Parameter(const value_type& value);
  explicit Parameter(const std::string& value);
  explicit Parameter(const vector_t& value);
  explicit Parameter(const matrix_t& value);
  Parameter(const Parameter& value);
  explicit Parameter();
  // operator assignement
  Parameter operator=(const Parameter& value);
  Type type() const;
 
  // const EitherType value () const;
  static std::string typeName(Type type);
 
  HPP_CORE_DLLAPI friend std::ostream& operator<<(std::ostream& os,
                                                  const Parameter& value);
 
 public:
  // friend class EitherType;
  bool boolValue() const;
  size_type intValue() const;
  value_type floatValue() const;
  std::string stringValue() const;
  vector_t vectorValue() const;
  matrix_t matrixValue() const;
  Type type_;
 
  const void* const value_;
};
 
class HPP_CORE_DLLAPI ParameterDescription {
 public:
  ParameterDescription(Parameter::Type type, std::string name,
                       std::string doc = "",
                       Parameter defaultValue = Parameter())
      : name_(name), doc_(doc), type_(type), defaultValue_(defaultValue) {}
 
  ParameterDescription() : type_(Parameter::NONE) {}
 
  const std::string& name() const { return name_; }
  const Parameter::Type& type() const { return type_; }
  const std::string& doc() const { return doc_; }
  const Parameter& defaultValue() const;
 
 private:
  std::string name_;
  std::string doc_;
  Parameter::Type type_;
  Parameter defaultValue_;
};
}  // namespace core
}  // namespace hpp
 
#endif  // HPP_CORE_PARAMETER_HH