MooseEnum Class Reference

This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It should be initialized with a space-delimited list of strings which become the enum values. More...

#include <MooseEnum.h>

Inheritance diagram for MooseEnum:

Public Types
enum class	CompareMode { COMPARE_NAME , COMPARE_ID , COMPARE_BOTH }
	Enum item for controlling comparison in the compareCurrent method. More...

Public Member Functions
	MooseEnum (std::string names, std::string default_name="", bool allow_out_of_range=false)
	Constructor that takes a list of enumeration values, and a separate string to set a default for this instance.
	MooseEnum (const MooseEnum &other_enum)
	Copy Constructor for use when creating vectors of MooseEnums.
MooseEnum &	operator= (const MooseEnum &other_enum)=default
	Copy Assignment operator must be explicitly defined when a copy ctor exists and this method is used.
virtual	~MooseEnum ()=default
	operator int () const
	Cast operators to make this object behave as value_types and std::string these methods can be used so that this class behaves more like a normal value_type enumeration.
	operator std::string () const
bool	operator== (const char *value) const
	Comparison operators for comparing with character constants, MooseEnums or integer values.
bool	operator!= (const char *value) const
bool	operator== (int value) const
bool	operator!= (int value) const
bool	operator== (unsigned short value) const
bool	operator!= (unsigned short value) const
bool	operator== (const MooseEnum &value) const
bool	operator!= (const MooseEnum &value) const
bool	compareCurrent (const MooseEnum &other, CompareMode mode=CompareMode::COMPARE_NAME) const
	Method for comparing currently set values between MooseEnum.
virtual bool	isValid () const override
	IsValid.
template<typename T >
T	getEnum () const
	get the current value cast to the enum type T
virtual void	deprecate (const std::string &name, const std::string &raw_name="")
	Deprecates various options in the MOOSE enum.
std::vector< std::string >	getNames () const
	Method for returning a vector of all valid enumeration names for this instance.
std::string	getRawNames () const
	Method for returning the raw name strings for this instance.
std::vector< int >	getIDs () const
	Method for returning a vector of ids for this instance.
bool	isOutOfRangeAllowed () const
	isOutOfRangeAllowed
const std::set< MooseEnumItem > &	items () const
	Return the complete set of available flags.
void	addDocumentation (const std::string &name, const std::string &doc)
	Add an item documentation string.
const std::map< MooseEnumItem, std::string > &	getItemDocumentation () const
	Get the map containing each item's documentation string.
int	getNextValidID () const
	Compute the next valid ID.
MooseEnumBase &	operator+= (const std::string &name)
	Adds an enumeration item from name.
MooseEnumBase &	operator+= (const std::initializer_list< std::string > &names)
	Adds enumeration items from a list of names.
MooseEnum &	operator= (const std::string &name)
	Assignment operators/methods.
MooseEnum &	operator= (int value)
MooseEnum &	operator= (const MooseEnumItem &item)
void	assign (const std::string &name, const std::optional< std::string > &context={})
void	assign (int value)
void	assign (const MooseEnumItem &item)
std::set< MooseEnumItem >::const_iterator	find (const MooseEnumItem &other) const
	Locate an item.
std::set< MooseEnumItem >::const_iterator	find (const std::string &name) const
std::set< MooseEnumItem >::const_iterator	find (int id) const

Protected Member Functions
virtual void	checkDeprecated () const override
	Check whether the current value is deprecated when called.
	MooseEnum ()
	Constructor for use by libmesh::Parameters and ReporterMode.
void	checkDeprecated (const MooseEnumItem &item) const
	Check and warn deprecated values.
void	addEnumerationNames (const std::string &names)
	Methods to add possible enumeration value to the enum.
const MooseEnumItem &	addEnumerationName (const std::string &raw_name)
const MooseEnumItem &	addEnumerationName (const std::string &name, const int &value)
const MooseEnumItem &	addEnumerationItem (const MooseEnumItem &item)

