MetaInfoInterface.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 <vector>

#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/METADATA/MetaInfoRegistry.h>
#include <OpenMS/DATASTRUCTURES/DataValue.h>

namespace OpenMS
{
  class String;
  class MetaInfo;

  class OPENMS_DLLAPI MetaInfoInterface
  {
public:

    MetaInfoInterface();
    MetaInfoInterface(const MetaInfoInterface& rhs);
    MetaInfoInterface(MetaInfoInterface&&) noexcept;
    ~MetaInfoInterface();

    MetaInfoInterface& operator=(const MetaInfoInterface& rhs);
    MetaInfoInterface& operator=(MetaInfoInterface&&) noexcept;

    void swap(MetaInfoInterface& rhs);

    bool operator==(const MetaInfoInterface& rhs) const;
    bool operator!=(const MetaInfoInterface& rhs) const;

    const DataValue& getMetaValue(const String& name) const;

    DataValue getMetaValue(const String& name, const DataValue& default_value) const; // Note: return needs to be by value to prevent life-time issues at caller site (e.g. if he passes a temporary to default-value)

    const DataValue& getMetaValue(UInt index) const;

    DataValue getMetaValue(UInt index, const DataValue& default_value) const; // Note: return needs to be by value to prevent life-time issues at caller site

    bool metaValueExists(const String& name) const;
    bool metaValueExists(UInt index) const;

    void setMetaValue(const String& name, const DataValue& value);
    void setMetaValue(UInt index, const DataValue& value);

    void removeMetaValue(const String& name);
    void removeMetaValue(UInt index);

    void addMetaValues(const MetaInfoInterface& from);

    static MetaInfoRegistry& metaRegistry();

    void getKeys(std::vector<String>& keys) const;

    void getKeys(std::vector<UInt>& keys) const;

    bool isMetaEmpty() const;

    void clearMetaInfo();

protected:

    inline void createIfNotExists_();

    MetaInfo* meta_;
  };

} // namespace OpenMS