ATLAS Offline Software
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Types | Private Member Functions | Private Attributes | List of all members
GoodRunsListSelectionTool Class Referenceabstract

Tool implementing the GRL selection. More...

#include <GoodRunsListSelectionTool.h>

Inheritance diagram for GoodRunsListSelectionTool:
Collaboration diagram for GoodRunsListSelectionTool:

Public Member Functions

 GoodRunsListSelectionTool (const std::string &name="GoodRunsListsSelectionTool")
 
virtual StatusCode initialize ()
 Initialize AlgTool. More...
 
virtual void print () const =0
 Print the state of the tool. More...
 
virtual void print () const
 Print the state of the tool. 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 sysInitialize () override
 Perform system initialization for an algorithm. 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
 
Interface inherited from IGoodRunsListSelectionTool
virtual bool passRunLB (const std::vector< std::string > &grlnameVec=std::vector< std::string >(), const std::vector< std::string > &brlnameVec=std::vector< std::string >()) const
 Check if the current event passes the selection. More...
 
virtual bool passRunLB (const xAOD::EventInfo &event, const std::vector< std::string > &grlnameVec=std::vector< std::string >(), const std::vector< std::string > &brlnameVec=std::vector< std::string >()) const
 Check if the event specified passes the selection. More...
 
virtual bool passRunLB (int runNumber, int lumiBlockNr, const std::vector< std::string > &grlnameVec=std::vector< std::string >(), const std::vector< std::string > &brlnameVec=std::vector< std::string >()) const
 Check if the event specified passes the selection. More...
 
virtual const Root::TGRLCollectiongetGRLCollection () const
 Get the good runs list used by the tool. More...
 
virtual const Root::TGRLCollectiongetBRLCollection () const
 Get the bad runs list used by the tool. More...
 
virtual bool eventPassesFilter () const
 ISkimmingTool method: will retrieve eventInfo from storegate and use that with above methods. More...
 

Static Public Member Functions

static const InterfaceID & interfaceID ()
 AlgTool interface methods. More...
 

Protected Member Functions

StatusCode readXMLs (Root::TGRLCollection &grl, const std::vector< std::string > &files)
 Helper function reading in the specified files into a GRL object. More...
 
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...
 

Protected Attributes

std::vector< std::string > m_goodrunslistVec
 
std::vector< std::string > m_blackrunslistVec
 
Root::TGRLCollection m_grlcollection
 
Root::TGRLCollection m_brlcollection
 
int m_boolop
 
bool m_passthrough
 
bool m_rejectanybrl
 

Private Types

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

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

Tool implementing the GRL selection.

This tool needs to be used to select good lumiblocks for a physics or performance analysis.

$Revision$ $Date$

Definition at line 33 of file GoodRunsListSelectionTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ GoodRunsListSelectionTool()

GoodRunsListSelectionTool::GoodRunsListSelectionTool ( const std::string &  name = "GoodRunsListsSelectionTool")

Definition at line 15 of file GoodRunsListSelectionTool.cxx.

16  : asg::AsgTool( name ) {
17 
18  declareProperty( "GoodRunsListVec", m_goodrunslistVec );
19  declareProperty( "BlackRunsListVec", m_blackrunslistVec );
20 
21  declareProperty( "BoolOperation", m_boolop = 0 );
22  declareProperty( "PassThrough", m_passthrough = true );
23  declareProperty( "RejectBlackRunsInEventSelector", m_rejectanybrl = false );
24 }

Member Function Documentation

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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; }

◆ eventPassesFilter()

bool GoodRunsListSelectionTool::eventPassesFilter ( ) const
virtual

ISkimmingTool method: will retrieve eventInfo from storegate and use that with above methods.

Implements DerivationFramework::ISkimmingTool.

Definition at line 189 of file GoodRunsListSelectionTool.cxx.

189  {
190  const xAOD::EventInfo* ei = 0;
191  if( evtStore()->retrieve( ei , "EventInfo" ).isFailure() ) {
192  ATH_MSG_ERROR("Unable to retrieve EventInfo, returning false");
193  return false;
194  }
195  return passRunLB( *ei );
196 }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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; }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::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

◆ getBRLCollection()

virtual const Root::TGRLCollection& GoodRunsListSelectionTool::getBRLCollection ( ) const
inlinevirtual