Protected Attributes
std::set< MooseEnumItem >	_items
	Storage for the assigned items.
std::map< MooseEnumItem, MooseEnumItem >	_deprecated_items
	The map of deprecated names and optional replacements.
bool	_allow_out_of_range
	Flag to enable enumeration items not previously defined.
std::map< MooseEnumItem, std::string >	_item_documentation
	The map of items and their respective documentation strings.

Private Attributes
MooseEnumItem	_current
	The current id.

Friends
class	libMesh::Parameters
std::ostream &	operator<< (std::ostream &out, const MooseEnum &obj)
	Operator for printing to iostreams.

Detailed Description

This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It should be initialized with a space-delimited list of strings which become the enum values.

You may also optionally supply numeric ints for one or more values similar to a C++ enum. This is done with the "=" sign (no spaces). It can be used any place where an integer (switch statements), const char* or std::string is expected. In addition the InputParameters system has full support for this Enum type

Definition at line 54 of file MooseEnum.h.

Member Enumeration Documentation

CompareMode

enum class MooseEnum::CompareMode

strong

Enum item for controlling comparison in the compareCurrent method.

Enumerator
COMPARE_NAME
COMPARE_ID
COMPARE_BOTH

Definition at line 60 of file MooseEnum.h.

  {
    COMPARE_NAME,
    COMPARE_ID,
    COMPARE_BOTH
  };

Constructor & Destructor Documentation

MooseEnum() [1/3]

MooseEnum::MooseEnum	(	std::string	names,
		std::string	default_name = "",
		bool	allow_out_of_range = false
	)

Constructor that takes a list of enumeration values, and a separate string to set a default for this instance.

Parameters

names	- a list of names for this enumeration
default_name	- the default value for this enumeration instance
allow_out_of_range	- determines whether this enumeration will accept values outside of it's range of defined values.

Definition at line 22 of file MooseEnum.C.

  : MooseEnumBase(names, allow_out_of_range), _current("", MooseEnumItem::INVALID_ID)
{
  *this = default_name;
}

MooseEnum() [2/3]

MooseEnum::MooseEnum

(

const MooseEnum &

other_enum

)

Copy Constructor for use when creating vectors of MooseEnums.

Parameters

other_enum

- The other enumeration to copy state from

Definition at line 28 of file MooseEnum.C.

  : MooseEnumBase(other_enum), _current(other_enum._current)
{
}

~MooseEnum()

virtual MooseEnum::~MooseEnum ( )

virtualdefault

MooseEnum() [3/3]

MooseEnum::MooseEnum ( )

protected

Constructor for use by libmesh::Parameters and ReporterMode.

Private constuctor for use by libmesh::Parameters.

Definition at line 36 of file MooseEnum.C.

: _current("", MooseEnumItem::INVALID_ID) {}

Member Function Documentation

addDocumentation()

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

inherited

Add an item documentation string.

Definition at line 175 of file MooseEnumBase.C.

{
  auto it = find(name);
  if (it == _items.end())
    mooseError("Item '", name, "' not found in addDocumentation.");
  _item_documentation[*it] = doc;
}

Referenced by MortarConsumerInterface::triangulationParams(), MortarConsumerInterface::validParams(), ReferenceResidualInterface::validParams(), MFEMSamplerBase::validParams(), and PseudoTimestep::validParams().

addEnumerationItem()

const MooseEnumItem & MooseEnumBase::addEnumerationItem ( const MooseEnumItem &  item )

protectedinherited

Definition at line 117 of file MooseEnumBase.C.

{
  const auto & item_it = find(item);
  if (item_it != _items.end()) // do nothing for identical insertions
    return *item_it;
 
  if (find(item.id()) != _items.end())
    mooseError("The supplied id ",
               item.id(),
               " already exists in the enumeration, cannot not add '",
               item,
               "'.");
  if (find(item.name()) != _items.end())
    mooseError("The name '", item.name(), "' already exists in the enumeration.");
 
  return *_items.insert(item).first;
}

