ATLAS Offline Software
Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
TrigConf::xAODMenuWriter Class Reference

Algorithm used to write the light-weight xAOD configuration. More...

#include <xAODMenuWriter.h>

Inheritance diagram for TrigConf::xAODMenuWriter:
Collaboration diagram for TrigConf::xAODMenuWriter:

Public Member Functions

 xAODMenuWriter (const std::string &name, ISvcLocator *svcLoc)
 Regular Algorithm constructor. More...
 
virtual StatusCode initialize ()
 Function initialising the algorithm. More...
 
virtual StatusCode execute ()
 Function executing the algorithm. More...
 
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 > &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 std::pair< uint32_t, std::pair< uint32_t, uint32_t > > TrigKey_t
 Trigger configuration key type (used just internally) More...
 
typedef ServiceHandle< StoreGateSvcStoreGateSvc_t
 

Private Member Functions

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

Private Attributes

std::string m_eventName
 StoreGate key for the event object. More...
 
std::string m_metaName
 StoreGate key for the configuration object. More...
 
bool m_overwriteEventObj
 Switch for overwriting existing event-wise objects. More...
 
ServiceHandle< TrigConf::ITrigConfigSvcm_trigConf
 Connection to the trigger configuration service. More...
 
ServiceHandle< StoreGateSvcm_metaStore
 Connection to the metadata store. More...
 
xAOD::TriggerMenuContainerm_tmc
 The configuration object that we are writing. More...
 
std::set< TrigKey_tm_convertedKeys
 Trigger configuration keys that are already converted. More...
 
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

Algorithm used to write the light-weight xAOD configuration.

   This algorithm needs to be scheduled in jobs that write xAOD
   files in Athena in order to write the trigger configuration
   into the output file.

   It puts a tiny amount of information into each event that is
   later used to find the correct configuration of the events,
   and also assembles the configuration metadata that is written
   into the metadata TTree of the xAOD file at the end of the job.
Author
Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h
Revision
589118
Date
2014-03-24 17:20:19 +0100 (Mon, 24 Mar 2014)

Definition at line 49 of file xAODMenuWriter.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

Definition at line 388 of file AthCommonDataStore.h.

◆ TrigKey_t

typedef std::pair< uint32_t, std::pair< uint32_t, uint32_t > > TrigConf::xAODMenuWriter::TrigKey_t
private

Trigger configuration key type (used just internally)

Definition at line 78 of file xAODMenuWriter.h.

Constructor & Destructor Documentation

◆ xAODMenuWriter()

TrigConf::xAODMenuWriter::xAODMenuWriter ( const std::string &  name,
ISvcLocator *  svcLoc 
)

Regular Algorithm constructor.

Definition at line 33 of file xAODMenuWriter.cxx.

35  : AthAlgorithm( name, svcLoc ),
36  m_trigConf( "TrigConfigSvc", name ),
37  m_metaStore( "MetaDataStore", name ),
38  m_tmc( 0 ) {
39 
40  declareProperty( "EventObjectName", m_eventName = "TrigConfKeys" );
41  declareProperty( "MetaObjectName", m_metaName = "TriggerMenu" );
42  declareProperty( "OverwriteEventObj", m_overwriteEventObj = false );
43 
44  declareProperty( "TrigConfigSvc", m_trigConf );
45  declareProperty( "MetaDataStore", m_metaStore );
46  }

Member Function Documentation

◆ declareGaudiProperty() [1/4]

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

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

Definition at line 170 of file AthCommonDataStore.h.

172  {
173  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
174  hndl.value(),
175  hndl.documentation());
176 
177  }

◆ declareGaudiProperty() [2/4]

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

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

Definition at line 156 of file AthCommonDataStore.h.

158  {
159  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
160  hndl.value(),
161  hndl.documentation());
162 
163  }

◆ declareGaudiProperty() [3/4]

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

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

Definition at line 184 of file AthCommonDataStore.h.

