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

MuonNSW_CablingAlg reads raw condition data and writes derived condition data to the condition store. More...

#include <MuonNSW_CablingAlg.h>

Inheritance diagram for MuonNSW_CablingAlg:
Collaboration diagram for MuonNSW_CablingAlg:

Public Member Functions

 MuonNSW_CablingAlg (const std::string &name, ISvcLocator *pSvcLocator)
virtual ~MuonNSW_CablingAlg ()=default
virtual StatusCode initialize () override
virtual StatusCode execute (const EventContext &ctx) const override
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

StatusCode loadCablingSchema (const std::string &payload, Nsw_CablingMap &cabling_map) const
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
 specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes

ServiceHandle< Muon::IMuonIdHelperSvcm_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}
SG::ReadCondHandleKeyArray< CondAttrListCollectionm_readCablingKeys
SG::WriteCondHandleKey< Nsw_CablingMapm_writeKey {this, "WriteKey", "NswCabling", "Key of output NSW cabling map"}
Gaudi::Property< std::string > m_JSONFile {this, "JSONFile", "", "External path to read the cabling from"}
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

MuonNSW_CablingAlg reads raw condition data and writes derived condition data to the condition store.

Definition at line 22 of file MuonNSW_CablingAlg.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

◆ MuonNSW_CablingAlg()

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

Definition at line 23 of file MuonNSW_CablingAlg.cxx.

25 : AthReentrantAlgorithm(name, pSvcLocator) {}

◆ ~MuonNSW_CablingAlg()

virtual MuonNSW_CablingAlg::~MuonNSW_CablingAlg ( )
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 MuonNSW_CablingAlg::execute ( const EventContext & ctx) const
overridevirtual

JSON file

Conditions DB

Definition at line 35 of file MuonNSW_CablingAlg.cxx.

35 {
36 ATH_MSG_DEBUG("Load the Micro mega cabling map");
37 // Write Cond Handle
38 SG::WriteCondHandle<Nsw_CablingMap> writeHandle{m_writeKey, ctx};
39 if (writeHandle.isValid()) {
40 ATH_MSG_DEBUG("CondHandle "<< writeHandle.fullKey() << " is already valid."
41 << ". In theory this should not be called, but may happen"
42 << " if multiple concurrent events are being processed out of order.");
43 return StatusCode::SUCCESS;
44 }
45 writeHandle.addDependency(EventIDRange(IOVInfiniteRange::infiniteRunLB()));
46
47 std::unique_ptr<Nsw_CablingMap> writeCdo{std::make_unique<Nsw_CablingMap>(m_idHelperSvc.get())};
48
50 if (!m_JSONFile.value().empty()) {
51 std::ifstream inf{m_JSONFile};
52 if (!inf.good()) {
53 ATH_MSG_FATAL("Cannot locate external JSON file " << m_JSONFile);
54 return StatusCode::FAILURE;
55 }
56 std::string payload{};
57 while (std::getline(inf, payload)) {
58 ATH_CHECK(loadCablingSchema(payload, *writeCdo));
59 }
60 }
61
63 else if (!m_readCablingKeys.empty()) {
64 for (const SG::ReadCondHandleKey<CondAttrListCollection>& key : m_readCablingKeys){
65 SG::ReadCondHandle<CondAttrListCollection> readHandle{key, ctx};
66 if (!readHandle.isValid()) {
67 ATH_MSG_FATAL("Failed to retrieve the cabling data from the database "
68 << key.fullKey());
69 return StatusCode::FAILURE;
70 }
71
72 writeHandle.addDependency(readHandle);
73 ATH_MSG_DEBUG("Size of CondAttrListCollection " << readHandle.fullKey()
74 << " readCdo->size()= " << readHandle->size());
75 ATH_MSG_DEBUG("Range of input is " << readHandle.getRange()
76 << ", range of output is " << writeHandle.getRange());
77
78 // iterate through data
80 for(itr = readHandle->begin(); itr != readHandle->end(); ++itr) {
81 const coral::AttributeList& atr = itr->second;
82 std::string payload = *(static_cast<const std::string *>((atr["data"]).addressOfData()));
83 ATH_CHECK(loadCablingSchema(payload, *writeCdo));
84 }
85 }
86 }
87
88 ATH_CHECK(writeHandle.record(std::move(writeCdo)));
89 ATH_MSG_INFO("recorded new " << writeHandle.key() << " with range "
90 << writeHandle.getRange()
91 << " into Conditions Store");
92 return StatusCode::SUCCESS;
93}
#define ATH_CHECK
Evaluate an expression and check for errors.
#define ATH_MSG_FATAL(x)
#define ATH_MSG_INFO(x)
#define ATH_MSG_DEBUG(x)
ChanAttrListMap::const_iterator const_iterator
static EventIDRange infiniteRunLB()
Produces an EventIDRange that is infinite in RunLumi and invalid in Time.
ServiceHandle< Muon::IMuonIdHelperSvc > m_idHelperSvc
Gaudi::Property< std::string > m_JSONFile
StatusCode loadCablingSchema(const std::string &payload, Nsw_CablingMap &cabling_map) const
SG::ReadCondHandleKeyArray< CondAttrListCollection > m_readCablingKeys
SG::WriteCondHandleKey< Nsw_CablingMap > m_writeKey
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
TStreamerInfo * inf