Referenced by ExecFlagEnum::addAvailableFlags(), MooseEnumBase::addEnumerationName(), MultiMooseEnum::addValidName(), MultiMooseEnum::assignValues(), and ReporterProducerEnum::insert().

addEnumerationName() [1/2]

const MooseEnumItem & MooseEnumBase::addEnumerationName ( const std::string &  name, const int &  value  )

protectedinherited

Definition at line 111 of file MooseEnumBase.C.

{
  return addEnumerationItem(MooseEnumItem(name, value));
}

addEnumerationName() [2/2]

const MooseEnumItem & MooseEnumBase::addEnumerationName ( const std::string &  raw_name )

protectedinherited

Definition at line 73 of file MooseEnumBase.C.

{
  // Make sure the option is not malformed
  if (raw_name.find_first_of('=') == 0 || raw_name.find_last_of('=') == raw_name.length() - 1)
    mooseError("You cannot place whitespace around the '=' character in MooseEnumBase");
 
  // Split on equals sign
  std::vector<std::string> name_value;
  MooseUtils::tokenize(MooseUtils::trim(raw_name), name_value, 1, "=");
 
  // There should be one or two items in the name_value
  if (name_value.size() < 1 || name_value.size() > 2)
    mooseError("Invalid option supplied in MooseEnumBase: ", raw_name);
 
  // Remove un-wanted space around string
  name_value[0] = MooseUtils::trim(name_value[0]);
 
  // See if there is a value supplied for this option
  // strtol allows for proper conversions of both int and hex strings
  int value;
  if (name_value.size() == 2)
    value = std::strtol(name_value[1].c_str(), NULL, 0);
  else
    value = getNextValidID();
 
  return addEnumerationName(name_value[0], value);
}

Referenced by ConvergenceIterationTypeEnum::addConvergenceIterationType(), MooseEnumBase::addEnumerationName(), MooseEnumBase::addEnumerationNames(), MultiMooseEnum::addValidName(), and MooseEnumBase::operator+=().

addEnumerationNames()

void MooseEnumBase::addEnumerationNames ( const std::string &  names )

protectedinherited

Methods to add possible enumeration value to the enum.

The MooseEnum/MultiMooseEnum are not designed to be modified, with respect to the list of possible values. However, this is not the case for the ExecFlagEnum which is a special type of MultiMooseEnum for managing the "execute_on" flags. These methods are used by ExecFlagEnum to allow users to modify the available execute flags for their object.

Definition at line 64 of file MooseEnumBase.C.

{
  std::vector<std::string> elements;
  MooseUtils::tokenize(names, elements, 1, " ");
  for (const std::string & raw_name : elements)
    addEnumerationName(raw_name);
}

Referenced by MooseEnumBase::MooseEnumBase().

assign() [1/3]

void MooseEnum::assign

(

const MooseEnumItem &

item

)

Definition at line 115 of file MooseEnum.C.

{
  std::set<MooseEnumItem>::const_iterator iter = find(item);
  if (iter == _items.end())
    mooseError("Invalid item \"",
               item,
               "\" in MooseEnum. Valid ids are \"",
               Moose::stringify(items()),
               "\".");
  else
    _current = *iter;
 
  checkDeprecated();
}

assign() [2/3]

void MooseEnum::assign	(	const std::string &	name,
		const std::optional< std::string > &	context = {}
	)

Definition at line 60 of file MooseEnum.C.

{
  if (MooseUtils::trim(name) == "")
  {
    _current = MooseEnumItem("", MooseEnumItem::INVALID_ID);
    return;
  }
 
  // Check if name can be parsed cleanly into an integer
  int value = 0;
  bool integer = (std::istringstream(MooseUtils::trim(name)) >> value).eof();
 
  if (auto iter = find(name); iter != _items.end())
    _current = *iter;
  else if (auto subs = find(value); subs != _items.end() && integer)
    _current = *subs;
  else
  {
    if (!_allow_out_of_range) // Are out of range values allowed?
      mooseError(context ? (*context + ":\n\n") : std::string(""),
                 "Invalid option \"",
                 name,
                 "\" in MooseEnum.  Valid options (not case-sensitive) are \"",
                 getRawNames(),
                 "\".");
 
    _current = MooseEnumItem(name, integer ? value : getNextValidID());
    _items.insert(_current);
  }
 
  checkDeprecated();
}