186  {
187  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
188  hndl.value(),
189  hndl.documentation());
190  }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty ( Gaudi::Property< T > &  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.

200  {
201  return PBASE::declareProperty(t);
202  }

◆ 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
nameName of the property.
hndlObject holding the property value.
docDocumentation 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.

249  {
250  this->declare(hndl.vhKey());
251  hndl.vhKey().setOwner(this);
252 
253  return PBASE::declareProperty(name,hndl,doc);
254  }

◆ 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
nameName of the property.
hndlObject holding the property value.
docDocumentation 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.

225  {
226  this->declare(hndl);
227  hndl.setOwner(this);
228 
229  return PBASE::declareProperty(name,hndl,doc);
230  }

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

263  {
264 
265  // std::ostringstream ost;
266  // ost << Algorithm::name() << " VHKA declareProp: " << name
267  // << " size: " << hndArr.keys().size()
268  // << " mode: " << hndArr.mode()
269  // << " vhka size: " << m_vhka.size()
270  // << "\n";
271  // debug() << ost.str() << endmsg;
272 
273  hndArr.setOwner(this);
274  m_vhka.push_back(&hndArr);
275 
276  Gaudi::Details::PropertyBase* p = PBASE::declareProperty(name, hndArr, doc);
277  if (p != 0) {
278  p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
279  } else {
280  ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray "
281  << name);
282  }
283 
284  return p;
285 
286  }

◆ 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
nameName of the property.
propertyObject holding the property value.
docDocumentation 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.

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

◆ 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
nameName of the property.
propertyObject holding the property value.
docDocumentation 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.

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

◆ declareProperty() [6/6]

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

Definition at line 145 of file AthCommonDataStore.h.

145  {
146  typedef typename SG::HandleClassifier<T>::type htype;
148  }

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

