moose::internal::ExecFlagRegistry Class Reference

Registry for statically defining execute flags with consistent numbering. More...

#include <ExecFlagRegistry.h>

Public Member Functions
const ExecFlagType &	registerFlag (const std::string &name, const bool is_default)
	Registers an execute flag. More...
const ExecFlagEnum &	getFlags () const
const ExecFlagEnum &	getDefaultFlags () const
	ExecFlagRegistry (ExecFlagRegistry const &)=delete
	Don't allow creation through copy/move construction or assignment. More...
ExecFlagRegistry &	operator= (ExecFlagRegistry const &)=delete
	ExecFlagRegistry (ExecFlagRegistry &&)=delete
ExecFlagRegistry &	operator= (ExecFlagRegistry &&)=delete

Static Public Member Functions
static ExecFlagRegistry &	getExecFlagRegistry ()
	Return Singleton instance. More...

Private Member Functions
	ExecFlagRegistry ()

Private Attributes
ExecFlagEnum	_flags
	The registered flags. More...
ExecFlagEnum	_default_flags
	The default flags. More...

Detailed Description

Registry for statically defining execute flags with consistent numbering.

Definition at line 22 of file ExecFlagRegistry.h.

Constructor & Destructor Documentation

ExecFlagRegistry() [1/3]

moose::internal::ExecFlagRegistry::ExecFlagRegistry ( ExecFlagRegistry const &  )

delete

Don't allow creation through copy/move construction or assignment.

ExecFlagRegistry() [2/3]

moose::internal::ExecFlagRegistry::ExecFlagRegistry ( ExecFlagRegistry &&  )

delete

ExecFlagRegistry() [3/3]

moose::internal::ExecFlagRegistry::ExecFlagRegistry ( )

inlineprivate

Definition at line 56 of file ExecFlagRegistry.h.

{}

Member Function Documentation

getDefaultFlags()

const ExecFlagEnum& moose::internal::ExecFlagRegistry::getDefaultFlags ( ) const

inline

Returns

The registered default exec flags.

Definition at line 41 of file ExecFlagRegistry.h.

Referenced by MooseUtils::getDefaultExecFlagEnum().

{ return _default_flags; };

getExecFlagRegistry()

ExecFlagRegistry & moose::internal::ExecFlagRegistry::getExecFlagRegistry ( )

static

Return Singleton instance.

Definition at line 19 of file ExecFlagRegistry.C.

Referenced by MooseUtils::getDefaultExecFlagEnum().

{
  static ExecFlagRegistry exec_flag_registry;
  return exec_flag_registry;
}

getFlags()

const ExecFlagEnum& moose::internal::ExecFlagRegistry::getFlags ( ) const

inline

Returns

The registered exec flags.

Definition at line 36 of file ExecFlagRegistry.h.

{ return _flags; };

operator=() [1/2]

ExecFlagRegistry& moose::internal::ExecFlagRegistry::operator= ( ExecFlagRegistry const &  )

delete

operator=() [2/2]

ExecFlagRegistry& moose::internal::ExecFlagRegistry::operator= ( ExecFlagRegistry &&  )

delete

registerFlag()

const ExecFlagType & moose::internal::ExecFlagRegistry::registerFlag	(	const std::string &	name,
		const bool	is_default
	)

Registers an execute flag.

Parameters

name	The name of the execute flag.
is_default	Whether or not to define the flag as a default (available to all objects that use the SetupInterface).

Definition at line 26 of file ExecFlagRegistry.C.

{
  const auto name_upper = MooseUtils::toUpper(name);
  const auto flag_iter = _flags.find(name_upper);
  if (flag_iter != _flags.items().end())
  {
    // Assume that this is not a duplicate name, but a "double registration" due
    // to the dynamic load functionality.
    return *flag_iter;
  }

  const auto & flag = _flags.addAvailableFlags(ExecFlagType(name_upper, _flags.getNextValidID()));

  if (is_default)
    _default_flags.addAvailableFlags(flag);

  return flag;
}

Member Data Documentation

_default_flags

ExecFlagEnum moose::internal::ExecFlagRegistry::_default_flags

private

The default flags.

Definition at line 62 of file ExecFlagRegistry.h.

Referenced by getDefaultFlags(), and registerFlag().

_flags

ExecFlagEnum moose::internal::ExecFlagRegistry::_flags

private

The registered flags.

Definition at line 59 of file ExecFlagRegistry.h.

Referenced by getFlags(), and registerFlag().

---

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

• include/base/ExecFlagRegistry.h
• src/base/ExecFlagRegistry.C