framework::config::Parameters Class Reference

Class encapsulating parameters for configuring a processor. More...

#include <Parameters.h>

Public Member Functions
template<typename T >
void	add (const std::string &name, const T &value)
	Add a parameter to the parameter list.
template<typename T >
void	addParameter (const std::string &name, const T &value)
bool	exists (const std::string &name) const
	Check to see if a parameter exists.
template<typename T >
const T &	get (const std::string &name) const
	Retrieve the parameter of the given name.
template<typename T >
const T &	getParameter (const std::string &name) const
template<typename T >
const T &	get (const std::string &name, const T &def) const
	Retrieve a parameter with a default specified.
template<typename T >
const T &	getParameter (const std::string &name, const T &def) const
std::vector< std::string >	keys () const
	Get a list of the keys available.

Private Attributes
std::map< std::string, std::any >	parameters_
	container holding parameter names and their values

Detailed Description

Class encapsulating parameters for configuring a processor.

The storage of arbitrary parameters recursively is done using a map from parameter names (std::string) to parameter values. The values are stored in std::any which allows the user to store any object they wish in a memory-safe environment.

Definition at line 29 of file Parameters.h.

Member Function Documentation

add()

template<typename T >

void framework::config::Parameters::add ( const std::string & name, const T & value )

inline

Add a parameter to the parameter list.

If the parameter already exists in the list, throw an exception.

Parameters

[in]	name	Name of the parameter.
[in]	value	The value of the parameter.

Template Parameters

T	type of parameter being added

Exceptions

Exception

if a parameter by that name already exist in the list.

Definition at line 42 of file Parameters.h.

                                                  {
    if (exists(name)) {
      EXCEPTION_RAISE("Config",
                      "The parameter " + name +
                          " already exists in the list of parameters.");
    }
 
    parameters_[name] = value;
  }

References exists(), and parameters_.

Referenced by framework::config::getMembers().

addParameter()

template<typename T >

void framework::config::Parameters::addParameter ( const std::string & name, const T & value )

inline

Definition at line 53 of file Parameters.h.

                                                           {
    add<T>(name, value);
  }

exists()

bool framework::config::Parameters::exists ( const std::string & name ) const

inline

Check to see if a parameter exists.

Parameters

[in]

name

name of parameter to check

Returns

true if parameter exists in configuration set

Definition at line 63 of file Parameters.h.

                                           {
    return parameters_.find(name) != parameters_.end();
  }

References parameters_.

Referenced by add(), get(), get(), and hcal::HcalGeometryProvider::getCondition().

get() [1/2]

template<typename T >

const T & framework::config::Parameters::get ( const std::string & name ) const

inline

Retrieve the parameter of the given name.

Exceptions

Exception	if parameter of the given name isn't found
Exception	if parameter is found but not of the input type

Template Parameters

T	the data type to cast the parameter to.

Parameters

[in]

name

the name of the parameter value to retrieve.

Returns

The user specified parameter of type T.

Definition at line 78 of file Parameters.h.

                                            {
    // Check if the variable exists in the map.  If it doesn't,
    // raise an exception.
    if (not exists(name)) {
      EXCEPTION_RAISE("Config", "Parameter '" + name +
                                    "' does not exist in list of parameters.");
    }
 
    try {
      return std::any_cast<const T&>(parameters_.at(name));
    } catch (const std::bad_any_cast& e) {
      EXCEPTION_RAISE(
          "Config",
          "Parameter '" + name + "' of type '" +
              boost::core::demangle(parameters_.at(name).type().name()) +
              "' is being cast to incorrect type '" +
              boost::core::demangle(typeid(T).name()) + "'.");
    }
  }

References exists(), and parameters_.

Referenced by get().

get() [2/2]

template<typename T >

const T & framework::config::Parameters::get ( const std::string & name, const T & def ) const

inline

Retrieve a parameter with a default specified.

Return the input default if a parameter is not found in map.

Template Parameters

T	type of parameter to return

Parameters

[in]	name	parameter name to retrieve
[in,out]	def	default to use if parameter is not found

Returns

the user parameter of type T

Definition at line 114 of file Parameters.h.

                                                          {
    if (not exists(name)) return def;
 
    // get here knowing that name exists in parameters_
    return get<T>(name);
  }

References exists(), and get().

getParameter() [1/2]

template<typename T >

const T & framework::config::Parameters::getParameter ( const std::string & name ) const

inline

Definition at line 99 of file Parameters.h.

                                                     {
    return get<T>(name);
  }

getParameter() [2/2]

template<typename T >

const T & framework::config::Parameters::getParameter ( const std::string & name, const T & def ) const

inline

Definition at line 122 of file Parameters.h.

                                                                   {
    return get<T>(name, def);
  }

keys()

std::vector< std::string > framework::config::Parameters::keys ( ) const

inline

Get a list of the keys available.

This may be helpful in debugging to make sure the parameters are spelled correctly.

Returns

list of all keys in this map of parameters

Definition at line 134 of file Parameters.h.

                                    {
    std::vector<std::string> key;
    for (auto i : parameters_) key.push_back(i.first);
    return key;
  }

References parameters_.

Referenced by hcal::HcalGeometryProvider::getCondition().

Member Data Documentation

parameters_

std::map<std::string, std::any> framework::config::Parameters::parameters_

private

container holding parameter names and their values

Definition at line 142 of file Parameters.h.

Referenced by add(), exists(), get(), and keys().

---

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

• Framework/include/Framework/Configure/Parameters.h