ModuleParamList Class Reference

The Module parameter list class. More...

#include <ModuleParamList.h>

Collaboration diagram for ModuleParamList:

Public Member Functions
	ModuleParamList ()
	Constructor.
	~ModuleParamList ()
	Destructor.
template<typename T >
void	addParameter (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
	Adds a new parameter to the module list.
template<typename T >
void	addParameter (const std::string &name, T &paramVariable, const std::string &description)
	Adds a new enforced parameter to the module list.
template<typename T >
void	setParameter (const std::string &name, const T &value)
	Sets the value of a parameter given by its name.
void	setParameters (const ModuleParamList &params)
	Set values for parameters from other parameter list.
std::vector< std::string >	getParameterNames () const
	Returns the names of all parameters in this parameter list.
std::string	getParameterDescription (const std::string &name) const
	Returns the description of a parameter given by its name.
std::string	getParameterTypeInfo (const std::string &name) const
	Returns the type info of a parameter given by its name.
template<typename T >
ModuleParam< T > &	getParameter (const std::string &name) const
	Returns a reference to a parameter.
std::vector< std::string >	getUnsetForcedParams () const
	Returns list of unset parameters (if they are required to have a value.
std::shared_ptr< boost::python::list >	getParamInfoListPython () const
	Returns a python list of all parameters.
template<typename PythonObject >
void	setParamPython (const std::string &name, const PythonObject &pyObj)
	Implements a method for setting boost::python objects.
template<typename PythonObject >
void	getParamValuesPython (const std::string &name, PythonObject &pyOutput, bool defaultValues) const
	Returns a python object containing the value or default value of the given parameter.

Private Member Functions
ModuleParamPtr	getParameterPtr (const std::string &name) const
	Returns a ModuleParamPtr to a parameter.

Static Private Member Functions
static void	throwNotFoundError (const std::string &name)
	Throws an error for a requested parameter that does not exist.
static void	throwTypeError (const std::string &name, const std::string &expectedTypeInfo, const std::string &typeInfo)
	Throws an error for a requested parameter that exists but was request with the wrong type.

Private Attributes
std::map< std::string, ModuleParamPtr >	m_paramMap
	Stores the module parameters together with a string name as key.

Detailed Description

The Module parameter list class.

Stores and manages all parameters of a module.

Definition at line 44 of file ModuleParamList.h.

Constructor & Destructor Documentation

~ModuleParamList()

~ModuleParamList

(

)

Destructor.

Definition at line 48 of file ModuleParamList.cc.

{
  m_paramMap.clear();
}

Member Function Documentation

getParameterDescription()

std::string getParameterDescription

(

const std::string &

name

)

const

Returns the description of a parameter given by its name.

Throws an exception of type ModuleParameterNotFoundError if a parameter with the given name does not exist.

Parameters

name	The unique name of the parameter.

Returns

The description of the parameter as string

Definition at line 105 of file ModuleParamList.cc.

{
  return getParameterPtr(name)->getDescription();
}

getParameterNames()

std::vector< std::string > getParameterNames

(

)

const

Returns the names of all parameters in this parameter list.

Returns

The names of the parameters

Definition at line 95 of file ModuleParamList.cc.

{
  std::vector<std::string> names;
  names.reserve(m_paramMap.size());
  for (const auto& nameAndParam : m_paramMap) {
    names.push_back(nameAndParam.first);
  }
  return names;
}

getParameterPtr()

ModuleParamPtr getParameterPtr ( const std::string &  name ) const

private

Returns a ModuleParamPtr to a parameter.

Throws an exception of type ModuleParameterNotFoundError if a parameter with the given name does not exist.

Parameters

name	The unique name of the parameter.

Returns

A ModuleParamPtr to a module parameter.

Definition at line 124 of file ModuleParamList.cc.

{
  //Check if a parameter with the given name exists
  std::map<std::string, ModuleParamPtr>::const_iterator mapIter;
  mapIter = m_paramMap.find(name);
 
  if (mapIter != m_paramMap.end()) {
    return mapIter->second;
  } else throw (ModuleParameterNotFoundError() << name);
}

getParameterTypeInfo()

std::string getParameterTypeInfo

(

const std::string &

name

)

const

Returns the type info of a parameter given by its name.

Throws an exception of type ModuleParameterNotFoundError if a parameter with the given name does not exist.

Parameters

name	The unique name of the parameter.

Returns

The type information as descriptive string

Definition at line 110 of file ModuleParamList.cc.

{
  return getParameterPtr(name)->getTypeInfo();
}

getParamInfoListPython()

std::shared_ptr< boost::python::list > getParamInfoListPython

(

)

const

Returns a python list of all parameters.

Each item in the list consists of the name of the parameter, a string describing its type, a python list of all values, a python list of all default values, the information of the parameter was set in the steering file and the description of the parameter.

Returns

A python list containing the parameters of this parameter list.

Definition at line 64 of file ModuleParamList.cc.

{
  std::shared_ptr<boost::python::list> returnList(new boost::python::list);
  std::map<std::string, ModuleParamPtr>::const_iterator mapIter;
 
  for (mapIter = m_paramMap.begin(); mapIter != m_paramMap.end(); ++mapIter) {
    ModuleParamInfoPython newParamInfo;
    ModuleParamPtr currParam = mapIter->second;
 
    newParamInfo.m_name = mapIter->first;
    newParamInfo.m_description = currParam->getDescription();
    newParamInfo.m_typeName = currParam->getTypeInfo();
    newParamInfo.m_setInSteering = currParam->isSetInSteering();
    newParamInfo.m_forceInSteering = currParam->isForcedInSteering();
    getParamValuesPython(mapIter->first, newParamInfo.m_defaultValues, true);
    getParamValuesPython(mapIter->first, newParamInfo.m_values, false);
 
    returnList->append(boost::python::object(newParamInfo));
  }
  return returnList;
}

getUnsetForcedParams()

std::vector< std::string > getUnsetForcedParams

(

)

const

Returns list of unset parameters (if they are required to have a value.

Definition at line 54 of file ModuleParamList.cc.

{
  std::vector<std::string> missingParam;
  for (const auto& mapEntry : m_paramMap) {
    if (mapEntry.second->isForcedInSteering() && !mapEntry.second->isSetInSteering())
      missingParam.push_back(mapEntry.first);
  }
  return missingParam;
}

setParameters()

void setParameters

(

const ModuleParamList &

params

)

Set values for parameters from other parameter list.

Definition at line 86 of file ModuleParamList.cc.

{
  for (const auto& param : params.m_paramMap) {
    auto& myParam = m_paramMap.at(param.first);
    myParam->setValueFromParam(*param.second.get());
  }
}

throwNotFoundError()

void throwNotFoundError ( const std::string &  name )

staticprivate

Throws an error for a requested parameter that does not exist.

Parameters

name	The name of the parameter.

Definition at line 33 of file ModuleParamList.cc.

{
  throw (ModuleParameterNotFoundError() << name);
}

throwTypeError()

void throwTypeError ( const std::string &  name, const std::string &  expectedTypeInfo, const std::string &  typeInfo  )

staticprivate

Throws an error for a requested parameter that exists but was request with the wrong type.

Parameters

name	The name of the parameter.
expectedTypeInfo	Type information which the parameter actually has.
typeInfo	Type information with which the parameter was looked up.

Definition at line 38 of file ModuleParamList.cc.

{
  throw (ModuleParameterTypeError() << name << expectedTypeInfo << typeInfo);
}

Member Data Documentation

m_paramMap

std::map<std::string, ModuleParamPtr> m_paramMap

private

Stores the module parameters together with a string name as key.

Definition at line 214 of file ModuleParamList.h.

---

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

• framework/core/include/ModuleParamList.h
• framework/core/include/ModuleParamList.templateDetails.h
• framework/core/src/ModuleParamList.cc