DataValue.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-2022.
//
// 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.
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg$
// $Authors: Marc Sturm $
// --------------------------------------------------------------------------

#pragma once

#include <OpenMS/DATASTRUCTURES/String.h>
#include <OpenMS/DATASTRUCTURES/ListUtils.h>

#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/OpenMSConfig.h>

class QString;

namespace OpenMS
{
    class ParamValue;

  class OPENMS_DLLAPI DataValue
  {

public:

    static const DataValue EMPTY;

    enum DataType : unsigned char
    {
      STRING_VALUE, 
      INT_VALUE, 
      DOUBLE_VALUE, 
      STRING_LIST, 
      INT_LIST, 
      DOUBLE_LIST, 
      EMPTY_VALUE, 
      SIZE_OF_DATATYPE
    };

    static const std::string NamesOfDataType[SIZE_OF_DATATYPE];

    enum UnitType : unsigned char
    { 
      UNIT_ONTOLOGY, 
      MS_ONTOLOGY, 
      OTHER 
    };


    DataValue();
    DataValue(const DataValue&);
    DataValue(DataValue&&) noexcept;
    DataValue(const char*);
    DataValue(const std::string&);
    DataValue(const String&);
    DataValue(const QString&);
    DataValue(const StringList&);
    DataValue(const IntList&);
    DataValue(const DoubleList&);
    DataValue(long double);
    DataValue(double);
    DataValue(float);
    DataValue(short int);
    DataValue(unsigned short int);
    DataValue(int);
    DataValue(unsigned);
    DataValue(long int);
    DataValue(unsigned long);
    DataValue(long long);
    DataValue(unsigned long long);
    DataValue(const ParamValue&);
    ~DataValue();



    operator ParamValue() const;

    operator std::string() const;

    operator StringList() const;

    operator IntList() const;

    operator DoubleList() 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;

    StringList toStringList() const;

    IntList toIntList() const;

    DoubleList toDoubleList() const;


    DataValue& operator=(const DataValue&);
    DataValue& operator=(DataValue&&) noexcept;
    DataValue& operator=(const char*);
    DataValue& operator=(const std::string&);
    DataValue& operator=(const String&);
    DataValue& operator=(const QString&);
    DataValue& operator=(const StringList&);
    DataValue& operator=(const IntList&);
    DataValue& operator=(const DoubleList&);
    DataValue& operator=(const long double);
    DataValue& operator=(const double);
    DataValue& operator=(const float);
    DataValue& operator=(const short int);
    DataValue& operator=(const unsigned short int);
    DataValue& operator=(const int);
    DataValue& operator=(const unsigned);
    DataValue& operator=(const long int);
    DataValue& operator=(const unsigned long);
    DataValue& operator=(const long long);
    DataValue& operator=(const unsigned long long);



    String toString(bool full_precision = true) const;

    QString toQString() const;

    inline DataType valueType() const
    {
      return value_type_;
    }

    inline bool isEmpty() const
    {
      return value_type_ == EMPTY_VALUE;
    }



    inline UnitType getUnitType() const
    {
      return unit_type_;
    }

    inline void setUnitType(const UnitType & u)
    {
      unit_type_ = u;
    }

    inline bool hasUnit() const
    {
      return unit_ != -1;
    }

    const int32_t & getUnit() const;

    void setUnit(const int32_t & unit);


    friend OPENMS_DLLAPI std::ostream& operator<<(std::ostream&, const DataValue&);

    friend OPENMS_DLLAPI bool operator==(const DataValue&, const DataValue&);

    friend OPENMS_DLLAPI bool operator<(const DataValue&, const DataValue&);

    friend OPENMS_DLLAPI bool operator>(const DataValue&, const DataValue&);

    friend OPENMS_DLLAPI bool operator!=(const DataValue&, const DataValue&);

protected:

    DataType value_type_;

    UnitType unit_type_;

    int32_t unit_;

    union
    {
      SignedSize ssize_;
      double dou_;
      String* str_;
      StringList* str_list_;
      IntList* int_list_;
      DoubleList* dou_list_;
    } data_;

private:

    void clear_() noexcept;
  };
}