ModuleParamBase Class Reference

Base class for module parameter. More...

#include <ModuleParamBase.h>

Inheritance diagram for ModuleParamBase:

Public Member Functions
	ModuleParamBase (std::string typeInfo, std::string description, bool force)
	Constructor.
virtual	~ModuleParamBase ()
	Destructor.
const std::string &	getTypeInfo () const
	Returns the type identifier of the parameter as string.
const std::string &	getDescription () const
	Returns the description of the parameter.
void	setDescription (const std::string &description)
	Sets description to new value.
bool	isSetInSteering () const
	Returns true if the parameter was set in the steering file.
bool	isForcedInSteering () const
	Returns true if the parameter has to be set by the user in the steering file.
virtual void	setValueFromPythonObject (const boost::python::object &pyObject)=0
	Pure virtual function.
virtual void	setValueToPythonObject (boost::python::object &pyObject, bool defaultValues=false) const =0
	Pure virtual function.
virtual void	setValueFromParam (const ModuleParamBase &param)=0
	Set value from other ModuleParam of same type.

Protected Attributes
std::string	m_typeInfo
	The type of the parameter stored as string.
std::string	m_description
	The (optional) description of the parameter.
bool	m_forceInSteering
	If true the parameter has to be set by the user in the steering file.
bool	m_setInSteering
	True, if the parameter value was changed in the steering file.

Detailed Description

Base class for module parameter.

The base class stores all common information for parameters.

Definition at line 31 of file ModuleParamBase.h.

Constructor & Destructor Documentation

ModuleParamBase()

ModuleParamBase	(	std::string	typeInfo,
		std::string	description,
		bool	force )

Constructor.

Parameters

typeInfo	The type string of the parameter.
description	The description of the parameter.
force	If true the parameter has to be set in the steering file by the user.

Definition at line 15 of file ModuleParamBase.cc.

  : m_typeInfo(std::move(typeInfo))
  , m_description(std::move(description))
  , m_forceInSteering(force)
  , m_setInSteering(false)
{
}

Member Function Documentation

getDescription()

const std::string & getDescription

(

)

const

Returns the description of the parameter.

Returns

The description of the parameter.

Definition at line 30 of file ModuleParamBase.cc.

{
  return m_description;
}

getTypeInfo()

const std::string & getTypeInfo

(

)

const

Returns the type identifier of the parameter as string.

The type identifier is used to discriminate between problematic parameter types (e.g. double and int).

Returns

The type identifier as string.

Definition at line 25 of file ModuleParamBase.cc.

{
  return m_typeInfo;
}

isForcedInSteering()

bool isForcedInSteering

(

)

const

Returns true if the parameter has to be set by the user in the steering file.

Returns

True if the parameter has to be set in the steering file.

Definition at line 46 of file ModuleParamBase.cc.

{
  return m_forceInSteering;
}

isSetInSteering()

bool isSetInSteering

(

)

const

Returns true if the parameter was set in the steering file.

If the value was not set in the steering file but is still the default value, this method returns false.

Returns

True if the parameter was set in the steering file.

Definition at line 41 of file ModuleParamBase.cc.

{
  return m_setInSteering;
}

setDescription()

void setDescription

(

const std::string &

description

)

Sets description to new value.

Parameters

description

set the description to this value

Definition at line 36 of file ModuleParamBase.cc.

{
  m_description = description;
}

setValueFromParam()

virtual void setValueFromParam ( const ModuleParamBase & param )

pure virtual

Set value from other ModuleParam of same type.

Implemented in ModuleParam< T >, and ModuleParam< bool >.

setValueFromPythonObject()

virtual void setValueFromPythonObject ( const boost::python::object & pyObject )

pure virtual

Pure virtual function.

Set the value of the parameter from a python object. The derived templated ModuleParam class calls the converter functions in PyObjConvUtils.h with the right template arguments. Hence the compiler can automatically infer the right converter.

Parameters

pyObject

The python object which holds the parameter value

Implemented in ModuleParam< T >, and ModuleParam< bool >.

setValueToPythonObject()

virtual void setValueToPythonObject ( boost::python::object & pyObject, bool defaultValues = false ) const

pure virtual

Pure virtual function.

Set the value of a python objects to stored parameter value. The derived templated ModuleParam class calls the converter functions in PyObjConvUtils.h with the right template arguments. Hence the compiler can automatically infer the right converters

Parameters

pyObject	The python object which should be filled with the parameter value
defaultValues	If true, the python object is set to the default value of this parameter.

Implemented in ModuleParam< T >, and ModuleParam< bool >.

Member Data Documentation

m_description

std::string m_description

protected

The (optional) description of the parameter.

Definition at line 121 of file ModuleParamBase.h.

m_forceInSteering

bool m_forceInSteering

protected

If true the parameter has to be set by the user in the steering file.

Definition at line 124 of file ModuleParamBase.h.

m_setInSteering

bool m_setInSteering

protected

True, if the parameter value was changed in the steering file.

Definition at line 127 of file ModuleParamBase.h.

m_typeInfo

std::string m_typeInfo

protected

The type of the parameter stored as string.

Definition at line 118 of file ModuleParamBase.h.

---

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

• framework/core/include/ModuleParamBase.h
• framework/core/src/ModuleParamBase.cc