Moose::WebServerControlTypeRegistry Class Reference

A static registry used to register and build values of different types for the WebServerControl. More...

#include <WebServerControlTypeRegistry.h>

Classes
class	ControlledValueBase
	The base class for a value that is produced by this registry. More...
struct	RegisteredType
	Derived registry item. More...
class	RegisteredTypeBase
	Base registry class for a type that is used to build values. More...

Static Public Member Functions
static WebServerControlTypeRegistry &	getRegistry ()
template<class ControlledValue , class ValueType >
static char	add (const std::string &type_name, std::function< ValueType(const nlohmann::json &)> &&parse_function)
	Register a type in the registry. More...
static const RegisteredTypeBase *	query (const std::string &type)
	Query the registration for the given type. More...
static const RegisteredTypeBase &	get (const std::string &type)
	Get the registration for the given type, erroring if it isn't registered. More...

Private Attributes
std::map< std::string, std::unique_ptr< RegisteredTypeBase > >	_name_map
	The registration data. More...
std::set< std::type_index >	_value_types
	The registered value types, to avoid registering the same underlying value type multiple times. More...

Detailed Description

A static registry used to register and build values of different types for the WebServerControl.

Needed due to the complexities of parsing parameter types from generic JSON received by the web server.

Definition at line 33 of file WebServerControlTypeRegistry.h.

Member Function Documentation

add()

template<class ControlledValue , class ValueType >

char Moose::WebServerControlTypeRegistry::add ( const std::string &  type_name, std::function< ValueType(const nlohmann::json &)> &&  parse_function  )

static

Register a type in the registry.

Template Parameters

ControlledValue	The derived ControlledValueBase class that contains the implementation for setting the controllable value
ValueType	The underlying type of the value to be controlled

Parameters

type_name	Human readable name for the type of the value to be controlled
parse_function	Function used to parse the value from JSON

Definition at line 185 of file WebServerControlTypeRegistry.h.

Referenced by Moose::WebServerControlTypeRegistration::registerType().

{
  static_assert(std::is_base_of_v<ControlledValueBase, ControlledValue>,
                "Is not derived from ControlledValueBase");
  static_assert(std::is_same_v<typename ControlledValue::value_type, ValueType>, "Is not the same");

  auto entry = std::make_unique<RegisteredType<ControlledValue, ValueType>>(
      type_name, std::move(parse_function));
  if (!getRegistry()._name_map.emplace(type_name, std::move(entry)).second)
    ::mooseError(
        "WebServerControlTypeRegistry: The string type \"", type_name, "\" is already registered.");

  static const std::type_index index = typeid(ValueType);
  if (!getRegistry()._value_types.insert(index).second)
    ::mooseError("WebServerControlRegistry: The type \"",
                 MooseUtils::prettyCppType<ValueType>(),
                 "\" is already registered");
  return 0;
}

get()

const WebServerControlTypeRegistry::RegisteredTypeBase & Moose::WebServerControlTypeRegistry::get ( const std::string &  type )

static

Get the registration for the given type, erroring if it isn't registered.

Definition at line 36 of file WebServerControlTypeRegistry.C.

Referenced by WebServerControl::execute().

{
  if (const auto obj = query(type))
    return *obj;
  mooseError("WebServerControlTypeRegistry: The type '", type, "' is not registered");
}

getRegistry()

WebServerControlTypeRegistry & Moose::WebServerControlTypeRegistry::getRegistry ( )

static

Returns

The WebServerControlTypeRegistry singleton

Definition at line 15 of file WebServerControlTypeRegistry.C.

Referenced by add(), and query().

{
  static WebServerControlTypeRegistry * registry_singleton = nullptr;
  if (!registry_singleton)
    registry_singleton = new WebServerControlTypeRegistry;
  return *registry_singleton;
}

query()

const WebServerControlTypeRegistry::RegisteredTypeBase * Moose::WebServerControlTypeRegistry::query ( const std::string &  type )

static

Query the registration for the given type.

Definition at line 24 of file WebServerControlTypeRegistry.C.

Referenced by WebServerControl::addServerActionsInternal(), and get().

{
  const auto & name_map = getRegistry()._name_map;
  if (const auto it = name_map.find(type); it != name_map.end())
  {
    mooseAssert(it->second, "Item is nullptr");
    return it->second.get();
  }
  return nullptr;
}

Member Data Documentation

_name_map

std::map<std::string, std::unique_ptr<RegisteredTypeBase> > Moose::WebServerControlTypeRegistry::_name_map

private

The registration data.

Definition at line 177 of file WebServerControlTypeRegistry.h.

Referenced by add(), and query().

_value_types

std::set<std::type_index> Moose::WebServerControlTypeRegistry::_value_types

private

The registered value types, to avoid registering the same underlying value type multiple times.

Definition at line 180 of file WebServerControlTypeRegistry.h.

Referenced by add().

---

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

• include/controls/WebServerControlTypeRegistry.h
• src/controls/WebServerControlTypeRegistry.C