Referenced by ReporterContextBase::init(), operator=(), operator=(), and operator=().

assign() [3/3]

void MooseEnum::assign

(

int

value

)

Definition at line 94 of file MooseEnum.C.

{
  if (value == MooseEnumItem::INVALID_ID)
  {
    _current = MooseEnumItem("", MooseEnumItem::INVALID_ID);
    return;
  }
 
  if (auto iter = find(value); iter != _items.end())
    _current = *iter;
  else
    mooseError("Invalid id \"",
               value,
               "\" in MooseEnum. Valid ids are \"",
               Moose::stringify(getIDs()),
               "\".");
 
  checkDeprecated();
}

checkDeprecated() [1/2]

void MooseEnum::checkDeprecated ( ) const

overrideprotectedvirtual

Check whether the current value is deprecated when called.

Implements MooseEnumBase.

Definition at line 205 of file MooseEnum.C.

{
  MooseEnumBase::checkDeprecated(_current);
}

Referenced by assign(), assign(), and assign().

checkDeprecated() [2/2]

void MooseEnumBase::checkDeprecated ( const MooseEnumItem &  item ) const

protectedinherited

Check and warn deprecated values.

Definition at line 136 of file MooseEnumBase.C.

{
  std::map<MooseEnumItem, MooseEnumItem>::const_iterator it = _deprecated_items.find(item);
  if (it != _deprecated_items.end())
  {
    if (it->second.name().empty())
      mooseWarning(item.name() + " is deprecated");
    else
      mooseWarning(item.name() + " is deprecated, consider using " + it->second.name());
  }
}

compareCurrent()

bool MooseEnum::compareCurrent	(	const MooseEnum &	other,
		CompareMode	mode = CompareMode::COMPARE_NAME
	)		const

Method for comparing currently set values between MooseEnum.

Definition at line 174 of file MooseEnum.C.

{
  switch (mode)
  {
    case CompareMode::COMPARE_BOTH:
      return (_current.id() == other._current.id()) && (_current.name() == other._current.name());
    case CompareMode::COMPARE_NAME:
      return _current.name() == other._current.name();
    case CompareMode::COMPARE_ID:
      return _current.id() == other._current.id();
  }
  return false;
}

deprecate()

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

virtualinherited

Deprecates various options in the MOOSE enum.

For each deprecated option, you may supply an optional new option that will be used in a message telling the user which new option replaces the old one.

Definition at line 45 of file MooseEnumBase.C.

{
  std::set<MooseEnumItem>::const_iterator deprecated = find(name);
  if (deprecated == _items.end())
    mooseError("Cannot deprecate the enum item ", name, ", is not an available value.");
 
  std::set<MooseEnumItem>::const_iterator replaced = find(raw_name);
  if (replaced == _items.end())
    mooseError("Cannot deprecate the enum item ",
               name,
               ", since the replaced item ",
               raw_name,
               " it is not an available value.");
 
  _deprecated_items.emplace(std::make_pair(*deprecated, *replaced));
  checkDeprecated();
}

find() [1/3]

std::set< MooseEnumItem >::const_iterator MooseEnumBase::find ( const MooseEnumItem &  other ) const

inherited

Locate an item.

Definition at line 206 of file MooseEnumBase.C.

{
  const auto upper = MooseUtils::toUpper(other.name());
  return std::find_if(_items.begin(),
                      _items.end(),
                      [&other, &upper](MooseEnumItem const & item)
                      { return item.id() == other.id() && item.name() == upper; });
}

