o2::framework::ConfigParamSpec Class Reference

#include <ConfigParamSpec.h>

Classes
struct	HelpString

Public Types
using	ParamType = VariantType

Public Member Functions
template<typename T >
	ConfigParamSpec (std::string, ParamType, Variant, T)
	ConfigParamSpec (std::string _name, ParamType _type, Variant _defaultValue, HelpString _help, ConfigParamKind kind_=ConfigParamKind::kGeneric)
	ConfigParamSpec (std::string _name, ParamType _type, HelpString _help)
bool	operator== (ConfigParamSpec const &that) const

Public Attributes
std::string	name
ParamType	type
Variant	defaultValue
HelpString	help
ConfigParamKind	kind

Detailed Description

options for a processor An option definition consists of a name, a type, a help message, and an optional default value. The type of the argument has to be specified in terms of VariantType

Options and arguments can be retrieved from the init context in the initialization function: context.options().get<TYPE>("NAME")

All options are also forwarded to the device.

Definition at line 31 of file ConfigParamSpec.h.

Member Typedef Documentation

ParamType

using o2::framework::ConfigParamSpec::ParamType = VariantType

Definition at line 32 of file ConfigParamSpec.h.

Constructor & Destructor Documentation

ConfigParamSpec() [1/3]

template<typename T >

o2::framework::ConfigParamSpec::ConfigParamSpec ( std::string  , ParamType  , Variant  , T    )

inline

Definition at line 39 of file ConfigParamSpec.h.

ConfigParamSpec() [2/3]

o2::framework::ConfigParamSpec::ConfigParamSpec ( std::string  _name, ParamType  _type, Variant  _defaultValue, HelpString  _help, ConfigParamKind  kind_ = ConfigParamKind::kGeneric  )

inline

Definition at line 46 of file ConfigParamSpec.h.

ConfigParamSpec() [3/3]

o2::framework::ConfigParamSpec::ConfigParamSpec ( std::string  _name, ParamType  _type, HelpString  _help  )

inline

config spec without default value, explicitely marked as 'empty' and will be ignored at other places

Definition at line 54 of file ConfigParamSpec.h.

Member Function Documentation

operator==()

bool o2::framework::ConfigParamSpec::operator== ( ConfigParamSpec const &  that ) const

inline

Definition at line 57 of file ConfigParamSpec.h.

Member Data Documentation

defaultValue

Variant o2::framework::ConfigParamSpec::defaultValue

Definition at line 64 of file ConfigParamSpec.h.

help

HelpString o2::framework::ConfigParamSpec::help

Definition at line 65 of file ConfigParamSpec.h.

kind

ConfigParamKind o2::framework::ConfigParamSpec::kind

Definition at line 66 of file ConfigParamSpec.h.

name

std::string o2::framework::ConfigParamSpec::name

Definition at line 62 of file ConfigParamSpec.h.

type

ParamType o2::framework::ConfigParamSpec::type

Definition at line 63 of file ConfigParamSpec.h.

---

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

• /home/runner/work/AliceO2/AliceO2/Framework/Core/include/Framework/ConfigParamSpec.h