95 { 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.

85 { 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.

90 { return m_evtStore; }

◆ execute()

StatusCode TrigConf::xAODMenuWriter::execute ( )
virtual

Function executing the algorithm.

Definition at line 79 of file xAODMenuWriter.cxx.

79  {
80 
81  // Check if the event-level object exists already:
82  if( ( ! evtStore()->contains< xAOD::TrigConfKeys >( m_eventName ) ) ||
84 
85  // Create the trigger configuration keys for the event data:
87  new xAOD::TrigConfKeys( m_trigConf->masterKey(),
88  m_trigConf->lvl1PrescaleKey(),
89  m_trigConf->hltPrescaleKey() );
90 
91  // Now record it:
92  if( m_overwriteEventObj ) {
93  CHECK( evtStore()->overwrite( keys, m_eventName, false ) );
94  } else {
95  CHECK( evtStore()->record( keys, m_eventName ) );
96  }
97  }
98 
99  // Create the keys in the "internal format":
100  TrigKey_t ckeys =
101  std::make_pair( m_trigConf->masterKey(),
102  std::make_pair( m_trigConf->lvl1PrescaleKey(),
103  m_trigConf->hltPrescaleKey() ) );
104 
105  // Check if we converted this configuration already:
106  if( ! m_convertedKeys.insert( ckeys ).second ) {
107  ATH_MSG_VERBOSE( "Configuration with keys SMK: "
108  << ckeys.first << ", L1PSK: " << ckeys.second.first
109  << ", HLTPSK: " << ckeys.second.second
110  << " already translated" );
111  return StatusCode::SUCCESS;
112  }
113 
114  // Tell the user what's happening:
115  ATH_MSG_INFO( "Converting configuration with keys SMK: "
116  << ckeys.first << ", L1PSK: " << ckeys.second.first
117  << ", HLTPSK: " << ckeys.second.second );
118 
119  // Apparently not, so let's make a new object:
121  m_tmc->push_back( menu );
122 
123  //
124  // Set its keys:
125  //
126  menu->setSMK( m_trigConf->masterKey() );
127  menu->setL1psk( m_trigConf->lvl1PrescaleKey() );
128  menu->setHLTpsk( m_trigConf->hltPrescaleKey() );
129 
130  //
131  // Set its LVL1 information:
132  //
133  ATH_MSG_DEBUG( "Filling LVL1 information" );
134  std::vector< uint16_t > ctpIds;
135  std::vector< std::string > itemNames;
136  std::vector< float > itemPrescales;
137  TrigConf::ItemContainer::const_iterator item_itr =
138  m_trigConf->ctpConfig()->menu().items().begin();
139  TrigConf::ItemContainer::const_iterator item_end =
140  m_trigConf->ctpConfig()->menu().items().end();
141  std::vector< float > prescales =
142  m_trigConf->ctpConfig()->prescaleSet().prescales_float();
143  for( ; item_itr != item_end; ++item_itr ) {
144 
145  // Extract the information:
146  ctpIds.push_back( ( *item_itr )->ctpId() );
147  itemNames.push_back( ( *item_itr )->name() );
148  itemPrescales.push_back( prescales[ ( *item_itr )->ctpId() ] );
149 
150  // Some verbose information:
151  ATH_MSG_VERBOSE( " \"" << itemNames.back() << "\" CTP Id = "
152  << ctpIds.back() << ", prescale = "
153  << itemPrescales.back() );
154  }
155  menu->setItemCtpIds( ctpIds );
156  menu->setItemNames( itemNames );
157  menu->setItemPrescales( itemPrescales );
158 
159  //
160  // Set its HLT information:
161  //
162  ATH_MSG_DEBUG( "Filling HLT information" );
163  std::vector< uint16_t > chainIds;
164  std::vector< std::string > chainNames, chainParentNames;
165  std::vector< float > chainPrescales, chainRerunPrescales,
166  chainPassthroughPrescales;
167 
168  std::vector< std::vector< uint32_t > > chainSignatureCounters;
169  std::vector< std::vector< int > > chainSignatureLogics;
170  std::vector< std::vector< std::vector< std::string > > > chainSignatureOutputTEs;
171  std::vector< std::vector< std::string > > chainSignatureLabels;
172 
173  TrigConf::HLTChainList::const_iterator chain_itr =
174  m_trigConf->chains().begin();
175  TrigConf::HLTChainList::const_iterator chain_end =
176  m_trigConf->chains().end();
177  for( ; chain_itr != chain_end; ++chain_itr ) {
178 
179  // Extract the information:
180  chainIds.push_back( ( *chain_itr )->chain_counter() );
181  chainNames.push_back( ( *chain_itr )->chain_name() );
182  chainParentNames.push_back( ( *chain_itr )->lower_chain_name() );
183  chainPrescales.push_back( ( *chain_itr )->prescale() );
184  chainRerunPrescales.push_back(
185  ( *chain_itr )->prescales().getRerunPrescale("").second );
186  chainPassthroughPrescales.push_back( ( *chain_itr )->pass_through() );
187 
188  std::vector<uint32_t> counters;
189  std::vector<int> logics;
190  std::vector<std::vector<std::string> > outputTEs;
191  std::vector<std::string> labels;
192 
193  ATH_MSG_VERBOSE((*chain_itr)->chain_name() << " has " << (*chain_itr)->signatureList().size() << " signatures");
194  for(auto& signature : (*chain_itr)->signatureList() ){
195  uint32_t cntr = signature->signature_counter();
196  counters.push_back(cntr);
197  logics.push_back(signature->logic());
198  labels.push_back(signature->label());
199  std::vector<std::string> outputTEids;
200  for(auto& outputTE : signature->outputTEs()){
201  outputTEids.push_back(outputTE->name());
202  }
203  outputTEs.push_back(outputTEids);
204  ATH_MSG_VERBOSE("converted this signature: " << *signature);
205  }
206  chainSignatureCounters.push_back(counters);
207  chainSignatureLogics.push_back(logics);
208  chainSignatureOutputTEs.push_back(outputTEs);
209  chainSignatureLabels.push_back(labels);
210 
211  // Some verbose information:
212  ATH_MSG_VERBOSE( " \"" << chainNames.back() << "\" Chain Id = "
213  << chainIds.back() << ", parent name = \""
214  << chainParentNames.back() << "\", prescale = "
215  << chainPrescales.back() << ", re-run prescale = "
216  << chainRerunPrescales.back()
217  << ", pass-through presclale = "
218  << chainPassthroughPrescales.back() );
219  }
220  menu->setChainIds( chainIds );
221  menu->setChainNames( chainNames );
222  menu->setChainParentNames( chainParentNames );
223  menu->setChainPrescales( chainPrescales );
224  menu->setChainRerunPrescales( chainRerunPrescales );
225  menu->setChainPassthroughPrescales( chainPassthroughPrescales );
226  menu->setChainSignatureCounters(chainSignatureCounters);
227 
228  menu->setChainSignatureCounters(chainSignatureCounters);
229  menu->setChainSignatureLogics(chainSignatureLogics);
230  menu->setChainSignatureOutputTEs(chainSignatureOutputTEs);
231  menu->setChainSignatureLabels(chainSignatureLabels);
232 
233  //
234  // Set its sequence information:
235  //
236  ATH_MSG_DEBUG( "Filling sequence information" );
237  auto& sequenceList = m_trigConf->sequences();
238  std::vector<std::vector<std::string> > sequenceInputTEs;
239  std::vector<std::string> sequenceOutputTE;
240  std::vector<std::vector<std::string> > sequenceAlgorithms;
241 
242  for(auto& seq : sequenceList){
243  std::vector<std::string> inputTEs;
244  for(auto& input : seq->inputTEs()) inputTEs.push_back(input->name());
245  sequenceInputTEs.push_back(inputTEs);
246  sequenceAlgorithms.push_back(seq->algorithms());
247  sequenceOutputTE.push_back(seq->outputTE()->name());
248 
249  ATH_MSG_VERBOSE("original sequence: \n" << *seq);
250 
251  ATH_MSG_VERBOSE("added sequence with: ");
252  ATH_MSG_VERBOSE(" inputTEs: " << sequenceInputTEs.back());
253  ATH_MSG_VERBOSE(" algos: " << sequenceAlgorithms.back());
254  ATH_MSG_VERBOSE(" outputTE: " << sequenceOutputTE.back());
255  }
256 
257  menu->setSequenceInputTEs(sequenceInputTEs);
258  menu->setSequenceOutputTEs(sequenceOutputTE);
259  menu->setSequenceAlgorithms(sequenceAlgorithms);
260 
261  //
262  // Set its bunch-group information:
263  //
264  ATH_MSG_DEBUG( "Filling bunch-group information" );
265  std::vector< std::vector< uint16_t > > bgs;
266  std::vector< BunchGroup >::const_iterator bg_itr =
267  m_trigConf->bunchGroupSet()->bunchGroups().begin();
268  std::vector< BunchGroup >::const_iterator bg_end =
269  m_trigConf->bunchGroupSet()->bunchGroups().end();
270  for( int i = 0; bg_itr != bg_end; ++bg_itr, ++i ) {
271 
272  // Extract the information. Unfortunately we need to make
273  // and explicit conversion by hand.
274  const std::vector< uint16_t > bunches( bg_itr->bunches().begin(),
275  bg_itr->bunches().end() );
276  bgs.push_back( bunches );
277 
278  // Some verbose information:
279  ATH_MSG_VERBOSE( " Bunch group " << i << " bunches: "
280  << bgs.back() );
281  }
282  menu->setBunchGroupBunches( bgs );
283 
284  // Return gracefully:
285  return StatusCode::SUCCESS;
286  }

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

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

◆ initialize()

StatusCode TrigConf::xAODMenuWriter::initialize ( )
virtual

Function initialising the algorithm.

Definition at line 48 of file xAODMenuWriter.cxx.

48  {
49 
50  // Greet the user:
51  ATH_MSG_INFO( "Initialising" );
52  ATH_MSG_DEBUG( "EventObjectName = " << m_eventName );
53  ATH_MSG_DEBUG( "MetaObjectName = " << m_metaName );
54  ATH_MSG_DEBUG( "OverwriteEventObj = "
55  << ( m_overwriteEventObj ? "Yes" : "No" ) );
56  ATH_MSG_VERBOSE( "TrigConfigSvc = " << m_trigConf );
57  ATH_MSG_VERBOSE( "MetaDataStore = " << m_metaStore );
58 
59  // Retrieve the necessary service(s):
60  CHECK( m_trigConf.retrieve() );
61  CHECK( m_metaStore.retrieve() );
62 
63  // Clear the internal cache variable:
64  m_convertedKeys.clear();
65 
66  // Create an empty trigger menu container:
69  m_tmc->setStore( aux );
70 
71  // Record the trigger configuration metadata into it:
72  CHECK( m_metaStore->record( aux, m_metaName + "Aux." ) );
73  CHECK( m_metaStore->record( m_tmc, m_metaName ) );
74 
75  // Return gracefully:
76  return StatusCode::SUCCESS;
77  }

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

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

◆ msg() [2/2]

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

Definition at line 27 of file AthCommonMsg.h.

27  {
28  return this->msgStream(lvl);
29  }

◆ msgLvl()

bool AthCommonMsg< 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< 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.

381  {
382  h.renounce();
383  PBASE::renounce (h);
384  }

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

364  {
365  handlesArray.renounce();
366  }

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

66  {
68 
69  if (sc.isFailure()) {
70  return sc;
71  }
72  ServiceHandle<ICondSvc> cs("CondSvc",name());
73  for (auto h : outputHandles()) {
74  if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
75  // do this inside the loop so we don't create the CondSvc until needed
76  if ( cs.retrieve().isFailure() ) {
77  ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
78  return StatusCode::SUCCESS;
79  }
80  if (cs->regHandle(this,*h).isFailure()) {
81  sc = StatusCode::FAILURE;
82  ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
83  << " with CondSvc");
84  }
85  }
86  }
87  return sc;
88 }

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

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

