ATLAS Offline Software
ISCT_ConditionsParameterTool.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2002-2019 CERN for the benefit of the ATLAS collaboration
3 */
4 
11 #ifndef ISCT_ConditionsParameterTool_h
12 #define ISCT_ConditionsParameterTool_h
13 
14 //Athena includes
17 
18 //Gaudi Includes
19 #include "GaudiKernel/EventContext.h"
20 #include "GaudiKernel/IAlgTool.h"
21 
22 //STL includes
23 #include <vector>
24 
29 class ISCT_ConditionsParameterTool: virtual public IAlgTool {
30  public:
31  virtual ~ISCT_ConditionsParameterTool() = default;
32 
35 
37  virtual bool available(const SCT_CondParameterData::ParameterIndex iparam, const EventContext& ctx) const =0;
38  virtual bool available(const SCT_CondParameterData::ParameterIndex iparam) const =0;
39 
41  virtual float value(const IdentifierHash& idHash, const SCT_CondParameterData::ParameterIndex iparam, const EventContext& ctx) const =0;
42  virtual float value(const IdentifierHash& idHash, const SCT_CondParameterData::ParameterIndex iparam) const =0;
43 
45  virtual float validity(const IdentifierHash& idHash, const SCT_CondParameterData::ParameterIndex iparam, const EventContext& ctx) const =0;
46  virtual float validity(const IdentifierHash& idHash, const SCT_CondParameterData::ParameterIndex iparam) const =0;
47 
49  virtual bool isValid(const float parameterValue, const SCT_CondParameterData::ParameterIndex iparam, const EventContext& ctx) const =0;
50  virtual bool isValid(const float parameterValue, const SCT_CondParameterData::ParameterIndex iparam) const =0;
51 
53  virtual float invalid(const unsigned int iparam, const EventContext& ctx) const =0;
54  virtual float invalid(const unsigned int iparam) const =0;
55 
57  virtual float max(const SCT_CondParameterData::ParameterIndex iparam, const EventContext& ctx) const =0;
58  virtual float max(const SCT_CondParameterData::ParameterIndex iparam) const =0;
59 
61  virtual float min(const SCT_CondParameterData::ParameterIndex iparam, const EventContext& ctx) const =0;
62  virtual float min(const SCT_CondParameterData::ParameterIndex iparam) const =0;
63 
65  virtual float avg(const SCT_CondParameterData::ParameterIndex iparam, const EventContext& ctx) const =0;
66  virtual float avg(const SCT_CondParameterData::ParameterIndex iparam) const =0;
67 
69  virtual float sd(const SCT_CondParameterData::ParameterIndex iparam, const EventContext& ctx) const =0;
70  virtual float sd(const SCT_CondParameterData::ParameterIndex iparam) const =0;
71 
73  virtual unsigned int n(const SCT_CondParameterData::ParameterIndex iparam, const EventContext& ctx) const =0;
74  virtual unsigned int n(const SCT_CondParameterData::ParameterIndex iparam) const =0;
75 
77  virtual void getValues(std::vector<float>& userVector, const SCT_CondParameterData::ParameterIndex iparam, const EventContext& ctx) const =0;
78  virtual void getValues(std::vector<float>& userVector, const SCT_CondParameterData::ParameterIndex iparam) const =0;
79 
81  virtual bool filled(const EventContext& ctx) const =0;
82  virtual bool filled() const =0;
83 };
84 
85 #endif // ISCT_ConditionsParameterTool_h
ISCT_ConditionsParameterTool::getValues
virtual void getValues(std::vector< float > &userVector, const SCT_CondParameterData::ParameterIndex iparam) const =0
ISCT_ConditionsParameterTool::max
virtual float max(const SCT_CondParameterData::ParameterIndex iparam) const =0
ISCT_ConditionsParameterTool::value
virtual float value(const IdentifierHash &idHash, const SCT_CondParameterData::ParameterIndex iparam, const EventContext &ctx) const =0
Give the indicated value for a module identifier hash.
ISCT_ConditionsParameterTool::sd
virtual float sd(const SCT_CondParameterData::ParameterIndex iparam) const =0
SCT_CondParameterData::ParameterIndex
ParameterIndex
Parameters.
Definition: SCT_CondParameterData.h:35
ISCT_ConditionsParameterTool::~ISCT_ConditionsParameterTool
virtual ~ISCT_ConditionsParameterTool()=default
ISCT_ConditionsParameterTool::available
virtual bool available(const SCT_CondParameterData::ParameterIndex iparam, const EventContext &ctx) const =0
Is the required parameter available?
ISCT_ConditionsParameterTool::sd
virtual float sd(const SCT_CondParameterData::ParameterIndex iparam, const EventContext &ctx) const =0
Standard deviation.
ISCT_ConditionsParameterTool::value
virtual float value(const IdentifierHash &idHash, const SCT_CondParameterData::ParameterIndex iparam) const =0
ISCT_ConditionsParameterTool::invalid
virtual float invalid(const unsigned int iparam) const =0
SCT_CondParameterData.h
header file for data object for SCT_ConditionsParameterTool and SCT_ConditionsParameterCondAlg.
ISCT_ConditionsParameterTool::filled
virtual bool filled(const EventContext &ctx) const =0
Report whether the structure was filled.
ISCT_ConditionsParameterTool::invalid
virtual float invalid(const unsigned int iparam, const EventContext &ctx) const =0
What is the default error value for this parameter?
ISCT_ConditionsParameterTool::isValid
virtual bool isValid(const float parameterValue, const SCT_CondParameterData::ParameterIndex iparam, const EventContext &ctx) const =0
Is a given value within acceptable limits?
ISCT_ConditionsParameterTool::avg
virtual float avg(const SCT_CondParameterData::ParameterIndex iparam) const =0
ISCT_ConditionsParameterTool::filled
virtual bool filled() const =0
ISCT_ConditionsParameterTool
Definition: ISCT_ConditionsParameterTool.h:29
ISCT_ConditionsParameterTool::n
virtual unsigned int n(const SCT_CondParameterData::ParameterIndex iparam, const EventContext &ctx) const =0
Number of values read in.
IdentifierHash.h
ISCT_ConditionsParameterTool::validity
virtual float validity(const IdentifierHash &idHash, const SCT_CondParameterData::ParameterIndex iparam) const =0
ISCT_ConditionsParameterTool::DeclareInterfaceID
DeclareInterfaceID(ISCT_ConditionsParameterTool, 1, 0)
Creates the InterfaceID and interfaceID() method.
ISCT_ConditionsParameterTool::getValues
virtual void getValues(std::vector< float > &userVector, const SCT_CondParameterData::ParameterIndex iparam, const EventContext &ctx) const =0
Fill a user-provided vector with the values (hopefully won't be needed?)
ISCT_ConditionsParameterTool::n
virtual unsigned int n(const SCT_CondParameterData::ParameterIndex iparam) const =0
ISCT_ConditionsParameterTool::validity
virtual float validity(const IdentifierHash &idHash, const SCT_CondParameterData::ParameterIndex iparam, const EventContext &ctx) const =0
Measure of how many valid values went to calculate it. Should be 1 but if, say, 3 chip values were va...
ISCT_ConditionsParameterTool::max
virtual float max(const SCT_CondParameterData::ParameterIndex iparam, const EventContext &ctx) const =0
Maximum value read in from the database.
IdentifierHash
Definition: IdentifierHash.h:38
ISCT_ConditionsParameterTool::available
virtual bool available(const SCT_CondParameterData::ParameterIndex iparam) const =0
ISCT_ConditionsParameterTool::isValid
virtual bool isValid(const float parameterValue, const SCT_CondParameterData::ParameterIndex iparam) const =0
ISCT_ConditionsParameterTool::min
virtual float min(const SCT_CondParameterData::ParameterIndex iparam, const EventContext &ctx) const =0
Minimum value read in from the database.
ISCT_ConditionsParameterTool::avg
virtual float avg(const SCT_CondParameterData::ParameterIndex iparam, const EventContext &ctx) const =0
Average value.
ISCT_ConditionsParameterTool::min
virtual float min(const SCT_CondParameterData::ParameterIndex iparam) const =0