Registrar< RegisteredType, KeyType, class > Class Template Reference

Stores key object pairs. More...

#include <ArmarXCore/core/util/Registrar.h>

Classes
struct	RegisterElement
	Registers the object passed to the constructor. More...

Public Types
using	ContainerType = std::unordered_map<KeyType, RegisteredType>

Static Public Member Functions
static const RegisteredType &	get (const KeyType &key)
	Returns the registered object for the given key.
static std::vector< KeyType >	getKeys ()
	Retrieves the list of all registered elements.
static bool	has (const KeyType &key)
static void	registerElement (const KeyType &key, RegisteredType element)
	Registers an element.

Detailed Description

template<class RegisteredType, class KeyType = std::string, class = void>
class armarx::Registrar< RegisteredType, KeyType, class >

Stores key object pairs.

The third template parameter offers the option to tag this registrar with a class.

If polymorphic objects are required use a base class and unique pointers. E.g.:

class Base{};
class DerivedA{};
class DerivedB{};
Registrar<std::unique_ptr<Base>>::registerElement("A", DerivedA{});
Registrar<std::unique_ptr<Base>>::registerElement("B", DerivedB{});

If functions are stored use std::function (or function pointers).

To register elements on file inclusion use this code in the header (note the missing static).

Registrar<Type>::RegisterElement register("A", object);

Example for strings

Registrar<std::string>::RegisterElement register1("key 1", "value 1");
Registrar<std::string>::RegisterElement register2("key 2", "value 2");

Member Typedef Documentation

ContainerType

template<class RegisteredType, class KeyType = std::string, class = void>

using ContainerType = std::unordered_map<KeyType, RegisteredType>

Member Function Documentation

get()

template<class RegisteredType, class KeyType = std::string, class = void>

static const RegisteredType & get ( const KeyType & key )

inlinestatic

Returns the registered object for the given key.

Parameters

key	The object's key.

Returns

The registered object for the given key.

getKeys()

template<class RegisteredType, class KeyType = std::string, class = void>

static std::vector< KeyType > getKeys ( )

inlinestatic

Retrieves the list of all registered elements.

Returns

The list of all registered elements.

has()

template<class RegisteredType, class KeyType = std::string, class = void>

static bool has ( const KeyType & key )

inlinestatic

registerElement()

template<class RegisteredType, class KeyType = std::string, class = void>

static void registerElement ( const KeyType & key, RegisteredType element )

inlinestatic

Registers an element.

Parameters

key	The element's key.
element	The element.

---

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

• ArmarXCore/core/util/Registrar.h