Get the bad runs list used by the tool.

Implements IGoodRunsListSelectionTool.

Definition at line 78 of file GoodRunsListSelectionTool.h.

78  {
79  return m_brlcollection;
80  }

◆ getGRLCollection()

virtual const Root::TGRLCollection& GoodRunsListSelectionTool::getGRLCollection ( ) const
inlinevirtual

Get the good runs list used by the tool.

Implements IGoodRunsListSelectionTool.

Definition at line 73 of file GoodRunsListSelectionTool.h.

73  {
74  return m_grlcollection;
75  }

◆ getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void *  ptr) const
inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also
asg::AsgTool::getName
Parameters
ptrThe bare pointer to the object that the event store should know about
Returns
The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

119  {
120 
121 #ifdef XAOD_STANDALONE
122  // In case we use @c xAOD::TEvent, we have a direct function call
123  // for this.
124  return evtStore()->event()->getKey( ptr );
125 #else
126  const SG::DataProxy* proxy = evtStore()->proxy( ptr );
127  return ( proxy == nullptr ? 0 : proxy->sgkey() );
128 #endif // XAOD_STANDALONE
129  }

◆ getName()

const std::string & asg::AsgTool::getName ( const void *  ptr) const
inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also
asg::AsgTool::getKey
Parameters
ptrThe bare pointer to the object that the event store should know about
Returns
The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

106  {
107 
108 #ifdef XAOD_STANDALONE
109  // In case we use @c xAOD::TEvent, we have a direct function call
110  // for this.
111  return evtStore()->event()->getName( ptr );
112 #else
113  const SG::DataProxy* proxy = evtStore()->proxy( ptr );
114  static const std::string dummy = "";
115  return ( proxy == nullptr ? dummy : proxy->name() );
116 #endif // XAOD_STANDALONE
117  }

◆ getProperty()

template<class T >
const T* asg::AsgTool::getProperty ( const std::string &  name) const
inherited

Get one of the tool's properties.

◆ initialize()

StatusCode GoodRunsListSelectionTool::initialize ( )
virtual

Initialize AlgTool.

Reimplemented from asg::AsgTool.

Definition at line 26 of file GoodRunsListSelectionTool.cxx.

26  {
27 
28  // Tell the user what's happening:
29  ATH_MSG_DEBUG( "Initialising tool" );
30 
31  // Set the output level of the underlying code:
32  const Root::TMsgLevel level =
33  static_cast< Root::TMsgLevel >( msg().level() );
35 
36  // Reset the pass-through mode setting:
37  if( m_goodrunslistVec.size() || m_blackrunslistVec.size() ) {
38  m_passthrough = false;
39  }
40 
41  // Warn about pass-through mode:
42  if( m_passthrough ) {
43  ATH_MSG_WARNING( "Set to pass-through mode." );
44  }
45 
46  // Read in the XML files:
49 
50  // Return gracefully:
51  return StatusCode::SUCCESS;
52 }

◆ inputHandles()

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

◆ interfaceID()

static const InterfaceID& DerivationFramework::ISkimmingTool::interfaceID ( )
inlinestaticinherited

AlgTool interface methods.

Definition at line 32 of file ISkimmingTool.h.

32 { return IID_ISkimmingTool; }

◆ msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const
inlineinherited

Definition at line 24 of file AthCommonMsg.h.

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

◆ msg() [2/2]

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

Definition at line 27 of file AthCommonMsg.h.

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

◆ msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const
inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns
The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

101  {
102 
103  return MSG::name( msg().level() );
104  }

◆ msgLvl()

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

◆ passRunLB() [1/3]

bool GoodRunsListSelectionTool::passRunLB ( const std::vector< std::string > &  grlnameVec = std::vector< std::string >(),
const std::vector< std::string > &  brlnameVec = std::vector< std::string >() 
) const
virtual

Check if the current event passes the selection.

Implements IGoodRunsListSelectionTool.

Definition at line 54 of file GoodRunsListSelectionTool.cxx.