◆ 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

◆ initialize()

StatusCode MuonNSW_CablingAlg::initialize ( )
overridevirtual

Definition at line 27 of file MuonNSW_CablingAlg.cxx.

27 {
28 ATH_MSG_DEBUG("initialize " << name());
29 ATH_CHECK(m_readCablingKeys.initialize(m_JSONFile.value().empty()));
30 ATH_CHECK(m_writeKey.initialize());
31 ATH_CHECK(m_idHelperSvc.retrieve());
32 return StatusCode::SUCCESS;
33}

◆ 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 MuonNSW_CablingAlg::isReEntrant ( ) const
inlinefinaloverridevirtual

Definition at line 29 of file MuonNSW_CablingAlg.h.

29{ return false; }

◆ loadCablingSchema()

StatusCode MuonNSW_CablingAlg::loadCablingSchema ( const std::string & payload,
Nsw_CablingMap & cabling_map ) const
private

Definition at line 95 of file MuonNSW_CablingAlg.cxx.

96 {
97
98 if (theJSON.empty())
99 return StatusCode::SUCCESS;
100 nlohmann::json payload = nlohmann::json::parse(theJSON);
101 const MmIdHelper& mm_helper{m_idHelperSvc->mmIdHelper()};
102 const sTgcIdHelper& sTgc_helper{m_idHelperSvc->stgcIdHelper()};
103 for (const auto& db_channel : payload.items()) {
104 nlohmann::json cabling_payload = db_channel.value();
105
106 std::string stName = cabling_payload["station"];
107 const int eta = cabling_payload["eta"];
108 const int phi = cabling_payload["phi"];
109 const int multilayer = cabling_payload["multilayer"];
110 const int gap = cabling_payload["gasgap"];
111 bool isValid{false};
112 Identifier gap_id{};
113 if (stName[0] == 'M') {
114 gap_id = mm_helper.channelID(stName, eta, phi, multilayer, gap, 1, isValid);
115 } else {
116 const int chType{cabling_payload["channeltype"]};
117 gap_id = sTgc_helper.channelID(stName, eta, phi, multilayer,gap, chType, 1, isValid);
118 }
119 if (!isValid) {
120 ATH_MSG_FATAL("Failed to deduce a valid identifier from st:"
121 << stName << " eta: " << eta << " phi: " << phi
122 << " multilayer: " << multilayer
123 << " gasgap: " << gap);
124 return StatusCode::FAILURE;
125 }
126
127 NswZebraData zebra_connector{};
128 zebra_connector.firstChannel = cabling_payload["FirstZebra"];
129 zebra_connector.lastChannel = cabling_payload["LastZebra"];
130 zebra_connector.shiftChannel = cabling_payload["ZebraShift"];
131 if (!cabling_map.addConnector(gap_id, zebra_connector, msgStream()))
132 return StatusCode::FAILURE;
133 }
134 return StatusCode::SUCCESS;
135}
Scalar eta() const
pseudorapidity method
Scalar phi() const
phi method
bool isValid(const T &p)
Av: we implement here an ATLAS-sepcific convention: all particles which are 99xxxxx are fine.
Definition AtlasPID.h:878
Identifier channelID(int stationName, int stationEta, int stationPhi, int multilayer, int gasGap, int channel) const
bool addConnector(const Identifier &gapID, const NswZebraData &connector, MsgStream &msg)
Identifier channelID(int stationName, int stationEta, int stationPhi, int multilayer, int gasGap, int channelType, int channel) const
gap(flags, cells_name, *args, **kw)
const std::string & stName(StIndex index)
convert StIndex into a string
int16_t lastChannel
int16_t firstChannel
int16_t shiftChannel

◆ 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_idHelperSvc

ServiceHandle<Muon::IMuonIdHelperSvc> MuonNSW_CablingAlg::m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}
private

Definition at line 32 of file MuonNSW_CablingAlg.h.

32{this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"};

◆ m_JSONFile

Gaudi::Property<std::string> MuonNSW_CablingAlg::m_JSONFile {this, "JSONFile", "", "External path to read the cabling from"}
private

Definition at line 37 of file MuonNSW_CablingAlg.h.

37{this, "JSONFile", "", "External path to read the cabling from"};

◆ m_readCablingKeys

SG::ReadCondHandleKeyArray<CondAttrListCollection> MuonNSW_CablingAlg::m_readCablingKeys
private
Initial value:
{this, "CablingFolder", { "/MDT/MM/CABLING"},
"Keys of the input conditions folder for MM & sTGC cabling map"}

Definition at line 33 of file MuonNSW_CablingAlg.h.

33 {this, "CablingFolder", { "/MDT/MM/CABLING"},
34 "Keys of the input conditions folder for MM & sTGC cabling map"};

◆ 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<Nsw_CablingMap> MuonNSW_CablingAlg::m_writeKey {this, "WriteKey", "NswCabling", "Key of output NSW cabling map"}
private

Definition at line 35 of file MuonNSW_CablingAlg.h.

35{this, "WriteKey", "NswCabling", "Key of output NSW cabling map"};

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