EnumSelection.h

// Copyright 2024, UChicago Argonne, LLC
// All Rights Reserved
// Software Name: NEML2 -- the New Engineering material Model Library, version 2
// By: Argonne National Laboratory
// OPEN SOURCE LICENSE (MIT)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
 
#pragma once
 
#include "neml2/base/EnumSelectionBase.h"
 
namespace neml2
{
// Forward decl
class EnumSelection;
std::ostream & operator<<(std::ostream &, const EnumSelection &);
std::stringstream & operator>>(std::stringstream &, EnumSelection &);
 
class EnumSelection : public EnumSelectionBase
{
public:
  EnumSelection() = default;
 
  EnumSelection(const std::vector<std::string> & candidates, const std::string & selection);
 
  EnumSelection(const std::vector<std::string> & candidates,
                const std::vector<int> & values,
                const std::string & selection);
 
  void select(const std::string & selection);
 
  bool operator==(const EnumSelection & other) const;
 
  bool operator!=(const EnumSelection & other) const;
 
  bool operator==(const std::string & other) const;
 
  bool operator!=(const std::string & other) const;
 
  operator std::string() const { return _selection; }
 
  operator int() const { return _value; }
 
  template <typename T>
  T as() const
  {
    return static_cast<T>(_value);
  }
 
private:
  std::string _selection = "";
 
  int _value = 0;
};
} // namespace neml2