Referenced by MooseEnumBase::addDocumentation(), MooseEnumBase::addEnumerationItem(), ExecFlagEnum::appendCurrent(), assign(), assign(), assign(), MultiMooseEnum::assignValues(), MooseEnumBase::deprecate(), FVAdvection::FVAdvection(), MeshInfo::hasItem(), operator==(), moose::internal::ExecFlagRegistry::registerFlag(), moose::internal::ConvergenceIterationTypeRegistry::registerType(), ExecFlagEnum::removeAvailableFlags(), CreateExecutionerAction::setupAutoPreconditioning(), and ReadExecutorParamsAction::setupAutoPreconditioning().

find() [2/3]

std::set< MooseEnumItem >::const_iterator MooseEnumBase::find ( const std::string &  name ) const

inherited

Definition at line 190 of file MooseEnumBase.C.

{
  std::string upper = MooseUtils::toUpper(name);
  return std::find_if(_items.begin(),
                      _items.end(),
                      [&upper](MooseEnumItem const & item) { return item.name() == upper; });
}

find() [3/3]

std::set< MooseEnumItem >::const_iterator MooseEnumBase::find ( int  id ) const

inherited

Definition at line 199 of file MooseEnumBase.C.

{
  return std::find_if(
      _items.begin(), _items.end(), [&id](MooseEnumItem const & item) { return item.id() == id; });
}

getEnum()

template<typename T >

T MooseEnum::getEnum

(

)

const

get the current value cast to the enum type T

Definition at line 172 of file MooseEnum.h.

{
#ifdef LIBMESH_HAVE_CXX11_TYPE_TRAITS
  static_assert(std::is_enum<T>::value == true,
                "The type requested from MooseEnum::getEnum must be an enum type!\n\n");
#endif
  return static_cast<T>(_current.id());
}

Referenced by CSG::CSGRegion::getRegionType().

getIDs()

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

inherited

Method for returning a vector of ids for this instance.

Returns

a vector of ints containing the possible ids for this enumeration

Definition at line 165 of file MooseEnumBase.C.

{
  std::vector<int> out;
  out.reserve(_items.size());
  for (const auto & item : _items)
    out.push_back(item.id());
  return out;
}

Referenced by assign().

getItemDocumentation()

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

inherited

Get the map containing each item's documentation string.

Definition at line 184 of file MooseEnumBase.C.

{
  return _item_documentation;
}

getNames()

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

inherited

Method for returning a vector of all valid enumeration names for this instance.

Returns

a vector of names

Definition at line 149 of file MooseEnumBase.C.

{
  std::vector<std::string> out;
  out.reserve(_items.size());
  for (const auto & item : _items)
    out.push_back(item.name());
  return out;
}

Referenced by Moose::PetscSupport::dontAddCommonKSPOptions(), and Moose::PetscSupport::dontAddCommonSNESOptions().

getNextValidID()

int MooseEnumBase::getNextValidID ( ) const

inherited

Compute the next valid ID.

Definition at line 102 of file MooseEnumBase.C.

{
  int value = -1; // Use -1 so if no values exist the first will be zero
  for (const auto & item : _items)
    value = std::max(value, item.id());
  return ++value;
}

Referenced by MooseEnumBase::addEnumerationName(), MultiMooseEnum::addValidName(), assign(), MultiMooseEnum::assignValues(), and moose::internal::ExecFlagRegistry::registerFlag().

getRawNames()

std::string MooseEnumBase::getRawNames ( ) const

inherited

Method for returning the raw name strings for this instance.

Returns

a space separated list of names

Definition at line 159 of file MooseEnumBase.C.

{
  return Moose::stringify(_items, " ");
}

Referenced by assign(), MultiMooseEnum::assignValues(), AdvancedOutput::enableOutputTypes(), operator==(), PiecewiseConstant::validParams(), and ComparisonPostprocessor::validParams().

isOutOfRangeAllowed()

bool MooseEnumBase::isOutOfRangeAllowed ( ) const

