ATLAS Offline Software
Loading...
Searching...
No Matches
SCT_SiliconHVCondAlg Class Reference

#include <SCT_SiliconHVCondAlg.h>

Inheritance diagram for SCT_SiliconHVCondAlg:
Collaboration diagram for SCT_SiliconHVCondAlg:

Public Member Functions

 SCT_SiliconHVCondAlg (const std::string &name, ISvcLocator *pSvcLocator)
virtual ~SCT_SiliconHVCondAlg ()=default
virtual StatusCode initialize () override final
virtual StatusCode execute (const EventContext &ctx) const override final
virtual StatusCode finalize () override final
virtual bool isReEntrant () const override final
virtual StatusCode sysInitialize () override
 Override sysInitialize.
virtual bool isClonable () const override
 Specify if the algorithm is clonable.
virtual unsigned int cardinality () const override
 Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.
virtual StatusCode sysExecute (const EventContext &ctx) override
 Execute an algorithm.
virtual const DataObjIDColl & extraOutputDeps () const override
 Return the list of extra output dependencies.
virtual bool filterPassed (const EventContext &ctx) const
virtual void setFilterPassed (bool state, const EventContext &ctx) const
ServiceHandle< StoreGateSvc > & evtStore ()
 The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > & detStore () const
 The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode sysStart () override
 Handle START transition.
virtual std::vector< Gaudi::DataHandle * > inputHandles () const override
 Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * > outputHandles () const override
 Return this algorithm's output handles.
Gaudi::Details::PropertyBase & declareProperty (Gaudi::Property< T, V, H > &t)
void updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream & msg () const
bool msgLvl (const MSG::Level lvl) const

Protected Member Functions

void renounceArray (SG::VarHandleKeyArray &handlesArray)
 remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > renounce (T &h)
void extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
 Add StoreName to extra input/output deps as needed.

Private Types

typedef ServiceHandle< StoreGateSvcStoreGateSvc_t

Private Member Functions

Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
 specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes

BooleanProperty m_useState {this, "UseState", true, "Flag to use state conditions folder"}
SG::ReadCondHandleKey< SCT_DCSStatCondDatam_readKeyState {this, "ReadKeyState", "SCT_DCSStatCondData", "Key of input state conditions data"}
SG::ReadCondHandleKey< SCT_DCSFloatCondDatam_readKeyHV {this, "ReadKeyHV", "SCT_DCSHVCondData", "Key of input HV conditions data"}
SG::WriteCondHandleKey< SCT_DCSFloatCondDatam_writeKey {this, "WriteKey", "SCT_SiliconBiasVoltCondData", "Key of output bias voltage conditions data"}
ToolHandle< ISCT_DCSConditionsToolm_sctDCSTool {this, "DCSConditionsTool", "InDetSCT_DCSConditionsTool", "Tool to retrieve SCT DCS information"}
const SCT_IDm_pHelper {nullptr}
 ID helper for SCT.
DataObjIDColl m_extendedExtraObjects
 Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
StoreGateSvc_t m_evtStore
 Pointer to StoreGate (event store by default)
StoreGateSvc_t m_detStore
 Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * > m_vhka
bool m_varHandleArraysDeclared

Detailed Description

Definition at line 18 of file SCT_SiliconHVCondAlg.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t
privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ SCT_SiliconHVCondAlg()

SCT_SiliconHVCondAlg::SCT_SiliconHVCondAlg ( const std::string & name,
ISvcLocator * pSvcLocator )

Definition at line 12 of file SCT_SiliconHVCondAlg.cxx.

13 : ::AthReentrantAlgorithm(name, pSvcLocator)
14{
15}

◆ ~SCT_SiliconHVCondAlg()

virtual SCT_SiliconHVCondAlg::~SCT_SiliconHVCondAlg ( )
virtualdefault

Member Function Documentation

◆ cardinality()

