MetaInfoRegistry.h

Go to the documentation of this file.

// Copyright (c) 2002-2023, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Hendrik Weisser $
// $Authors: Marc Sturm $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <map>
#include <string>
 
#include <OpenMS/CONCEPT/Exception.h>
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/DATASTRUCTURES/String.h>
 
#include <unordered_map>
 
#ifdef OPENMS_COMPILER_MSVC
#pragma warning( push )
#pragma warning( disable : 4251 )     // disable MSVC dll-interface warning
#endif
 
namespace OpenMS
{
 
  class OPENMS_DLLAPI MetaInfoRegistry
  {
public:
    MetaInfoRegistry();
 
    MetaInfoRegistry(const MetaInfoRegistry& rhs);
 
    ~MetaInfoRegistry();
 
    MetaInfoRegistry& operator=(const MetaInfoRegistry& rhs);
 
    UInt registerName(const String& name, const String& description = "", const String& unit = "");
 
    void setDescription(UInt index, const String& description);
 
    void setDescription(const String& name, const String& description);
 
    void setUnit(UInt index, const String& unit);
 
    void setUnit(const String& name, const String& unit);
 
    UInt getIndex(const String& name) const;
 
    String getName(UInt index) const;
 
    String getDescription(UInt index) const;
    String getDescription(const String& name) const;
 
    String getUnit(UInt index) const;
    String getUnit(const String& name) const;
 
private:
    UInt next_index_;
    using MapString2IndexType = std::unordered_map<std::string, UInt>;
    using MapIndex2StringType = std::unordered_map<UInt, std::string>;
    
    MapString2IndexType name_to_index_;
    MapIndex2StringType index_to_name_;
    MapIndex2StringType index_to_description_;
    MapIndex2StringType index_to_unit_;
  };
 
} // namespace OpenMS
 
#ifdef OPENMS_COMPILER_MSVC
#pragma warning( pop )
#endif