inlineinherited

isOutOfRangeAllowed

Returns

- a Boolean indicating whether enum names out of range are allowed

Definition at line 88 of file MooseEnumBase.h.

{ return _allow_out_of_range; }

isValid()

virtual bool MooseEnum::isValid ( ) const

inlineoverridevirtual

IsValid.

Returns

- a Boolean indicating whether this Enumeration has been set

Implements MooseEnumBase.

Definition at line 139 of file MooseEnum.h.

{ return _current.id() > MooseEnumItem::INVALID_ID; }

items()

const std::set< MooseEnumItem > & MooseEnumBase::items ( ) const

inlineinherited

Return the complete set of available flags.

Definition at line 93 of file MooseEnumBase.h.

{ return _items; }

Referenced by assign(), FVAdvection::FVAdvection(), MeshInfo::hasItem(), moose::internal::ConvergenceIterationTypeRegistry::registerType(), CreateExecutionerAction::setupAutoPreconditioning(), and ReadExecutorParamsAction::setupAutoPreconditioning().

operator int()

MooseEnum::operator int ( ) const

inline

Cast operators to make this object behave as value_types and std::string these methods can be used so that this class behaves more like a normal value_type enumeration.

Definition at line 95 of file MooseEnum.h.

{ return _current.id(); }

operator std::string()

MooseEnum::operator std::string ( ) const

inline

Definition at line 96 of file MooseEnum.h.

{ return _current.rawName(); }

operator!=() [1/4]

bool MooseEnum::operator!=

(

const char *

value

)

const

Definition at line 144 of file MooseEnum.C.

{
  return !(*this == name);
}

operator!=() [2/4]

bool MooseEnum::operator!=

(

const MooseEnum &

value

)

const

Definition at line 197 of file MooseEnum.C.

{
  mooseDeprecated("This method will be removed because the meaning is not well defined, please use "
                  "the 'compareCurrent' method instead.");
  return value._current.name() != _current.name();
}

operator!=() [3/4]

bool MooseEnum::operator!=

(

int

value

)

const

Definition at line 156 of file MooseEnum.C.

{
  return value != _current;
}

operator!=() [4/4]

bool MooseEnum::operator!=

(

unsigned short

value

)

const

Definition at line 168 of file MooseEnum.C.

{
  return value != _current;
}

operator+=() [1/2]

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

inherited

Adds enumeration items from a list of names.

Definition at line 224 of file MooseEnumBase.C.

{
  for (const auto & name : names)
    *this += name;
  return *this;
}

operator+=() [2/2]

MooseEnumBase & MooseEnumBase::operator+= ( const std::string &  name )

inherited

Adds an enumeration item from name.

Definition at line 216 of file MooseEnumBase.C.

{
  addEnumerationName(name);
  checkDeprecated();
  return *this;
}

Referenced by MultiMooseEnum::operator+=(), and MultiMooseEnum::operator+=().

operator=() [1/4]

MooseEnum & MooseEnum::operator= ( const MooseEnum &  other_enum )

default

Copy Assignment operator must be explicitly defined when a copy ctor exists and this method is used.

operator=() [2/4]

MooseEnum & MooseEnum::operator=

(

const MooseEnumItem &

item

)

Definition at line 53 of file MooseEnum.C.

{
  assign(item);
  return *this;
}

operator=() [3/4]

MooseEnum & MooseEnum::operator=

(

const std::string &

name

)

Assignment operators/methods.

Parameters

name/int

- a string or int representing one of the enumeration values.

Returns

A reference to this object for chaining

Definition at line 39 of file MooseEnum.C.

{
  assign(name);
  return *this;
}

operator=() [4/4]

MooseEnum & MooseEnum::operator=

(

int

value

)

Definition at line 46 of file MooseEnum.C.

{
  assign(value);
  return *this;
}

operator==() [1/4]

bool MooseEnum::operator==

(

const char *

value

)

const

Comparison operators for comparing with character constants, MooseEnums or integer values.

