EnumHelpers.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: Chris Bielow $
// $Authors: Chris Bielow $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/CONCEPT/Exception.h>
 
#include <algorithm>
#include <string>
#include <vector>
 
namespace OpenMS
{
  namespace Helpers
  {
    template <class ContainerType>
    Size indexOf(const ContainerType& cont, const typename ContainerType::value_type& val)
    {
      auto it = std::find(cont.begin(), cont.end(), val);
      if (it == cont.end())
      {
        throw Exception::ElementNotFound(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, val);
      }
      return std::distance(cont.begin(), it);
    }
 
    template <class EnumType>
    std::vector<std::string> enumNames(const std::string* names, EnumType size_value)
    {
      std::vector<std::string> result;
      result.reserve(static_cast<size_t>(size_value));
      for (size_t i = 0; i < static_cast<size_t>(size_value); ++i)
      {
        result.push_back(names[i]);
      }
      return result;
    }
 
    template <class EnumType>
    const std::string& enumToName(const std::string* names, EnumType value, EnumType size_value, const char* size_name, const char* function)
    {
      if (value == size_value)
      {
        throw Exception::InvalidValue(__FILE__, __LINE__, function, "Value not allowed", size_name);
      }
      return names[static_cast<size_t>(value)];
    }
 
    template <class EnumType>
    EnumType enumFromName(const std::string* names, EnumType size_value, const std::string& name, const char* message, const char* function)
    {
      const std::string* first = names;
      const std::string* last = names + static_cast<size_t>(size_value);
      const auto it = std::find(first, last, name);
      if (it == last)
      {
        throw Exception::InvalidValue(__FILE__, __LINE__, function, message, name);
      }
      return static_cast<EnumType>(it - first);
    }
 
  }
}