Member Data Documentation

◆ m_convertedKeys

std::set< TrigKey_t > TrigConf::xAODMenuWriter::m_convertedKeys
private

Trigger configuration keys that are already converted.

Definition at line 81 of file xAODMenuWriter.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_eventName

std::string TrigConf::xAODMenuWriter::m_eventName
private

StoreGate key for the event object.

Definition at line 63 of file xAODMenuWriter.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_metaName

std::string TrigConf::xAODMenuWriter::m_metaName
private

StoreGate key for the configuration object.

Definition at line 65 of file xAODMenuWriter.h.

◆ m_metaStore

ServiceHandle< StoreGateSvc > TrigConf::xAODMenuWriter::m_metaStore
private

Connection to the metadata store.

Definition at line 72 of file xAODMenuWriter.h.

◆ m_overwriteEventObj

bool TrigConf::xAODMenuWriter::m_overwriteEventObj
private

Switch for overwriting existing event-wise objects.

Definition at line 67 of file xAODMenuWriter.h.

◆ m_tmc

xAOD::TriggerMenuContainer* TrigConf::xAODMenuWriter::m_tmc
private

The configuration object that we are writing.

Definition at line 75 of file xAODMenuWriter.h.

◆ m_trigConf

ServiceHandle< TrigConf::ITrigConfigSvc > TrigConf::xAODMenuWriter::m_trigConf
private

