ParamValue.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2023.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * 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.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// 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 ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS 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.
//
// --------------------------------------------------------------------------
// $Authors: Ruben Grünberg $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/OpenMSConfig.h>
 
#include <cstddef> // for ptrdiff_t
#include <string>
#include <vector>
 
 
namespace OpenMS
{
  class OPENMS_DLLAPI ParamValue
  {
 
public:
 
    static const ParamValue EMPTY;
 
    enum ValueType : unsigned char
    {
      STRING_VALUE, 
      INT_VALUE, 
      DOUBLE_VALUE, 
      STRING_LIST, 
      INT_LIST, 
      DOUBLE_LIST, 
      EMPTY_VALUE 
    };
 
 
    ParamValue();
    ParamValue(const ParamValue&);
    ParamValue(ParamValue&&) noexcept;
    ParamValue(const char*);
    ParamValue(const std::string&);
    ParamValue(const std::vector<std::string>&);
    ParamValue(const std::vector<int>&);
    ParamValue(const std::vector<double>&);
    ParamValue(long double);
    ParamValue(double);
    ParamValue(float);
    ParamValue(short int);
    ParamValue(unsigned short int);
    ParamValue(int);
    ParamValue(unsigned);
    ParamValue(long int);
    ParamValue(unsigned long);
    ParamValue(long long);
    ParamValue(unsigned long long);
    ~ParamValue();
 
 
 
    operator std::string() const;
 
    operator std::vector<std::string>() const;
 
    operator std::vector<int>() const;
 
    operator std::vector<double>() const;
 
    operator long double() const;
 
    operator double() const;
 
    operator float() const;
 
    operator short int() const;
 
    operator unsigned short int() const;
 
    operator int() const;
 
    operator unsigned int() const;
 
    operator long int() const;
 
    operator unsigned long int() const;
 
    operator long long() const;
 
    operator unsigned long long() const;
 
    bool toBool() const;
 
    const char* toChar() const;
 
    std::string toString(bool full_precision = true) const;
 
    std::vector<std::string> toStringVector() const;
 
    std::vector<int> toIntVector() const;
 
    std::vector<double> toDoubleVector() const;
 
 
    ParamValue& operator=(const ParamValue&);
    ParamValue& operator=(ParamValue&&) noexcept;
    ParamValue& operator=(const char*);
    ParamValue& operator=(const std::string&);
    ParamValue& operator=(const std::vector<std::string>&);
    ParamValue& operator=(const std::vector<int>&);
    ParamValue& operator=(const std::vector<double>&);
    ParamValue& operator=(const long double);
    ParamValue& operator=(const double);
    ParamValue& operator=(const float);
    ParamValue& operator=(const short int);
    ParamValue& operator=(const unsigned short int);
    ParamValue& operator=(const int);
    ParamValue& operator=(const unsigned);
    ParamValue& operator=(const long int);
    ParamValue& operator=(const unsigned long);
    ParamValue& operator=(const long long);
    ParamValue& operator=(const unsigned long long);
 
    inline ValueType valueType() const
    {
      return value_type_;
    }
 
    inline bool isEmpty() const
    {
      return value_type_ == EMPTY_VALUE;
    }
 
    friend OPENMS_DLLAPI std::ostream& operator<<(std::ostream&, const ParamValue&);
 
    friend OPENMS_DLLAPI bool operator==(const ParamValue&, const ParamValue&);
 
    friend OPENMS_DLLAPI bool operator<(const ParamValue&, const ParamValue&);
 
    friend OPENMS_DLLAPI bool operator>(const ParamValue&, const ParamValue&);
 
    friend OPENMS_DLLAPI bool operator!=(const ParamValue&, const ParamValue&);
 
protected:
 
    ValueType value_type_;
 
    union
    {
      ptrdiff_t ssize_;
      double dou_;
      std::string* str_;
      std::vector<std::string>* str_list_;
      std::vector<int>* int_list_;
      std::vector<double>* dou_list_;
    } data_;
 
private:
 
    void clear_() noexcept;
 
    static std::string doubleToString(double value, bool full_precision = true);
 
  };
}