ReporterProducerEnum Class Reference

MooseEnum designed for the ReporterContext objects to define how a ReporterValue can and is being produced. More...

#include <ReporterMode.h>

Inheritance diagram for ReporterProducerEnum:

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

Public Member Functions
	ReporterProducerEnum ()
void	clear ()
	Clear all available items (i.e., create an empty MooseEnum) More...
	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. More...
	operator std::string () const
bool	operator== (const char *value) const
	Comparison operators for comparing with character constants, MooseEnums or integer values. More...
bool	operator== (int value) const
bool	operator== (unsigned short value) const
bool	operator== (const MooseEnum &value) const
bool	operator!= (const char *value) const
bool	operator!= (int value) const
bool	operator!= (unsigned short 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. More...
virtual bool	isValid () const override
	IsValid. More...
template<typename T >
T	getEnum () const
	get the current value cast to the enum type T More...
virtual void	deprecate (const std::string &name, const std::string &raw_name="")
	Deprecates various options in the MOOSE enum. More...
std::vector< std::string >	getNames () const
	Method for returning a vector of all valid enumeration names for this instance. More...
std::string	getRawNames () const
	Method for returning the raw name strings for this instance. More...
std::vector< int >	getIDs () const
	Method for returning a vector of ids for this instance. More...
bool	isOutOfRangeAllowed () const
	isOutOfRangeAllowed More...
const std::set< MooseEnumItem > &	items () const
	Return the complete set of available flags. More...
void	addDocumentation (const std::string &name, const std::string &doc)
	Add an item documentation string. More...
const std::map< MooseEnumItem, std::string > &	getItemDocumentation () const
	Get the map containing each item's documentation string. More...
int	getNextValidID () const
	Compute the next valid ID. More...
MooseEnumBase &	operator+= (const std::string &name)
	Adds an enumeration item from name. More...
MooseEnumBase &	operator+= (const std::initializer_list< std::string > &names)
	Adds enumeration items from a list of names. More...
template<typename... Args>
void	insert (const ReporterMode &mode, Args... modes)
void	insert (const ReporterMode &mode)
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. More...
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. More...
void	checkDeprecated (const MooseEnumItem &item) const
	Check and warn deprecated values. More...
void	addEnumerationNames (const std::string &names)
	Methods to add possible enumeration value to the enum. More...
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. More...
std::map< MooseEnumItem, MooseEnumItem >	_deprecated_items
	The map of deprecated names and optional replacements. More...
bool	_allow_out_of_range
	Flag to enable enumeration items not previously defined. More...
std::map< MooseEnumItem, std::string >	_item_documentation
	The map of items and their respective documentation strings. More...

Detailed Description

MooseEnum designed for the ReporterContext objects to define how a ReporterValue can and is being produced.

The available items indicate how it can be produced and the current item is how the value is being produced.

See also

ReporterContext.h

Definition at line 61 of file ReporterMode.h.

Member Enumeration Documentation

CompareMode

enum MooseEnum::CompareMode

stronginherited

Enum item for controlling comparison in the compareCurrent method.

Enumerator
COMPARE_NAME
COMPARE_ID
COMPARE_BOTH

Definition at line 39 of file MooseEnum.h.

  {
    COMPARE_NAME,
    COMPARE_ID,
    COMPARE_BOTH
  };

Constructor & Destructor Documentation

ReporterProducerEnum()

ReporterProducerEnum::ReporterProducerEnum

(

)

Definition at line 20 of file ReporterMode.C.

: MooseEnum() {}

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.

Referenced by PseudoTimestep::validParams(), and ReferenceResidualInterface::validParams().

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

addEnumerationItem()

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

protectedinherited

Definition at line 117 of file MooseEnumBase.C.

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

{
  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;
}

addEnumerationName() [1/2]

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

protectedinherited

Definition at line 73 of file MooseEnumBase.C.

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

{
  // 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);
}

addEnumerationName() [2/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));
}

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.

Referenced by MooseEnumBase::MooseEnumBase().

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

assign() [1/3]

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

inherited

Definition at line 60 of file MooseEnum.C.

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

{
  if (name == "")
  {
    _current = MooseEnumItem("", MooseEnumItem::INVALID_ID);
    return;
  }

  std::set<MooseEnumItem>::const_iterator iter = find(name);
  if (iter == _items.end())
  {
    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(),
                 "\".");
    else
    {
      _current = MooseEnumItem(name, getNextValidID());
      _items.insert(_current);
    }
  }
  else
    _current = *iter;

  checkDeprecated();
}

assign() [2/3]

void MooseEnum::assign ( int  value )

inherited

Definition at line 91 of file MooseEnum.C.

{
  if (value == MooseEnumItem::INVALID_ID)
  {
    _current = MooseEnumItem("", MooseEnumItem::INVALID_ID);
    return;
  }

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

  checkDeprecated();
}

assign() [3/3]

void MooseEnum::assign ( const MooseEnumItem &  item )

inherited

Definition at line 113 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();
}

checkDeprecated() [1/2]

void MooseEnum::checkDeprecated ( ) const