unsigned int AthCommonReentrantAlgorithm< Gaudi::Algorithm >::cardinality ( ) const
overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Definition at line 75 of file AthCommonReentrantAlgorithm.cxx.

64{
65 return 0;
66}

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl,
const SG::VarHandleKeyType &  )
inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

158 {
160 hndl.value(),
161 hndl.documentation());
162
163 }
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T, V, H > &t)

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t)
inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

145 {
146 typedef typename SG::HandleClassifier<T>::type htype;
148 }
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::detStore ( ) const
inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( )
inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

◆ execute()

StatusCode SCT_SiliconHVCondAlg::execute ( const EventContext & ctx) const
finaloverridevirtual

Definition at line 34 of file SCT_SiliconHVCondAlg.cxx.

34 {
35 ATH_MSG_DEBUG("execute " << name());
36
37 // Write Cond Handle
38 SG::WriteCondHandle<SCT_DCSFloatCondData> writeHandle{m_writeKey, ctx};
39 // Do we have a valid Write Cond Handle for current time?
40 if (writeHandle.isValid()) {
41 ATH_MSG_DEBUG("CondHandle " << writeHandle.fullKey() << " is already valid."
42 << " In theory this should not be called, but may happen"
43 << " if multiple concurrent events are being processed out of order.");
44 return StatusCode::SUCCESS;
45 }
46
47 // Read Cond Handle (HV)
48 SG::ReadCondHandle<SCT_DCSFloatCondData> readHandleHV{m_readKeyHV, ctx};
49 const SCT_DCSFloatCondData* readCdoHV{*readHandleHV};
50 if (readCdoHV==nullptr) {
51 ATH_MSG_FATAL("Null pointer to the read conditions object");
52 return StatusCode::FAILURE;
53 }
54 writeHandle.addDependency(readHandleHV);
55 ATH_MSG_INFO("Input is " << readHandleHV.fullKey() << " with the range of " << readHandleHV.getRange());
56
57 if (m_useState) {
58 // Read Cond Handle (state)
59 SG::ReadCondHandle<SCT_DCSStatCondData> readHandleState{m_readKeyState, ctx};
60 const SCT_DCSStatCondData* readCdoState{*readHandleState};
61 if (readCdoState==nullptr) {
62 ATH_MSG_FATAL("Null pointer to the read conditions object");
63 return StatusCode::FAILURE;
64 }
65 writeHandle.addDependency(readHandleState);
66 ATH_MSG_INFO("Input is " << readHandleState.fullKey() << " with the range of " << readHandleState.getRange());
67 }
68
69 // Construct the output Cond Object and fill it in
70 std::unique_ptr<SCT_DCSFloatCondData> writeCdo{std::make_unique<SCT_DCSFloatCondData>()};
71 const SCT_ID::size_type wafer_hash_max{m_pHelper->wafer_hash_max()};
72 for (SCT_ID::size_type hash{0}; hash<wafer_hash_max; hash++) {
73 writeCdo->setValue(hash, m_sctDCSTool->modHV(IdentifierHash(hash), ctx));
74 }
75
76 // Record the output cond object
77 if (writeHandle.record(std::move(writeCdo)).isFailure()) {
78 ATH_MSG_FATAL("Could not record SCT_DCSFloatCondData " << writeHandle.key()
79 << " with EventRange " << writeHandle.getRange()
80 << " into Conditions Store");
81 return StatusCode::FAILURE;
82 }
83 ATH_MSG_INFO("recorded new CDO " << writeHandle.key() << " with range " << writeHandle.getRange() << " into Conditions Store");
84
85 return StatusCode::SUCCESS;
86}
#define ATH_MSG_FATAL(x)
#define ATH_MSG_INFO(x)
#define ATH_MSG_DEBUG(x)
Identifier::size_type size_type
Definition SCT_ID.h:72
SG::ReadCondHandleKey< SCT_DCSStatCondData > m_readKeyState
ToolHandle< ISCT_DCSConditionsTool > m_sctDCSTool
const SCT_ID * m_pHelper
ID helper for SCT.
SG::WriteCondHandleKey< SCT_DCSFloatCondData > m_writeKey
SG::ReadCondHandleKey< SCT_DCSFloatCondData > m_readKeyHV
const DataObjID & fullKey() const
const EventIDRange & getRange()
const std::string & key() const
void addDependency(const EventIDRange &range)
const EventIDRange & getRange() const
StatusCode record(const EventIDRange &range, T *t)
record handle, with explicit range DEPRECATED
const DataObjID & fullKey() const

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps)
protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ extraOutputDeps()