Connection to the trigger configuration service.

Definition at line 70 of file xAODMenuWriter.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:
test_athena_ntuple_filter.seq
seq
filter configuration ## -> we use the special sequence 'AthMasterSeq' which is run before any other a...
Definition: test_athena_ntuple_filter.py:18
xAOD::TriggerMenuContainer
TriggerMenuContainer_v1 TriggerMenuContainer
Define the latest version of the trigger menu container class.
Definition: TriggerMenuContainer.h:17
TrigConf::xAODMenuWriter::m_trigConf
ServiceHandle< TrigConf::ITrigConfigSvc > m_trigConf
Connection to the trigger configuration service.
Definition: xAODMenuWriter.h:70
python.PerfMonSerializer.p
def p
Definition: PerfMonSerializer.py:743
ATH_MSG_INFO
#define ATH_MSG_INFO(x)
Definition: AthMsgStreamMacros.h:31
xAOD::uint32_t
setEventNumber uint32_t
Definition: EventInfo_v1.cxx:127
xAOD::TrigConfKeys
TrigConfKeys_v1 TrigConfKeys
Declare the current version of the trigger configuration keys type.
Definition: TrigConfKeys.h:16
AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
Definition: AthCommonDataStore.h:145
AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
Definition: AthCommonDataStore.h:390
AthCommonDataStore< AthCommonMsg< Algorithm > >::m_vhka
std::vector< SG::VarHandleKeyArray * > m_vhka
Definition: AthCommonDataStore.h:398
read_hist_ntuple.t
t
Definition: read_hist_ntuple.py:5
ATH_MSG_VERBOSE
#define ATH_MSG_VERBOSE(x)
Definition: AthMsgStreamMacros.h:28
TrigConf::xAODMenuWriter::TrigKey_t
std::pair< uint32_t, std::pair< uint32_t, uint32_t > > TrigKey_t
Trigger configuration key type (used just internally)
Definition: xAODMenuWriter.h:78
RatesAnalysisFullMenu.prescales
prescales
Definition: RatesAnalysisFullMenu.py:119
AthenaPoolTestRead.sc
sc
Definition: AthenaPoolTestRead.py:27
SG::VarHandleKeyArray::setOwner
virtual void setOwner(IDataHandleHolder *o)=0
TrigConf::xAODMenuWriter::m_metaStore
ServiceHandle< StoreGateSvc > m_metaStore
Connection to the metadata store.
Definition: xAODMenuWriter.h:72
AthCommonDataStore< AthCommonMsg< Algorithm > >::evtStore
ServiceHandle< StoreGateSvc > & evtStore()
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
Definition: AthCommonDataStore.h:85
menu
make the sidebar many part of the config
Definition: hcg.cxx:551
beamspotnt.labels
list labels
Definition: bin/beamspotnt.py:1447
AthCommonDataStore
Definition: AthCommonDataStore.h:52
AthAlgorithm::sysInitialize
virtual StatusCode sysInitialize() override
Override sysInitialize.
Definition: AthAlgorithm.cxx:66
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
TrigConf::xAODMenuWriter::m_overwriteEventObj
bool m_overwriteEventObj
Switch for overwriting existing event-wise objects.
Definition: xAODMenuWriter.h:67
AthCommonDataStore< AthCommonMsg< Algorithm > >::outputHandles
virtual std::vector< Gaudi::DataHandle * > outputHandles() const override
Return this algorithm's output handles.
lumiFormat.i
int i
Definition: lumiFormat.py:92
TrigConf::xAODMenuWriter::m_convertedKeys
std::set< TrigKey_t > m_convertedKeys
Trigger configuration keys that are already converted.
Definition: xAODMenuWriter.h:81
xAOD::TriggerMenuAuxContainer
TriggerMenuAuxContainer_v1 TriggerMenuAuxContainer
Define the latest version of the trigger menu auxiliary container class.
Definition: TriggerMenuAuxContainer.h:16
EL::StatusCode
::StatusCode StatusCode
StatusCode definition for legacy code.
Definition: PhysicsAnalysis/D3PDTools/EventLoop/EventLoop/StatusCode.h:22
ATH_MSG_DEBUG
#define ATH_MSG_DEBUG(x)
Definition: AthMsgStreamMacros.h:29
PlotPulseshapeFromCool.input
input
Definition: PlotPulseshapeFromCool.py:106
CHECK
#define CHECK(...)
Evaluate an expression and check for errors.
Definition: Control/AthenaKernel/AthenaKernel/errorcheck.h:422
AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore
StoreGateSvc_t m_detStore
Pointer to StoreGate (detector store by default)
Definition: AthCommonDataStore.h:393
SG::VarHandleKeyArray::renounce
virtual void renounce()=0
SG::HandleClassifier::type
std::conditional< std::is_base_of< SG::VarHandleKeyArray, T >::value, VarHandleKeyArrayType, type2 >::type type
Definition: HandleClassifier.h:54
TrigConf::xAODMenuWriter::m_eventName
std::string m_eventName
StoreGate key for the event object.
Definition: xAODMenuWriter.h:63
xAOD::TrigConfKeys_v1
Class describing the configuration used in a given event.
Definition: TrigConfKeys_v1.h:32
merge_scale_histograms.doc
string doc
Definition: merge_scale_histograms.py:9
xAOD::TriggerMenu
TriggerMenu_v1 TriggerMenu
Define the latest version of the trigger menu class.
Definition: TriggerMenu.h:16
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:195
DataVector::push_back
value_type push_back(value_type pElem)
Add an element to the end of the collection.
xAOD::TriggerMenuAuxContainer_v1
Auxiliary store object for TriggerMenuContainer_v1.
Definition: TriggerMenuAuxContainer_v1.h:36
AthAlgorithm::m_extendedExtraObjects
DataObjIDColl m_extendedExtraObjects
Definition: AthAlgorithm.h:79
TrigConf::xAODMenuWriter::m_metaName
std::string m_metaName
StoreGate key for the configuration object.
Definition: xAODMenuWriter.h:65
a
TList * a
Definition: liststreamerinfos.cxx:10
h
ATH_MSG_WARNING
#define ATH_MSG_WARNING(x)
Definition: AthMsgStreamMacros.h:32
SG::VarHandleBase::vhKey
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
Definition: StoreGate/src/VarHandleBase.cxx:616
declareProperty
#define declareProperty(n, p, h)
Definition: BaseFakeBkgTool.cxx:15
AthAlgorithm::AthAlgorithm
AthAlgorithm()
Default constructor:
python.Bindings.keys
keys
Definition: Control/AthenaPython/python/Bindings.py:790
LHEF::Writer
Pythia8::Writer Writer
Definition: Prophecy4fMerger.cxx:12
xAOD::TriggerMenu_v1
Class holding one particular trigger configuration.
Definition: TriggerMenu_v1.h:34
AthCommonDataStore::declareGaudiProperty
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition: AthCommonDataStore.h:156
TrigConf::xAODMenuWriter::m_tmc
xAOD::TriggerMenuContainer * m_tmc
The configuration object that we are writing.
Definition: xAODMenuWriter.h:75
fitman.k
k
Definition: fitman.py:528
ServiceHandle< ICondSvc >