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

#include <WebServerControlTypeRegistry.h>

Classes
struct	Type

class	TypeBase
	Base registry class for a type that is used to build values. More...

class	ValueBase
	The base class for a value that is produced by this registry. More...

Static Public Member Functions
static WebServerControlTypeRegistry &	getRegistry ()

template<typename DerivedValueType >
static char	add (const std::string &type_name)
	Registers a type with string name `type_name` and the given derived type. More...

static bool	isRegistered (const std::string &type)

static std::unique_ptr< ValueBase >	build (const std::string &type, const std::string &name)
	Builds a value with the type `type`, name `name`, and a default value. More...

static std::unique_ptr< ValueBase >	build (const std::string &type, const std::string &name, const miniJson::Json &json_value)
	Builds a value with the type `type`, name `name`, and a value parsed from `json_value`. More...

Static Private Member Functions
static const TypeBase &	get (const std::string &type)
	Internal getter for the registration object for type `type`. More...

Private Attributes
std::map< std::string, std::unique_ptr< TypeBase > >	_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 32 of file WebServerControlTypeRegistry.h.

Member Function Documentation

◆ add()

template<typename DerivedValueType >

static char Moose::WebServerControlTypeRegistry::add ( const std::string & type_name )

inlinestatic

Registers a type with string name type_name and the given derived type.

Definition at line 95 of file WebServerControlTypeRegistry.h.

Referenced by WebServerControl::registerRealEigenMatrix(), WebServerControl::registerScalarType(), and WebServerControl::registerVectorType().

   {
     static_assert(std::is_base_of_v<ValueBase, DerivedValueType>, "Is not derived from ValueBase");
     using value_type = typename DerivedValueType::value_type;
     static const std::type_index index = typeid(value_type);
     if (!getRegistry()
              ._name_map.emplace(type_name, std::make_unique<Type<DerivedValueType>>(type_name))
              .second)
       ::mooseError("WebServerControlTypeRegistry: The string type \"",
                    type_name,
                    "\" is already registered.");
     if (!getRegistry()._value_types.insert(index).second)
       ::mooseError("WebServerControlRegistry: The type \"",
                    MooseUtils::prettyCppType<value_type>(),
                    "\" is already registered");
     return 0;
   }

◆ build() [1/2]

static std::unique_ptr<ValueBase> Moose::WebServerControlTypeRegistry::build	(	const std::string &	type,
		const std::string &	name
	)

inlinestatic

Builds a value with the type type, name name, and a default value.

Definition at line 121 of file WebServerControlTypeRegistry.h.

Referenced by build(), WebServerControl::execute(), and WebServerControl::startServer().

   {
     return get(type).build(name);
   }

◆ build() [2/2]

static std::unique_ptr<ValueBase> Moose::WebServerControlTypeRegistry::build	(	const std::string &	type,
		const std::string &	name,
		const miniJson::Json &	json_value
	)

inlinestatic

Builds a value with the type type, name name, and a value parsed from json_value.

Will throw ValueBase::Exception on a parsing error.

Definition at line 131 of file WebServerControlTypeRegistry.h.

   {
     return get(type).build(name, json_value);
   }

◆ get()

static const TypeBase& Moose::WebServerControlTypeRegistry::get ( const std::string & type )

inlinestaticprivate

Internal getter for the registration object for type type.

Definition at line 191 of file WebServerControlTypeRegistry.h.

   {
     auto & registry = getRegistry();
     const auto it = registry._name_map.find(type);
     if (it == registry._name_map.end())
       mooseError("WebServerControlTypeRegistry: The type '", type, "' is not registered");
     return *it->second;
   }

◆ getRegistry()

WebServerControlTypeRegistry & Moose::WebServerControlTypeRegistry::getRegistry ( )

static

Returns: The WebServerControlTypeRegistry singleton

Definition at line 15 of file WebServerControlTypeRegistry.C.

Referenced by add(), get(), and isRegistered().

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