56  {
57 
58  // Retrieve the xAOD::EventInfo object:
59  const xAOD::EventInfo* ei = 0;
60  if( ! evtStore()->retrieve( ei, "EventInfo" ).isSuccess() ) {
61  ATH_MSG_WARNING( "Couldn't access xAOD::EventInfo object. Using "
62  "pass-through mode..." );
63  return true;
64  }
65 
66  // MC events should not be filtered by this tool:
68  ATH_MSG_VERBOSE( "MC event is accepted by the tool" );
69  return true;
70  }
71 
72  // Use this object:
73  return passRunLB( *ei, grlnameVec, brlnameVec );
74 }

◆ passRunLB() [2/3]

bool GoodRunsListSelectionTool::passRunLB ( const xAOD::EventInfo event,
const std::vector< std::string > &  grlnameVec = std::vector< std::string >(),
const std::vector< std::string > &  brlnameVec = std::vector< std::string >() 
) const
virtual

Check if the event specified passes the selection.

Implements IGoodRunsListSelectionTool.

Definition at line 76 of file GoodRunsListSelectionTool.cxx.

79  {
80 
81  return passRunLB( event.runNumber(), event.lumiBlock(),
82  grlnameVec, brlnameVec );
83 }

◆ passRunLB() [3/3]

bool GoodRunsListSelectionTool::passRunLB ( int  runNumber,
int  lumiBlockNr,
const std::vector< std::string > &  grlnameVec = std::vector< std::string >(),
const std::vector< std::string > &  brlnameVec = std::vector< std::string >() 
) const
virtual

Check if the event specified passes the selection.

Implements IGoodRunsListSelectionTool.

Definition at line 86 of file GoodRunsListSelectionTool.cxx.

89  {
90 
91  ATH_MSG_VERBOSE( "passRunLB()" );
92 
93  // pass through
94  if( m_passthrough ) {
95  ATH_MSG_VERBOSE( "passRunLB() :: Pass through mode." );
96  return true;
97  }
98 
99  // decision based on merged blackrunslist
100  if( m_rejectanybrl &&
101  m_brlcollection.HasRunLumiBlock( runNumber, lumiBlockNr ) ) {
102  ATH_MSG_VERBOSE( "passRunLB() :: Event rejected by (_any_ of) merged "
103  "black runs list." );
104  return false;
105  }
106 
107  // decision based on specific blackrunlists
108  if( ( ! m_rejectanybrl ) && brlnameVec.size() ) {
109  for( const std::string& brlname : brlnameVec ) {
110  auto brl_itr = m_brlcollection.find( brlname );
111  if( brl_itr == m_brlcollection.end() ) {
112  continue;
113  }
114  if( brl_itr->HasRunLumiBlock( runNumber, lumiBlockNr ) ) {
115  ATH_MSG_VERBOSE( "passRunLB() :: Event rejected by specific ("
116  << brlname << ") black runs list." );
117  return false;
118  }
119  }
120  }
121 
122  // decision based on specific goodrunlists
123  for( const std::string& grlname : grlnameVec ) {
124  auto grl_itr = m_grlcollection.find( grlname );
125  if( grl_itr == m_grlcollection.end() ) {
126  continue;
127  }
128  if( grl_itr->HasRunLumiBlock( runNumber, lumiBlockNr ) ) {
129  ATH_MSG_VERBOSE( "passRunLB() :: Event accepted by specific ("
130  << grlname << ") good runs list." );
131  return true;
132  }
133  }
134 
135  // If we got this far, the decision needs to be made based on the combined
136  // GRL:
137  return m_grlcollection.HasRunLumiBlock( runNumber, lumiBlockNr );
138 }

◆ print() [1/2]

void asg::AsgTool::print ( ) const
virtualinherited

◆ print() [2/2]

virtual void asg::IAsgTool::print ( ) const
pure virtualinherited

◆ readXMLs()

StatusCode GoodRunsListSelectionTool::readXMLs ( Root::TGRLCollection grl,
const std::vector< std::string > &  files 
)
protected

Helper function reading in the specified files into a GRL object.

Definition at line 141 of file GoodRunsListSelectionTool.cxx.

