MdtCablingJsonDumpAlg Class Reference

#include <MdtCablingJsonDumpAlg.h>

Inheritance diagram for MdtCablingJsonDumpAlg:

Collaboration diagram for MdtCablingJsonDumpAlg:

Public Types
using	CablingData = MuonMDT_CablingMap::CablingData

Public Member Functions
	MdtCablingJsonDumpAlg (const std::string &name, ISvcLocator *pSvcLocator)
virtual	~MdtCablingJsonDumpAlg ()=default
virtual StatusCode	initialize () override
virtual StatusCode	execute () override
virtual unsigned int	cardinality () const override final
virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. More...
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
virtual StatusCode	sysStart () override
	Handle START transition. More...
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
MsgStream &	msg (const MSG::Level lvl) const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...
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. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
ServiceHandle< Muon::IMuonIdHelperSvc >	m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}
SG::ReadCondHandleKey< MuonGM::MuonDetectorManager >	m_DetectorManagerKey
SG::ReadCondHandleKey< MuonMDT_CablingMap >	m_cablingKey {this, "ReadKey", "MuonMDT_CablingMap", "Key of input MDT cabling map"}
Gaudi::Property< std::string >	m_summaryTxt {this, "SummaryFile", "SummaryFile.txt", "Summary of the extracted mapping"}
Gaudi::Property< std::string >	m_mezzJSON {this, "OutMezzanineJSON", "MezzMapping.json", "Mezzanine JSON"}
Gaudi::Property< std::string >	m_cablingJSON {this, "OutCablingJSON", "MdtCabling.json", "Cabling JSON"}
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 21 of file MdtCablingJsonDumpAlg.h.

Member Typedef Documentation

CablingData

using MdtCablingJsonDumpAlg::CablingData = MuonMDT_CablingMap::CablingData

Definition at line 29 of file MdtCablingJsonDumpAlg.h.

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

MdtCablingJsonDumpAlg()

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

Definition at line 32 of file MdtCablingJsonDumpAlg.cxx.

                                                                                           :
    AthAlgorithm(name,pSvcLocator) {}

~MdtCablingJsonDumpAlg()

virtual MdtCablingJsonDumpAlg::~MdtCablingJsonDumpAlg ( )

virtualdefault

Member Function Documentation

cardinality()

virtual unsigned int MdtCablingJsonDumpAlg::cardinality ( ) const

inlinefinaloverridevirtual

Definition at line 27 of file MdtCablingJsonDumpAlg.h.

{return 1;}

declareGaudiProperty() [1/4]

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

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< 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.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareGaudiProperty() [3/4]

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

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
  }

declareGaudiProperty() [4/4]

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

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(t);
  }

declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( const std::string &  name, SG::VarHandleBase &  hndl, const std::string &  doc, const SG::VarHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

  {
    this->declare(hndl.vhKey());
    hndl.vhKey().setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( const std::string &  name, SG::VarHandleKey &  hndl, const std::string &  doc, const SG::VarHandleKeyType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

  {
    this->declare(hndl);
    hndl.setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( const std::string &  name, SG::VarHandleKeyArray &  hndArr, const std::string &  doc, const SG::VarHandleKeyArrayType &    )

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

  {
 
    // std::ostringstream ost;
    // ost << Algorithm::name() << " VHKA declareProp: " << name 
    //     << " size: " << hndArr.keys().size() 
    //     << " mode: " << hndArr.mode() 
    //     << "  vhka size: " << m_vhka.size()
    //     << "\n";
    // debug() << ost.str() << endmsg;
 
    hndArr.setOwner(this);
    m_vhka.push_back(&hndArr);
 
    Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
    if (p != 0) {
      p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
    } else {
      ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                    << name);
    }
 
    return p;
 
  }

declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc, const SG::NotHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(name, property, doc);
  }

declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc = "none"  )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

  {
    typedef typename SG::HandleClassifier<T>::type htype;
    return declareProperty (name, property, doc, htype());
  }

declareProperty() [6/6]

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

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

inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore() [1/2]

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

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

evtStore() [2/2]

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

inlineinherited

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

Definition at line 90 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode MdtCablingJsonDumpAlg::execute ( )

overridevirtual

Struct to perform the mapping between online offline tube

Create the cabling object

Test if the online channel can be found

Next step is to filter all the mezzanine cards

Assign MROD / SubDet / CSM

Offline Identifier (stationIdx, eta,phi, ml)

Tube zero

The staggering of the hedgehog cards does not coincide with the multi-layer staggering i.e. tubeZero is 2,3,4,5 or 2,3,4,5,6,7.

Check whether the same layout is already used somewhere

Summary file

Write mezzanine file

Definition at line 43 of file MdtCablingJsonDumpAlg.cxx.

                                          {
  const EventContext& ctx = Gaudi::Hive::currentContext();
  ATH_MSG_INFO("Dump cabling & mezzanines into JSON file");
 
  SG::ReadCondHandle<MuonGM::MuonDetectorManager> detectorMgr{m_DetectorManagerKey, ctx};
  if (!detectorMgr.isValid()){
      ATH_MSG_FATAL("Failed to retrieve the Detector manager "<<m_DetectorManagerKey.fullKey());
      return StatusCode::FAILURE;
  }
 
  SG::ReadCondHandle<MuonMDT_CablingMap> cabling{m_cablingKey,ctx};
  if (!cabling.isValid()) {
     ATH_MSG_ERROR("Failed to retrieve the Mdt cabling "<<m_cablingKey.fullKey());
     return StatusCode::FAILURE;
  }
  const MdtIdHelper& idHelper = m_idHelperSvc->mdtIdHelper();
 
  std::vector<MdtMezzanineCard> cached_cards{};
  std::set<MdtCablingData> cached_chnls{};
  constexpr auto unsetArray{make_array<uint8_t,24>(MdtMezzanineCard::NOTSET)};
  for (auto det_itr = idHelper.detectorElement_begin(); det_itr != idHelper.detectorElement_end(); ++det_itr){
    const MuonGM::MdtReadoutElement* readEle = detectorMgr->getMdtReadoutElement(*det_itr);
    if (!readEle) {
        ATH_MSG_DEBUG("Detector element does not exist. ");
        continue;
    }
    const Identifier station_id = idHelper.elementID(readEle->identify());
    ATH_MSG_DEBUG("Check station "<<m_idHelperSvc->toString(station_id));   
    MdtMezzanineCard dummy_card(Mapping{}, readEle->getNLayers(), -1);
    std::map<TdcIdentifier, Mapping> chamber_mezz{};
    const int nLayers{readEle->getNLayers()};
    const int nTubes{readEle->getNtubesperlayer()};
    const int multiLayer{readEle->getMultilayer()};
    for (int layer = 1 ; layer <= nLayers; ++layer){
      for (int tubeInLayer = 1 ; tubeInLayer <= nTubes; ++tubeInLayer) {
          bool is_valid{false};
          const Identifier tube_id = idHelper.channelID(station_id, multiLayer, 
                                                        layer, tubeInLayer, is_valid);
              if (!is_valid) {
                ATH_MSG_VERBOSE("Invalid element");
                continue;
              }
              MdtCablingData cabling_data{};
              cabling->convert(tube_id,cabling_data);
              if (!cabling->getOnlineId(cabling_data, msgStream())) {
                ATH_MSG_ERROR("Could no retrieve a valid online channel for "<<m_idHelperSvc->toString(tube_id));
                return StatusCode::FAILURE;
              }
              const TdcIdentifier tdc_id{cabling_data};
              chamber_mezz.try_emplace(tdc_id,unsetArray);
              chamber_mezz[tdc_id][cabling_data.channelId] = dummy_card.tubeNumber(layer, tubeInLayer);
         }
    }
    for (auto&[tdc, mezz_mapping] : chamber_mezz) {
        MdtCablingData mezzCablingId{};
        
        static_cast<MdtCablingOnData&>(mezzCablingId) = tdc;
        mezzCablingId.tdcId = tdc.tdcId;
        
        MdtTdcOnlSorter chipInCab =  cabling->getOnlineConvMap().at(tdc).all_modules.at(tdc.tdcId);
        static_cast<MdtCablingOffData&>(mezzCablingId) = chipInCab->offId();
        mezzCablingId.tube = chipInCab->tubeZero();
        
        const uint8_t tubeOffSet = (mezzCablingId.tube-1)%dummy_card.numTubesPerLayer();
        if (tubeOffSet) {
           MdtMezzanineCard remap{mezz_mapping, dummy_card.numTubeLayers(), 0};
           for (size_t chan = 0 ; chan < mezz_mapping.size(); ++chan) {           
              const OfflineCh tube_lay = remap.offlineTube(chan, msgStream());
              if (!tube_lay.isValid) continue;
              uint8_t tubeNumber = tube_lay.tube + tubeOffSet + 1;
              mezz_mapping[chan] = remap.tubeNumber(tube_lay.layer, tubeNumber);
           }
        }
        Mapping& mtmp = mezz_mapping; // Work around clang15 compilation error.
        std::vector<MdtMezzanineCard>::const_iterator itr = std::find_if(cached_cards.begin(), cached_cards.end(), 
            [&dummy_card, &mtmp](const MdtMezzanineCard& card ){
               if (dummy_card.numTubeLayers() != card.numTubeLayers()) return false;
               for (size_t ch =0; ch < mtmp.size(); ++ch) {
                  if (mtmp[ch] != card.tdcToTubeMap()[ch]) return false;
               }
              return true;
        });
        if (itr != cached_cards.end()) {
          mezzCablingId.mezzanine_type = itr->id();
        } else {
          cached_cards.emplace_back(mezz_mapping, dummy_card.numTubeLayers(), cached_cards.size() + 10);
          if (!cached_cards.back().checkConsistency(msgStream())) {
            ATH_MSG_ERROR("Wrong assignment for "<<mezzCablingId);
            return StatusCode::FAILURE;
          }
          mezzCablingId.mezzanine_type = cached_cards.back().id();
        }
        cached_chnls.insert(std::move(mezzCablingId));
    }
 
 
    
    }    
    {
        std::ofstream summary{m_summaryTxt};
        if (!summary.good()) {
          ATH_MSG_ERROR("Failed to write "<<m_summaryTxt);
          return StatusCode::FAILURE;
        }
        summary<<"Extracted "<<cached_cards.size()<<" mezzanine card layouts and "
              <<cached_chnls.size()<<" chamber channels. \n\n\n";
        for (const MdtMezzanineCard& card : cached_cards) {
          summary<<card;
          MdtCablingOffData chamb{};
          for (const MdtCablingData& cabling : cached_chnls) {
              if (cabling.mezzanine_type != card.id()) continue;
              if (chamb != cabling) {
                chamb = cabling;
                summary<<std::endl<<" *** "<<idHelper.stationNameString(chamb.stationIndex);             
                summary<<static_cast<int>(std::abs(chamb.eta));
                summary<<(chamb.eta > 0 ? "A" : "C");
                summary<<static_cast<int>(chamb.phi);
                summary<<"M"<<static_cast<int>(chamb.multilayer);
                summary<<" --- tdcs: ";
              }
              summary<<static_cast<int>(cabling.tdcId)<<", ";
          }
          summary<<"\n\n"
                  <<"##############################################################\n";
        }
    }
    {
      std::ofstream mezz_json{m_mezzJSON};
      if (!mezz_json.good()) {
          ATH_MSG_ERROR("Failed to write "<<m_summaryTxt);
          return StatusCode::FAILURE;
      }
      mezz_json<<"["<<std::endl;
      for (size_t i = 0; i < cached_cards.size() ; ++i) {
         const MdtMezzanineCard& card  = cached_cards[i];
         mezz_json<<"     {\n";
         mezz_json<<"       \"mezzId\": "<<static_cast<int>(card.id())<<",\n";
         mezz_json<<"       \"nTubeLayer\": "<<static_cast<int>(card.numTubeLayers())<<",\n";
         mezz_json<<"       \"tdcToTubeMap\": [";
         for (size_t ch = 0 ; ch < card.tdcToTubeMap().size(); ++ch) {
           mezz_json<<static_cast<int>(card.tdcToTubeMap()[ch]);
           if (ch + 1 != card.tdcToTubeMap().size())mezz_json<<",";
         }
         mezz_json<<"]\n";
         mezz_json<<"     }";
         if (i +1 != cached_cards.size()) mezz_json<<",";
         mezz_json<<"\n";
      }
      mezz_json<<"]";
    }
    {
      std::ofstream chamb_json{m_cablingJSON};
      if (!chamb_json.good()) {
         ATH_MSG_FATAL("Failed to write "<<m_cablingJSON);
         return StatusCode::FAILURE;
      }
      chamb_json<<"[\n";
      size_t i =0;
      for (const MdtCablingData& chamb : cached_chnls){ 
        chamb_json<<"    {\n";
        chamb_json<<"     \"station\": \""<<idHelper.stationNameString(chamb.stationIndex)<<"\",\n";
        chamb_json<<"     \"eta\": "<<static_cast<int>(chamb.eta)<<",\n";
        chamb_json<<"     \"phi\": "<<static_cast<int>(chamb.phi)<<",\n";
        chamb_json<<"     \"ml\": "<<static_cast<int>(chamb.multilayer)<<",\n";
        chamb_json<<"     \"subDet\": "<<static_cast<int>(chamb.subdetectorId)<<",\n";
        chamb_json<<"     \"csm\": "<<static_cast<int>(chamb.csm)<<",\n";
        chamb_json<<"     \"mrod\": "<<static_cast<int>(chamb.mrod)<<",\n";
        chamb_json<<"     \"tdcId\": "<<static_cast<int>(chamb.tdcId)<<",\n";
        chamb_json<<"     \"mezzId\": "<<static_cast<int>(chamb.mezzanine_type)<<",\n";
        chamb_json<<"     \"tubeZero\": "<<static_cast<int>(chamb.tube)<<"\n";
        chamb_json<<"    }";
        if (i +1 != cached_chnls.size()) chamb_json<<",";
        chamb_json<<"\n";
        ++i;
      }
      chamb_json<<"]"<<std::endl;
    }
 
    
  return StatusCode::SUCCESS;
} 

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< 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 & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

initialize()

StatusCode MdtCablingJsonDumpAlg::initialize ( )

overridevirtual

Definition at line 36 of file MdtCablingJsonDumpAlg.cxx.

                                            {
  ATH_CHECK(m_idHelperSvc.retrieve());
  ATH_CHECK(m_DetectorManagerKey.initialize());
  ATH_CHECK(m_cablingKey.initialize());
  return StatusCode::SUCCESS;
} 

inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< 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.

msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

MsgStream& AthCommonMsg< Algorithm >::msg ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< 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< Algorithm > >::renounce ( T &  h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

StatusCode AthAlgorithm::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< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, PyAthena::Alg, and AthHistogramAlgorithm.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< 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< Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase &  )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_cablingJSON

Gaudi::Property<std::string> MdtCablingJsonDumpAlg::m_cablingJSON {this, "OutCablingJSON", "MdtCabling.json", "Cabling JSON"}

private

Definition at line 41 of file MdtCablingJsonDumpAlg.h.

m_cablingKey

SG::ReadCondHandleKey<MuonMDT_CablingMap> MdtCablingJsonDumpAlg::m_cablingKey {this, "ReadKey", "MuonMDT_CablingMap", "Key of input MDT cabling map"}

private

Definition at line 37 of file MdtCablingJsonDumpAlg.h.

m_DetectorManagerKey

SG::ReadCondHandleKey<MuonGM::MuonDetectorManager> MdtCablingJsonDumpAlg::m_DetectorManagerKey

private

Initial value:

{this, "DetectorManagerKey", "MuonDetectorManager",
                                                                                "Key of input MuonDetectorManager condition data"}

Definition at line 34 of file MdtCablingJsonDumpAlg.h.

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< 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< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

m_idHelperSvc

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

private

Definition at line 32 of file MdtCablingJsonDumpAlg.h.

m_mezzJSON

Gaudi::Property<std::string> MdtCablingJsonDumpAlg::m_mezzJSON {this, "OutMezzanineJSON", "MezzMapping.json", "Mezzanine JSON"}

private

Definition at line 40 of file MdtCablingJsonDumpAlg.h.

m_summaryTxt

Gaudi::Property<std::string> MdtCablingJsonDumpAlg::m_summaryTxt {this, "SummaryFile", "SummaryFile.txt", "Summary of the extracted mapping"}

private

Definition at line 39 of file MdtCablingJsonDumpAlg.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• MdtCablingJsonDumpAlg.h
• MdtCablingJsonDumpAlg.cxx