MetaInfo.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $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>
 
#include <boost/container/flat_map.hpp>
 
namespace OpenMS
{
  class String;
 
  class OPENMS_DLLAPI MetaInfo
  {
public:
    MetaInfo() = default;
 
    MetaInfo(const MetaInfo&) = default;
 
    MetaInfo(MetaInfo&&) = default;
 
    ~MetaInfo();
 
    MetaInfo& operator=(const MetaInfo&) = default;
    MetaInfo& operator=(MetaInfo&&) & = default;
 
    bool operator==(const MetaInfo& rhs) const;
    bool operator!=(const MetaInfo& rhs) const;
 
    const DataValue& getValue(const String& name, const DataValue& default_value = DataValue::EMPTY) const;
    const DataValue& getValue(UInt index, const DataValue& default_value = DataValue::EMPTY) const;
 
    bool exists(const String& name) const;
    bool exists(UInt index) const;
 
    void setValue(const String& name, const DataValue& value);
    void setValue(UInt index, const DataValue& value);
 
    void removeValue(const String& name);
    void removeValue(UInt index);
 
    static MetaInfoRegistry& registry();
 
    void getKeys(std::vector<String>& keys) const;
 
    void getKeys(std::vector<UInt>& keys) const;
 
    bool empty() const;
 
    void clear();
 
private:
    using MapType = boost::container::flat_map<UInt, DataValue>;
 
    static MetaInfoRegistry registry_;
 
    MapType index_to_value_;
  };
 
} // namespace OpenMS