142  {
143 
144  // If there are no files specified, then let's just clean the GRL object,
145  // and return:
146  if( files.empty() ) {
147  grl.clear();
148  return StatusCode::SUCCESS;
149  }
150 
151  // The reader object used:
153 
154  // Set up the files:
155  for( const std::string& fname : files ) {
156 
157  // Find the file:
158  std::string fileName = PathResolverFindXMLFile( fname );
159  if( fileName == "" ) {
160  //try with CalibArea
162  if(fileName=="") {
163  ATH_MSG_FATAL( "Couldn't find file: " << fname );
164  return StatusCode::FAILURE;
165  }
166  }
167  ATH_MSG_DEBUG( "Reading file: " << fileName << " (" << fname << ")" );
168 
169  // Add it to the reader:
170  reader.AddXMLFile( fileName );
171  }
172 
173  // (Try to) Interpret all the XML files:
174  if( ! reader.Interpret() ) {
175  ATH_MSG_ERROR( "There was an error parsing the GRL XML file(s)" );
176  return StatusCode::FAILURE;
177  }
178 
179  // Merge the GRLs into one:
180  const Root::BoolOperation op =
181  static_cast< Root::BoolOperation >( m_boolop );
182  grl = reader.GetMergedGRLCollection( op );
183 
184  // Return gracefully:
185  return StatusCode::SUCCESS;
186 }

◆ 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< AlgTool > >::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< AlgTool > >::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()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )
overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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_blackrunslistVec

std::vector< std::string > GoodRunsListSelectionTool::m_blackrunslistVec
protected

Definition at line 96 of file GoodRunsListSelectionTool.h.

◆ m_boolop

int GoodRunsListSelectionTool::m_boolop
protected

Definition at line 101 of file GoodRunsListSelectionTool.h.

◆ m_brlcollection

Root::TGRLCollection GoodRunsListSelectionTool::m_brlcollection
protected

Definition at line 99 of file GoodRunsListSelectionTool.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore
privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore
privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_goodrunslistVec

std::vector< std::string > GoodRunsListSelectionTool::m_goodrunslistVec
protected

Definition at line 95 of file GoodRunsListSelectionTool.h.

◆ m_grlcollection

Root::TGRLCollection GoodRunsListSelectionTool::m_grlcollection
protected

Definition at line 98 of file GoodRunsListSelectionTool.h.

◆ m_passthrough

bool GoodRunsListSelectionTool::m_passthrough
protected

Definition at line 102 of file GoodRunsListSelectionTool.h.

◆ m_rejectanybrl

bool GoodRunsListSelectionTool::m_rejectanybrl
protected

Definition at line 103 of file GoodRunsListSelectionTool.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared
privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

Definition at line 398 of file AthCommonDataStore.h.


