Belle II Software  release-05-02-19
ModuleParamBase.cc
1 /**************************************************************************
2  * BASF2 (Belle Analysis Framework 2) *
3  * Copyright(C) 2010 - Belle II Collaboration *
4  * *
5  * Author: The Belle II Collaboration *
6  * Contributors: Andreas Moll *
7  * *
8  * This software is provided "as is" without any warranty. *
9  **************************************************************************/
10 #include <framework/core/ModuleParamBase.h>
11 
12 #include <string>
13 #include <utility>
14 
15 using namespace Belle2 ;
16 
17 ModuleParamBase::ModuleParamBase(std::string typeInfo, std::string description, bool force)
18  : m_typeInfo(std::move(typeInfo))
19  , m_description(std::move(description))
20  , m_forceInSteering(force)
21  , m_setInSteering(false)
22 {
23 }
24 
26 
27 const std::string& ModuleParamBase::getTypeInfo() const
28 {
29  return m_typeInfo;
30 }
31 
32 const std::string& ModuleParamBase::getDescription() const
33 {
34  return m_description;
35 }
36 
38 {
39  return m_setInSteering;
40 }
41 
43 {
44  return m_forceInSteering;
45 }
Belle2::ModuleParamBase::~ModuleParamBase
virtual ~ModuleParamBase()
Destructor.
Belle2::ModuleParamBase::isForcedInSteering
bool isForcedInSteering() const
Returns true if the parameter has to be set by the user in the steering file.
Definition: ModuleParamBase.cc:42
Belle2::ModuleParamBase::isSetInSteering
bool isSetInSteering() const
Returns true if the parameter was set in the steering file.
Definition: ModuleParamBase.cc:37
Belle2
Abstract base class for different kinds of events.
Definition: MillepedeAlgorithm.h:19
Belle2::ModuleParamBase::getTypeInfo
const std::string & getTypeInfo() const
Returns the type identifier of the parameter as string.
Definition: ModuleParamBase.cc:27
Belle2::ModuleParamBase::m_forceInSteering
bool m_forceInSteering
If true the parameter has to be set by the user in the steering file.
Definition: ModuleParamBase.h:118
Belle2::ModuleParamBase::m_typeInfo
std::string m_typeInfo
The type of the parameter stored as string.
Definition: ModuleParamBase.h:112
Belle2::ModuleParamBase::m_description
std::string m_description
The (optional) description of the parameter.
Definition: ModuleParamBase.h:115
Belle2::ModuleParamBase::getDescription
const std::string & getDescription() const
Returns the description of the parameter.
Definition: ModuleParamBase.cc:32
Belle2::ModuleParamBase::m_setInSteering
bool m_setInSteering
True, if the parameter value was changed in the steering file.
Definition: ModuleParamBase.h:121
Belle2::ModuleParamBase::ModuleParamBase
ModuleParamBase(std::string typeInfo, std::string description, bool force)
Constructor.
Definition: ModuleParamBase.cc:17