MooseEnumBase.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

// C++ includes
#include <string>
#include <set>
#include <vector>
#include <map>

// MOOSE includes
#include "MooseEnumItem.h"

class MooseEnumBase
{
public:
  MooseEnumBase(std::string names, bool allow_out_of_range = false);

  MooseEnumBase(const MooseEnumBase & other_enum);

  MooseEnumBase & operator=(const MooseEnumBase & other_enum) = default;

  virtual ~MooseEnumBase() = default;

  virtual void deprecate(const std::string & name, const std::string & raw_name = "");

  std::vector<std::string> getNames() const;

  std::string getRawNames() const;

  std::vector<int> getIDs() const;

  virtual bool isValid() const = 0;

  bool isOutOfRangeAllowed() const { return _allow_out_of_range; }

  const std::set<MooseEnumItem> & items() const { return _items; }

  void addDocumentation(const std::string & name, const std::string & doc);

  const std::map<MooseEnumItem, std::string> & getItemDocumentation() const;


  std::set<MooseEnumItem>::const_iterator find(const MooseEnumItem & other) const;
  std::set<MooseEnumItem>::const_iterator find(const std::string & name) const;
  std::set<MooseEnumItem>::const_iterator find(int id) const;

  int getNextValidID() const;

  MooseEnumBase & operator+=(const std::string & name);
  MooseEnumBase & operator+=(const std::initializer_list<std::string> & names);

protected:
  MooseEnumBase();


  void addEnumerationNames(const std::string & names);
  const MooseEnumItem & addEnumerationName(const std::string & raw_name);
  const MooseEnumItem & addEnumerationName(const std::string & name, const int & value);
  const MooseEnumItem & addEnumerationItem(const MooseEnumItem & item);

  virtual void checkDeprecated() const = 0;

  void checkDeprecated(const MooseEnumItem & item) const;

  std::set<MooseEnumItem> _items;

  std::map<MooseEnumItem, MooseEnumItem> _deprecated_items;

  bool _allow_out_of_range;

  std::map<MooseEnumItem, std::string> _item_documentation;
};