Moose::ParameterRegistry Class Reference

Registry that allows for the typeless setting of a parameter value from a hit field. More...

#include <ParameterRegistry.h>

Public Member Functions
template<class T , class F >
char	add (F &&f)
	Add a parameter. More...
void	set (libMesh::Parameters::Value &value, const hit::Field &field) const
	Sets a parameter value given a hit field. More...

Static Public Member Functions
static ParameterRegistry &	get ()
	Get the singleton registry. More...

Private Member Functions
	ParameterRegistry ()
	Constructor; private so that it can only be created with the singleton. More...
	FRIEND_TEST (::ParameterRegistryTest, add)
	FRIEND_TEST (::ParameterRegistryTest, addExists)
	FRIEND_TEST (::ParameterRegistryTest, set)
	FRIEND_TEST (::ParameterRegistryTest, setNotRegistered)
	FRIEND_TEST (::ParameterRegistryTest, setCatchMooseError)

Private Attributes
std::unordered_map< std::type_index, std::function< void(libMesh::Parameters::Value &value, const hit::Field &)> >	_registry
	Registration map of type -> function to fill each type. More...

Detailed Description

Registry that allows for the typeless setting of a parameter value from a hit field.

Definition at line 43 of file ParameterRegistry.h.

Constructor & Destructor Documentation

ParameterRegistry()

Moose::ParameterRegistry::ParameterRegistry ( )

inlineprivate

Constructor; private so that it can only be created with the singleton.

Definition at line 66 of file ParameterRegistry.h.

Referenced by get().

{};

Member Function Documentation

add()

template<class T , class F >

char Moose::ParameterRegistry::add

(

F &&

f

)

Add a parameter.

Definition at line 84 of file ParameterRegistry.h.

{
  static_assert(std::is_invocable_r_v<void, F &, T &, const hit::Field &>,
                "Setter function must be callable with (T &, const hit::Field &) and return void");

  // We register a function that stores T &, but the registry will only ever be
  // called from a bare libMesh::Parameters::Value. Thus, we need to cast the
  // bare Value to the derived value and then call the setter.
  auto setter = [f = std::forward<F>(f)](libMesh::Parameters::Value & param_value,
                                         const hit::Field & field) -> void
  {
    auto cast_param_value = dynamic_cast<libMesh::Parameters::Parameter<T> *>(&param_value);
    mooseAssert(cast_param_value, "Cast failed");
    f(cast_param_value->set(), field);
  };

  const std::type_index key(typeid(T));
  const auto it_inserted_pair = _registry.emplace(key, std::move(setter));

  if (!it_inserted_pair.second)
    mooseError("ParameterRegistry: Parameter with type '",
               MooseUtils::prettyCppType<T>(),
               "' is already registered");

  return 0;
}

FRIEND_TEST() [1/5]

Moose::ParameterRegistry::FRIEND_TEST ( ::ParameterRegistryTest  , add    )

private

FRIEND_TEST() [2/5]

Moose::ParameterRegistry::FRIEND_TEST ( ::ParameterRegistryTest  , addExists    )

private

FRIEND_TEST() [3/5]

Moose::ParameterRegistry::FRIEND_TEST ( ::ParameterRegistryTest  , set    )

private

FRIEND_TEST() [4/5]

Moose::ParameterRegistry::FRIEND_TEST ( ::ParameterRegistryTest  , setNotRegistered    )

private

FRIEND_TEST() [5/5]

Moose::ParameterRegistry::FRIEND_TEST ( ::ParameterRegistryTest  , setCatchMooseError    )

private

get()

ParameterRegistry & Moose::ParameterRegistry::get ( )

static

Get the singleton registry.

Definition at line 17 of file ParameterRegistry.C.

Referenced by Moose::Builder::extractParams(), and MooseApp::registerInterfaceObject().

{
  static ParameterRegistry * registry = nullptr;
  if (!registry)
    registry = new ParameterRegistry();
  return *registry;
}

set()

void Moose::ParameterRegistry::set	(	libMesh::Parameters::Value &	value,
		const hit::Field &	field
	)		const

Sets a parameter value given a hit field.

Definition at line 26 of file ParameterRegistry.C.

Referenced by Moose::Builder::extractParams().

{
  const std::type_index key(value.type_info());
  const auto it = _registry.find(key);
  if (it == _registry.end())
    mooseError("ParameterRegistry::set(): Parameter type '",
               MooseUtils::prettyCppType(value.type()),
               "' is not registered");

  // Catch all mooseErrors so that they can be accumulated during
  // parsing and building instead of ending the run
  Moose::ScopedThrowOnError scoped_throw_on_error;

  it->second(value, field);
}

Member Data Documentation

_registry

std::unordered_map<std::type_index, std::function<void(libMesh::Parameters::Value & value, const hit::Field &)> > Moose::ParameterRegistry::_registry

private

Registration map of type -> function to fill each type.

Definition at line 79 of file ParameterRegistry.h.

Referenced by add(), and set().

---

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

• include/parser/ParameterRegistry.h
• src/parser/ParameterRegistry.C