overrideprotectedvirtualinherited

Check whether the current value is deprecated when called.

Implements MooseEnumBase.

Definition at line 203 of file MooseEnum.C.

Referenced by MooseEnum::assign().

{
  MooseEnumBase::checkDeprecated(_current);
}

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());
  }
}

clear()

void ReporterProducerEnum::clear

(

)

Clear all available items (i.e., create an empty MooseEnum)

Definition at line 29 of file ReporterMode.C.

Referenced by ReporterBroadcastContext< T >::ReporterBroadcastContext(), ReporterGatherContext< T >::ReporterGatherContext(), and ReporterScatterContext< T >::ReporterScatterContext().

{
  _items.clear();
}

compareCurrent()

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

inherited

Method for comparing currently set values between MooseEnum.

Definition at line 172 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.

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

{
  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; });
}

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

inherited

get the current value cast to the enum type T

Definition at line 151 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());
}

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.

Referenced by MooseEnum::assign().

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

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;
}

getNextValidID()

int MooseEnumBase::getNextValidID ( ) const

inherited

Compute the next valid ID.

Definition at line 102 of file MooseEnumBase.C.

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

{
  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;
}

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.

Referenced by MooseEnum::assign(), MultiMooseEnum::assignValues(), Moose::createMapFromVectorAndMultiMooseEnum(), AdvancedOutput::enableOutputTypes(), MooseEnum::operator==(), PiecewiseConstant::validParams(), LeastSquaresFit::validParams(), BatchMeshGeneratorAction::validParams(), and ComparisonPostprocessor::validParams().

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

insert() [1/2]

template<typename... Args>

void ReporterProducerEnum::insert	(	const ReporterMode &	mode,
		Args...	modes
	)

Add possible items to the enumeration.

Definition at line 79 of file ReporterMode.h.

Referenced by ReporterBroadcastContext< T >::ReporterBroadcastContext(), ReporterContext< std::vector< T > >::ReporterContext(), ReporterGatherContext< T >::ReporterGatherContext(), and ReporterScatterContext< T >::ReporterScatterContext().

{
  insert(mode);
  insert(modes...);
}

insert() [2/2]

void ReporterProducerEnum::insert

(

const ReporterMode &

mode

)

Definition at line 23 of file ReporterMode.C.

{
  addEnumerationItem(mode);
}

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

inlineoverridevirtualinherited

IsValid.

Returns

- a Boolean indicating whether this Enumeration has been set

Implements MooseEnumBase.

Definition at line 118 of file MooseEnum.h.

Referenced by MultiAppPostprocessorTransfer::MultiAppPostprocessorTransfer().

{ 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.

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

{ return _items; }

operator int()

MooseEnum::operator int ( ) const

inlineinherited

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 74 of file MooseEnum.h.

{ return _current.id(); }

operator std::string()

MooseEnum::operator std::string ( ) const

inlineinherited

Definition at line 75 of file MooseEnum.h.

{ return _current.rawName(); }

operator!=() [1/4]

bool MooseEnum::operator!= ( const char *  value ) const

inherited

Definition at line 142 of file MooseEnum.C.

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

operator!=() [2/4]

bool MooseEnum::operator!= ( int  value ) const

inherited

Definition at line 154 of file MooseEnum.C.

{
  return value != _current;
}

operator!=() [3/4]

bool MooseEnum::operator!= ( unsigned short  value ) const

inherited

Definition at line 166 of file MooseEnum.C.

{
  return value != _current;
}

operator!=() [4/4]

bool MooseEnum::operator!= ( const MooseEnum &  value ) const

inherited

Definition at line 195 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+=() [1/2]

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

inherited

Adds an enumeration item from name.

Definition at line 216 of file MooseEnumBase.C.

Referenced by MultiMooseEnum::operator+=().

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

operator+=() [2/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==() [1/4]

bool MooseEnum::operator== ( const char *  value ) const

inherited

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 129 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== ( int  value ) const

inherited

Definition at line 148 of file MooseEnum.C.

{
  return value == _current;
}

operator==() [3/4]

bool MooseEnum::operator== ( unsigned short  value ) const

inherited

Definition at line 160 of file MooseEnum.C.

{
  return value == _current;
}

operator==() [4/4]

bool MooseEnum::operator== ( const MooseEnum &  value ) const

inherited

Definition at line 187 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();
}

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 MooseEnum::assign(), MultiMooseEnum::assignValues(), MooseEnumBase::isOutOfRangeAllowed(), and MooseEnum::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(), MooseEnum::assign(), MultiMooseEnum::assignValues(), clear(), MooseEnumBase::deprecate(), MooseEnumBase::find(), MooseEnumBase::getIDs(), MooseEnumBase::getNames(), MooseEnumBase::getNextValidID(), MooseEnumBase::getRawNames(), ExecFlagEnum::items(), MooseEnumBase::items(), MooseEnum::operator==(), and ExecFlagEnum::removeAvailableFlags().

---

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

• include/reporters/ReporterMode.h
• src/reporters/ReporterMode.C