https://mooseframework.inl.gov
MooseEnum.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #pragma once
11 
12 // MOOSE includes
13 #include "MooseEnumBase.h"
14 
15 #include <optional>
16 
17 // Forward declarations
18 namespace libMesh
19 {
20 class Parameters;
21 }
22 
33 class MooseEnum : public MooseEnumBase
34 {
35 public:
39  enum class CompareMode
40  {
42  COMPARE_ID,
44  };
45 
54  MooseEnum(std::string names, std::string default_name = "", bool allow_out_of_range = false);
55 
60  MooseEnum(const MooseEnum & other_enum);
61 
66  MooseEnum & operator=(const MooseEnum & other_enum) = default;
67 
68  virtual ~MooseEnum() = default;
69 
74  operator int() const { return _current.id(); }
75  operator std::string() const { return _current.rawName(); }
76 
83  bool operator==(const char * value) const;
84  bool operator!=(const char * value) const;
85 
86  bool operator==(int value) const;
87  bool operator!=(int value) const;
88 
89  bool operator==(unsigned short value) const;
90  bool operator!=(unsigned short value) const;
91 
92  bool operator==(const MooseEnum & value) const;
93  bool operator!=(const MooseEnum & value) const;
94 
98  bool compareCurrent(const MooseEnum & other, CompareMode mode = CompareMode::COMPARE_NAME) const;
99 
101 
106  MooseEnum & operator=(const std::string & name);
107  MooseEnum & operator=(int value);
108  MooseEnum & operator=(const MooseEnumItem & item);
109  void assign(const std::string & name, const std::optional<std::string> & context = {});
110  void assign(int value);
111  void assign(const MooseEnumItem & item);
113 
118  virtual bool isValid() const override { return _current.id() > MooseEnumItem::INVALID_ID; }
119 
120  // InputParameters is allowed to create an empty enum but is responsible for
121  // filling it in after the fact
122  friend class libMesh::Parameters;
123 
125  friend std::ostream & operator<<(std::ostream & out, const MooseEnum & obj)
126  {
127  out << obj._current.rawName();
128  return out;
129  }
130 
132  template <typename T>
133  T getEnum() const;
134 
135 protected:
137  virtual void checkDeprecated() const override;
138 
142  MooseEnum();
143 
144 private:
147 };
148 
149 template <typename T>
150 T
152 {
153 #ifdef LIBMESH_HAVE_CXX11_TYPE_TRAITS
154  static_assert(std::is_enum<T>::value == true,
155  "The type requested from MooseEnum::getEnum must be an enum type!\n\n");
156 #endif
157  return static_cast<T>(_current.id());
158 }
bool operator!=(const char *value) const
Definition: MooseEnum.C:142
CompareMode
Enum item for controlling comparison in the compareCurrent method.
Definition: MooseEnum.h:39
static const int INVALID_ID
Definition: MooseEnumItem.h:21
T getEnum() const
get the current value cast to the enum type T
Definition: MooseEnum.h:151
virtual void checkDeprecated() const override
Check whether the current value is deprecated when called.
Definition: MooseEnum.C:203
The following methods are specializations for using the libMesh::Parallel::packed_range_* routines fo...
The base class for both the MooseEnum and MultiMooseEnum classes.
Definition: MooseEnumBase.h:24
MooseEnumItem _current
The current id.
Definition: MooseEnum.h:146
MooseEnum()
Constructor for use by libmesh::Parameters and ReporterMode.
Definition: MooseEnum.C:36
virtual ~MooseEnum()=default
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
Definition: MooseEnum.h:33
const std::string & rawName() const
Definition: MooseEnumItem.h:36
void assign(const std::string &name, const std::optional< std::string > &context={})
Definition: MooseEnum.C:60
friend std::ostream & operator<<(std::ostream &out, const MooseEnum &obj)
Operator for printing to iostreams.
Definition: MooseEnum.h:125
const int & id() const
Return the numeric, name, or raw name.
Definition: MooseEnumItem.h:34
MooseEnum & operator=(const MooseEnum &other_enum)=default
Copy Assignment operator must be explicitly defined when a copy ctor exists and this method is used...
Class for containing MooseEnum item information.
Definition: MooseEnumItem.h:18
bool operator==(const char *value) const
Comparison operators for comparing with character constants, MooseEnums or integer values...
Definition: MooseEnum.C:129
bool compareCurrent(const MooseEnum &other, CompareMode mode=CompareMode::COMPARE_NAME) const
Method for comparing currently set values between MooseEnum.
Definition: MooseEnum.C:172
OStreamProxy out(std::cout)
virtual bool isValid() const override
IsValid.
Definition: MooseEnum.h:118
void ErrorVector unsigned int