const DataObjIDColl & AthCommonReentrantAlgorithm< Gaudi::Algorithm >::extraOutputDeps ( ) const
overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 94 of file AthCommonReentrantAlgorithm.cxx.

90{
91 // If we didn't find any symlinks to add, just return the collection
92 // from the base class. Otherwise, return the extended collection.
93 if (!m_extendedExtraObjects.empty()) {
95 }
97}
An algorithm that can be simultaneously executed in multiple threads.

◆ filterPassed()

virtual bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx) const
inlinevirtualinherited

Definition at line 96 of file AthCommonReentrantAlgorithm.h.

96 {
97 return execState( ctx ).filterPassed();
98 }
virtual bool filterPassed(const EventContext &ctx) const

◆ finalize()

StatusCode SCT_SiliconHVCondAlg::finalize ( )
finaloverridevirtual

Definition at line 88 of file SCT_SiliconHVCondAlg.cxx.

89{
90 ATH_MSG_DEBUG("finalize " << name());
91 return StatusCode::SUCCESS;
92}

◆ initialize()

StatusCode SCT_SiliconHVCondAlg::initialize ( )
finaloverridevirtual

Definition at line 17 of file SCT_SiliconHVCondAlg.cxx.

17 {
18 ATH_MSG_DEBUG("initialize " << name());
19
20 // SCT DCS tool
21 ATH_CHECK(m_sctDCSTool.retrieve());
22 // SCT ID helper
23 ATH_CHECK(detStore()->retrieve(m_pHelper, "SCT_ID"));
24
25 // Read Cond Handles
27 ATH_CHECK(m_readKeyHV.initialize());
28 // Write Cond Handle
29 ATH_CHECK(m_writeKey.initialize());
30
31 return StatusCode::SUCCESS;
32}
#define ATH_CHECK
Evaluate an expression and check for errors.
const ServiceHandle< StoreGateSvc > & detStore() const
retrieve(aClass, aKey=None)
Definition PyKernel.py:110

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::inputHandles ( ) const
overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ isClonable()

◆ isReEntrant()

virtual bool SCT_SiliconHVCondAlg::isReEntrant ( ) const
inlinefinaloverridevirtual

Definition at line 26 of file SCT_SiliconHVCondAlg.h.

26{ return false; }

◆ msg()

MsgStream & AthCommonMsg< Gaudi::Algorithm >::msg ( ) const
inlineinherited

Definition at line 24 of file AthCommonMsg.h.

24 {
25 return this->msgStream();
26 }

◆ msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::msgLvl ( const MSG::Level lvl) const
inlineinherited

Definition at line 30 of file AthCommonMsg.h.

30 {
31 return this->msgLevel(lvl);
32 }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::outputHandles ( ) const
overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounce ( T & h)
inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

381 {
382 h.renounce();
384 }
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > renounce(T &h)

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray)
inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

364 {
366 }

◆ setFilterPassed()

virtual void AthCommonReentrantAlgorithm< Gaudi::Algorithm >::setFilterPassed ( bool state,
const EventContext & ctx ) const
inlinevirtualinherited

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

100 {
102 }
virtual void setFilterPassed(bool state, const EventContext &ctx) const

◆ sysExecute()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext & ctx)
overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Definition at line 85 of file AthCommonReentrantAlgorithm.cxx.