Parameters

value

- RHS value to compare against

Returns

bool - the truth value for the comparison

Definition at line 131 of file MooseEnum.C.

{
  std::string upper(MooseUtils::toUpper(name));
 
  mooseAssert(_allow_out_of_range || find(upper) != _items.end(),
              "Invalid string comparison \"" + upper +
                  "\" in MooseEnum.  Valid options (not case-sensitive) are \"" + getRawNames() +
                  "\".");
 
  return _current == upper;
}

operator==() [2/4]

bool MooseEnum::operator==

(

const MooseEnum &

value

)

const

Definition at line 189 of file MooseEnum.C.

{
  mooseDeprecated("This method will be removed because the meaning is not well defined, please use "
                  "the 'compareCurrent' method instead.");
  return value._current.name() == _current.name();
}

operator==() [3/4]

bool MooseEnum::operator==

(

int

value

)

const

Definition at line 150 of file MooseEnum.C.

{
  return value == _current;
}

operator==() [4/4]

bool MooseEnum::operator==

(

unsigned short

value

)

const

Definition at line 162 of file MooseEnum.C.

{
  return value == _current;
}

Friends And Related Symbol Documentation

libMesh::Parameters

friend class libMesh::Parameters

friend

Definition at line 143 of file MooseEnum.h.

operator<<

std::ostream & operator<< ( std::ostream &  out, const MooseEnum &  obj  )

friend

Operator for printing to iostreams.

Definition at line 146 of file MooseEnum.h.

  {
    out << obj._current.rawName();
    return out;
  }

Member Data Documentation

_allow_out_of_range

bool MooseEnumBase::_allow_out_of_range

protectedinherited

Flag to enable enumeration items not previously defined.

Definition at line 163 of file MooseEnumBase.h.

Referenced by assign(), MultiMooseEnum::assignValues(), MooseEnumBase::isOutOfRangeAllowed(), and operator==().

_current

MooseEnumItem MooseEnum::_current

private

The current id.

Definition at line 167 of file MooseEnum.h.

Referenced by assign(), assign(), assign(), checkDeprecated(), compareCurrent(), getEnum(), isValid(), operator int(), operator std::string(), operator!=(), operator!=(), operator!=(), operator==(), operator==(), operator==(), and operator==().

_deprecated_items

std::map<MooseEnumItem, MooseEnumItem> MooseEnumBase::_deprecated_items

protectedinherited

The map of deprecated names and optional replacements.

Definition at line 160 of file MooseEnumBase.h.

Referenced by MooseEnumBase::checkDeprecated(), and MooseEnumBase::deprecate().

_item_documentation

std::map<MooseEnumItem, std::string> MooseEnumBase::_item_documentation

protectedinherited

The map of items and their respective documentation strings.

Definition at line 166 of file MooseEnumBase.h.

Referenced by MooseEnumBase::addDocumentation(), and MooseEnumBase::getItemDocumentation().

_items

std::set<MooseEnumItem> MooseEnumBase::_items

protectedinherited

Storage for the assigned items.

Definition at line 157 of file MooseEnumBase.h.

Referenced by MooseEnumBase::addDocumentation(), MooseEnumBase::addEnumerationItem(), MultiMooseEnum::addValidName(), ExecFlagEnum::appendCurrent(), assign(), assign(), assign(), MultiMooseEnum::assignValues(), ReporterProducerEnum::clear(), MooseEnumBase::deprecate(), MooseEnumBase::find(), MooseEnumBase::find(), MooseEnumBase::find(), MooseEnumBase::getIDs(), MooseEnumBase::getNames(), MooseEnumBase::getNextValidID(), MooseEnumBase::getRawNames(), ExecFlagEnum::items(), MooseEnumBase::items(), operator==(), and ExecFlagEnum::removeAvailableFlags().

---

The documentation for this class was generated from the following files:

• include/utils/MooseEnum.h
• src/utils/MooseEnum.C