The documentation for this class was generated from the following files:
python.PyKernel.retrieve
def retrieve(aClass, aKey=None)
Definition: PyKernel.py:110
Root::TGoodRunsListReader
Definition: TGoodRunsListReader.h:34
asg::AsgTool
Base class for the dual-use tool implementation classes.
Definition: AsgTool.h:47
ATH_MSG_FATAL
#define ATH_MSG_FATAL(x)
Definition: AthMsgStreamMacros.h:34
StateLessPT_NewConfig.proxy
proxy
Definition: StateLessPT_NewConfig.py:392
python.PerfMonSerializer.p
def p
Definition: PerfMonSerializer.py:743
ATH_MSG_INFO
#define ATH_MSG_INFO(x)
Definition: AthMsgStreamMacros.h:31
AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
Definition: AthCommonDataStore.h:145
GoodRunsListSelectionTool::readXMLs
StatusCode readXMLs(Root::TGRLCollection &grl, const std::vector< std::string > &files)
Helper function reading in the specified files into a GRL object.
Definition: GoodRunsListSelectionTool.cxx:141
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
Definition: AthCommonDataStore.h:390
AthCommonDataStore< AthCommonMsg< AlgTool > >::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
xAOD::EventInfo_v1::IS_SIMULATION
@ IS_SIMULATION
true: simulation, false: data
Definition: EventInfo_v1.h:151
Root::TGRLCollection::find
std::vector< TGoodRunsList >::iterator find(const TString &name)
Definition: TGRLCollection.cxx:226
python.iconfTool.models.loaders.level
level
Definition: loaders.py:20
SG::VarHandleKeyArray::setOwner
virtual void setOwner(IDataHandleHolder *o)=0
grl
Definition: ZLumiScripts/grid/grl.py:1
AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore
ServiceHandle< StoreGateSvc > & evtStore()
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
Definition: AthCommonDataStore.h:85
GoodRunsListSelectionTool::m_brlcollection
Root::TGRLCollection m_brlcollection
Definition: GoodRunsListSelectionTool.h:99
GoodRunsListSelectionTool::m_goodrunslistVec
std::vector< std::string > m_goodrunslistVec
Definition: GoodRunsListSelectionTool.h:95
FortranAlgorithmOptions.fileName
fileName
Definition: FortranAlgorithmOptions.py:13
AthCommonDataStore
Definition: AthCommonDataStore.h:52
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
event
POOL::TEvent event(POOL::TEvent::kClassAccess)
ATH_MSG_DEBUG
#define ATH_MSG_DEBUG(x)
Definition: AthMsgStreamMacros.h:29
PathResolverFindXMLFile
std::string PathResolverFindXMLFile(const std::string &logical_file_name)
Definition: PathResolver.cxx:374
GoodRunsListSelectionTool::m_boolop
int m_boolop
Definition: GoodRunsListSelectionTool.h:101
generateReferenceFile.files
files
Definition: generateReferenceFile.py:12
Root::TMsgLevel
TMsgLevel
Definition: TMsgLogger.h:42
GoodRunsListSelectionTool::m_blackrunslistVec
std::vector< std::string > m_blackrunslistVec
Definition: GoodRunsListSelectionTool.h:96
python.xAODType.dummy
dummy
Definition: xAODType.py:4
ATH_CHECK
#define ATH_CHECK
Definition: AthCheckMacros.h:40
MSG::name
const std::string & name(Level lvl)
Convenience function for translating message levels to strings.
Definition: MsgLevel.cxx:19
Root::TGRLCollection::HasRunLumiBlock
Bool_t HasRunLumiBlock(const Int_t &runnr, const Int_t &lumiblocknr) const
Definition: TGRLCollection.cxx:100
AthCommonDataStore< AthCommonMsg< AlgTool > >::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
merge_scale_histograms.doc
string doc
Definition: merge_scale_histograms.py:9
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:192
GoodRunsListSelectionTool::m_passthrough
bool m_passthrough
Definition: GoodRunsListSelectionTool.h:102
GoodRunsListSelectionTool::m_grlcollection
Root::TGRLCollection m_grlcollection
Definition: GoodRunsListSelectionTool.h:98
GoodRunsListSelectionTool::m_rejectanybrl
bool m_rejectanybrl
Definition: GoodRunsListSelectionTool.h:103
xAOD::EventInfo_v1
Class describing the basic event information.
Definition: EventInfo_v1.h:43
PathResolverFindCalibFile
std::string PathResolverFindCalibFile(const std::string &logical_file_name)
Definition: PathResolver.cxx:431
python.AthDsoLogger.fname
string fname
Definition: AthDsoLogger.py:67
DeMoAtlasDataLoss.runNumber
string runNumber
Definition: DeMoAtlasDataLoss.py:64
a
TList * a
Definition: liststreamerinfos.cxx:10
h
GoodRunsListSelectionTool::passRunLB
virtual bool passRunLB(const std::vector< std::string > &grlnameVec=std::vector< std::string >(), const std::vector< std::string > &brlnameVec=std::vector< std::string >()) const
Check if the current event passes the selection.
Definition: GoodRunsListSelectionTool.cxx:55
ATH_MSG_WARNING
#define ATH_MSG_WARNING(x)
Definition: AthMsgStreamMacros.h:32
AthCommonMsg< AlgTool >::msg
MsgStream & msg() const
Definition: AthCommonMsg.h:24
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
python.Bindings.keys
keys
Definition: Control/AthenaPython/python/Bindings.py:790
collisions.reader
reader
read the goodrunslist xml file(s)
Definition: collisions.py:22
Root::BoolOperation
BoolOperation
Definition: TGRLCollection.h:27
SG::DataProxy
Definition: DataProxy.h:44
AthCommonDataStore::declareGaudiProperty
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition: AthCommonDataStore.h:156
fitman.k
k
Definition: fitman.py:528
xAOD::EventInfo_v1::eventType
bool eventType(EventType type) const
Check for one particular bitmask value.
Root::TMsgLogger::SetMinLevel
static void SetMinLevel(TMsgLevel minLevel)
Definition: TMsgLogger.h:96