77{
78 return BaseAlg::sysExecute (ctx);
79}

◆ sysInitialize()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysInitialize ( )
overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >.

Reimplemented in HypoBase, and InputMakerBase.

Definition at line 61 of file AthCommonReentrantAlgorithm.cxx.

107 {
109
110 if (sc.isFailure()) {
111 return sc;
112 }
113
114 ServiceHandle<ICondSvc> cs("CondSvc",name());
115 for (auto h : outputHandles()) {
116 if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
117 // do this inside the loop so we don't create the CondSvc until needed
118 if ( cs.retrieve().isFailure() ) {
119 ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
120 return StatusCode::SUCCESS;
121 }
122 if (cs->regHandle(this,*h).isFailure()) {
124 ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
125 << " with CondSvc");
126 }
127 }
128 }
129 return sc;
130}
#define ATH_MSG_ERROR(x)
#define ATH_MSG_WARNING(x)
virtual std::vector< Gaudi::DataHandle * > outputHandles() const override

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::sysStart ( )
overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )
inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

308 {
309 // debug() << "updateVHKA for property " << p.name() << " " << p.toString()
310 // << " size: " << m_vhka.size() << endmsg;
311 for (auto &a : m_vhka) {
313 for (auto k : keys) {
314 k->setOwner(this);
315 }
316 }
317 }

Member Data Documentation

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore
privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore
privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthCommonReentrantAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects
privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 114 of file AthCommonReentrantAlgorithm.h.

◆ m_pHelper

const SCT_ID* SCT_SiliconHVCondAlg::m_pHelper {nullptr}
private

ID helper for SCT.

Definition at line 34 of file SCT_SiliconHVCondAlg.h.

34{nullptr};

◆ m_readKeyHV

SG::ReadCondHandleKey<SCT_DCSFloatCondData> SCT_SiliconHVCondAlg::m_readKeyHV {this, "ReadKeyHV", "SCT_DCSHVCondData", "Key of input HV conditions data"}
private

Definition at line 31 of file SCT_SiliconHVCondAlg.h.

31{this, "ReadKeyHV", "SCT_DCSHVCondData", "Key of input HV conditions data"};

◆ m_readKeyState

SG::ReadCondHandleKey<SCT_DCSStatCondData> SCT_SiliconHVCondAlg::m_readKeyState {this, "ReadKeyState", "SCT_DCSStatCondData", "Key of input state conditions data"}
private

Definition at line 30 of file SCT_SiliconHVCondAlg.h.

30{this, "ReadKeyState", "SCT_DCSStatCondData", "Key of input state conditions data"};

◆ m_sctDCSTool

ToolHandle<ISCT_DCSConditionsTool> SCT_SiliconHVCondAlg::m_sctDCSTool {this, "DCSConditionsTool", "InDetSCT_DCSConditionsTool", "Tool to retrieve SCT DCS information"}
private

Definition at line 33 of file SCT_SiliconHVCondAlg.h.

33{this, "DCSConditionsTool", "InDetSCT_DCSConditionsTool", "Tool to retrieve SCT DCS information"};

◆ m_useState

BooleanProperty SCT_SiliconHVCondAlg::m_useState {this, "UseState", true, "Flag to use state conditions folder"}
private

Definition at line 29 of file SCT_SiliconHVCondAlg.h.

29{this, "UseState", true, "Flag to use state conditions folder"};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared
privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka
privateinherited

Definition at line 398 of file AthCommonDataStore.h.

◆ m_writeKey

SG::WriteCondHandleKey<SCT_DCSFloatCondData> SCT_SiliconHVCondAlg::m_writeKey {this, "WriteKey", "SCT_SiliconBiasVoltCondData", "Key of output bias voltage conditions data"}
private

Definition at line 32 of file SCT_SiliconHVCondAlg.h.

32{this, "WriteKey", "SCT_SiliconBiasVoltCondData", "Key of output bias voltage conditions data"};

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