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

#include <ParticleSortingAlg.h>

Inheritance diagram for ParticleSortingAlg:
Collaboration diagram for ParticleSortingAlg:

Public Member Functions

 ParticleSortingAlg (const std::string &name, ISvcLocator *pSvcLocator)
 Constructor with parameters: More...
 
virtual ~ParticleSortingAlg ()
 Destructor: More...
 
virtual StatusCode initialize () override
 Athena algorithm's initalize hook. More...
 
virtual StatusCode execute () override
 Athena algorithm's execute hook. More...
 
virtual StatusCode finalize () override
 Athena algorithm's finalize hook. 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, 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< StoreGateSvcStoreGateSvc_t
 

Private Member Functions

void setupInputContainer (Gaudi::Details::PropertyBase &)
 This internal method will realize if a user sets the 'InputContainer' property. More...
 
void setupOutputContainer (Gaudi::Details::PropertyBase &)
 This internal method will realize if a user sets the 'OutputContainer' property. More...
 
void setupSortVar (Gaudi::Details::PropertyBase &)
 This internal method will realize if a user sets the 'SortVariable' property. More...
 
void setupSortDescending (Gaudi::Details::PropertyBase &)
 This internal method will realize if a user sets the 'SortDeceding' property. More...
 
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< Gaudi::Interfaces::IOptionsSvc > m_jos
 The job options service (will be used to forward this algs properties to the private tool) More...
 
ToolHandle< DerivationFramework::IAugmentationToolm_tool
 The ToolHandle to the private ParticleSortingTool. More...
 
StringProperty m_inCollKey
 Input container name. More...
 
bool m_setInCollKey {false}
 This boolean is true if the user sets the 'InputContainer' property. More...
 
StringProperty m_outCollKey
 The name of the output container (with SG::VIEW_ELEMENTS) with the sorted copy of input objects. More...
 
bool m_setOutCollKey {false}
 This boolean is true if the user sets the 'OutputContainer' property. More...
 
StringProperty m_sortVar
 Define by what parameter to sort (default: 'pt') More...
 
bool m_setSortVar {false}
 This boolean is true if the user sets the 'SortVariable' property. More...
 
BooleanProperty m_sortDescending
 Define if the container should be sorted in a descending order (default=true) More...
 
bool m_setSortDescending {false}
 This boolean is true if the user sets the 'SortDescending' property. More...
 
unsigned long m_nEventsProcessed {0}
 Internal event counter. 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

Definition at line 28 of file ParticleSortingAlg.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ ParticleSortingAlg()

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

Constructor with parameters:

Definition at line 25 of file ParticleSortingAlg.cxx.

26  :
27  ::AthAlgorithm( name, pSvcLocator )
28 {
29 }

◆ ~ParticleSortingAlg()

ParticleSortingAlg::~ParticleSortingAlg ( )
virtual

Destructor:

Definition at line 35 of file ParticleSortingAlg.cxx.

36 {}

Member Function Documentation

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

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, V, H > &  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, V, H > &  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, 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.

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, V, H > &  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 ParticleSortingAlg::execute ( )
overridevirtual

Athena algorithm's execute hook.

Definition at line 116 of file ParticleSortingAlg.cxx.

117 {
118  // Increase the event counter
120 
121  // Simple status message at the beginning of each event execute,
122  ATH_MSG_DEBUG ( "==> execute " << name() << " on " << m_nEventsProcessed << ". event..." );
123 
124  // Call the tool
125  ATH_CHECK( m_tool->addBranches() );
126 
127  return StatusCode::SUCCESS;
128 }

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

◆ finalize()

StatusCode ParticleSortingAlg::finalize ( )
overridevirtual

Athena algorithm's finalize hook.

Definition at line 103 of file ParticleSortingAlg.cxx.

104 {
105  ATH_MSG_DEBUG ("Finalizing " << name() << "...");
106 
107  // Release all tools and services
108  ATH_CHECK( m_jos.release() );
109  ATH_CHECK( m_tool.release() );
110 
111  return StatusCode::SUCCESS;
112 }

◆ initialize()

StatusCode ParticleSortingAlg::initialize ( )
overridevirtual

Athena algorithm's initalize hook.

Definition at line 42 of file ParticleSortingAlg.cxx.

43 {
44  ATH_MSG_DEBUG ("Initializing " << name() << "...");
45 
46  // Print out the used configuration
47  ATH_MSG_DEBUG ( " using = " << m_jos );
48  ATH_MSG_DEBUG ( " using = " << m_tool );
49  ATH_MSG_DEBUG ( " using = " << m_inCollKey );
50  ATH_MSG_DEBUG ( " using = " << m_outCollKey );
51  ATH_MSG_DEBUG ( " using = " << m_sortVar );
52  ATH_MSG_DEBUG ( " using = " << m_sortDescending );
53 
54 
55  // Initialize the counters to zero
56  m_nEventsProcessed = 0 ;
57 
58 
59  // Get the JobOptionService
60  // We will use this to set the properties of our private skimming tool
61  // from the properties of this algorithm.
62  ATH_MSG_VERBOSE( "Getting the JobOptionService");
63  ATH_CHECK( m_jos.retrieve() );
64 
65  // Get the full name of the private skimTool
66  ATH_MSG_VERBOSE( "Getting the full name of the tool");
67  const std::string& fullToolName = this->name() + "." + m_tool.name();
68  ATH_MSG_DEBUG( "Got the full name of the tool: " << fullToolName );
69 
70  // Now, set all properties of the private skimTool that were acutally configured
71  if (m_setInCollKey) {
72  ATH_MSG_DEBUG( "Setting property" << m_inCollKey
73  << " of private tool with name: '" << fullToolName << "'" );
74  m_jos->set (fullToolName + "." + m_inCollKey.name(), m_inCollKey.toString());
75  }
76  if (m_setOutCollKey) {
77  ATH_MSG_DEBUG( "Setting property" << m_outCollKey
78  << " of private tool with name: '" << fullToolName << "'" );
79  m_jos->set (fullToolName + "." + m_outCollKey.name(), m_outCollKey.toString());
80  }
81  if (m_setSortVar) {
82  ATH_MSG_DEBUG( "Setting property" << m_sortVar
83  << " of private tool with name: '" << fullToolName << "'" );
84  m_jos->set (fullToolName + "." + m_sortVar.name(), m_sortVar.toString());
85  }
86  if (m_setSortDescending) {
87  ATH_MSG_DEBUG( "Setting property" << m_sortDescending
88  << " of private tool with name: '" << fullToolName << "'" );
89  m_jos->set (fullToolName + "." + m_sortDescending.name(), m_sortDescending.toString());
90  }
91  ATH_MSG_DEBUG( "Done setting properties of the tool");
92 
93  // Get the skimming tool
94  ATH_CHECK( m_tool.retrieve() );
95 
96  ATH_MSG_DEBUG ( "==> done with initialize " << name() << "..." );
97 
98  return StatusCode::SUCCESS;
99 }

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

◆ setupInputContainer()

void ParticleSortingAlg::setupInputContainer ( Gaudi::Details::PropertyBase &  )
inlineprivate

This internal method will realize if a user sets the 'InputContainer' property.

Definition at line 126 of file ParticleSortingAlg.h.

126  {
127  m_setInCollKey = true;
128  return;
129 }

◆ setupOutputContainer()

void ParticleSortingAlg::setupOutputContainer ( Gaudi::Details::PropertyBase &  )
inlineprivate

This internal method will realize if a user sets the 'OutputContainer' property.

Definition at line 132 of file ParticleSortingAlg.h.

132  {
133  m_setOutCollKey = true;
134  return;
135 }

◆ setupSortDescending()

void ParticleSortingAlg::setupSortDescending ( Gaudi::Details::PropertyBase &  )
inlineprivate

This internal method will realize if a user sets the 'SortDeceding' property.

Definition at line 145 of file ParticleSortingAlg.h.

146 {
147  m_setSortDescending = true;
148  return;
149 }

◆ setupSortVar()

void ParticleSortingAlg::setupSortVar ( Gaudi::Details::PropertyBase &  )
inlineprivate

This internal method will realize if a user sets the 'SortVariable' property.

Definition at line 138 of file ParticleSortingAlg.h.

139 {
140  m_setSortVar = true;
141  return;
142 }

◆ 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_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_inCollKey

StringProperty ParticleSortingAlg::m_inCollKey
private
Initial value:
{this, "InputContainer", "", &ParticleSortingAlg::setupInputContainer,
"Input container name" }

Input container name.

Definition at line 87 of file ParticleSortingAlg.h.

◆ m_jos

ServiceHandle<Gaudi::Interfaces::IOptionsSvc> ParticleSortingAlg::m_jos
private
Initial value:
{
this, "JobOptionsSvc", "JobOptionsSvc", "The JobOptionService instance." }

The job options service (will be used to forward this algs properties to the private tool)

Definition at line 78 of file ParticleSortingAlg.h.

◆ m_nEventsProcessed

unsigned long ParticleSortingAlg::m_nEventsProcessed {0}
private

Internal event counter.

Definition at line 115 of file ParticleSortingAlg.h.

◆ m_outCollKey

StringProperty ParticleSortingAlg::m_outCollKey
private
Initial value:
{this, "OutputContainer", "", &ParticleSortingAlg::setupOutputContainer,
"The name of the output container (with SG::VIEW_ELEMENTS) with the sorted copy of input objects" }

The name of the output container (with SG::VIEW_ELEMENTS) with the sorted copy of input objects.

Definition at line 94 of file ParticleSortingAlg.h.

◆ m_setInCollKey

bool ParticleSortingAlg::m_setInCollKey {false}
private

This boolean is true if the user sets the 'InputContainer' property.

Definition at line 91 of file ParticleSortingAlg.h.

◆ m_setOutCollKey

bool ParticleSortingAlg::m_setOutCollKey {false}
private

This boolean is true if the user sets the 'OutputContainer' property.

Definition at line 98 of file ParticleSortingAlg.h.

◆ m_setSortDescending

bool ParticleSortingAlg::m_setSortDescending {false}
private

This boolean is true if the user sets the 'SortDescending' property.

Definition at line 112 of file ParticleSortingAlg.h.

◆ m_setSortVar

bool ParticleSortingAlg::m_setSortVar {false}
private

This boolean is true if the user sets the 'SortVariable' property.

Definition at line 105 of file ParticleSortingAlg.h.

◆ m_sortDescending

BooleanProperty ParticleSortingAlg::m_sortDescending
private
Initial value:
{this, "SortDescending", true, &ParticleSortingAlg::setupSortDescending,
"Define if the container should be sorted in a descending order (default=true)" }

Define if the container should be sorted in a descending order (default=true)

Definition at line 108 of file ParticleSortingAlg.h.

◆ m_sortVar

StringProperty ParticleSortingAlg::m_sortVar
private
Initial value:
{this, "SortVariable", "pt", &ParticleSortingAlg::setupSortVar,
"Define by what parameter to sort (default: 'pt'; allowed: 'pt', 'eta', 'phi', 'm', 'e', 'rapidity')" }

Define by what parameter to sort (default: 'pt')

Definition at line 101 of file ParticleSortingAlg.h.

◆ m_tool

ToolHandle<DerivationFramework::IAugmentationTool> ParticleSortingAlg::m_tool
private
Initial value:
{
this, "SortingTool", "ParticleSortingTool/ParticleSortingTool", "The private ParticleSortingTool" }

The ToolHandle to the private ParticleSortingTool.

Definition at line 82 of file ParticleSortingAlg.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:
ParticleSortingAlg::setupSortVar
void setupSortVar(Gaudi::Details::PropertyBase &)
This internal method will realize if a user sets the 'SortVariable' property.
Definition: ParticleSortingAlg.h:138
ParticleSortingAlg::m_inCollKey
StringProperty m_inCollKey
Input container name.
Definition: ParticleSortingAlg.h:87
ParticleSortingAlg::m_outCollKey
StringProperty m_outCollKey
The name of the output container (with SG::VIEW_ELEMENTS) with the sorted copy of input objects.
Definition: ParticleSortingAlg.h:94
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
AthenaPoolTestRead.sc
sc
Definition: AthenaPoolTestRead.py:27
SG::VarHandleKeyArray::setOwner
virtual void setOwner(IDataHandleHolder *o)=0
IDTPMcnv.htype
htype
Definition: IDTPMcnv.py:29
AthCommonDataStore::declareGaudiProperty
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition: AthCommonDataStore.h:156
python.utils.AtlRunQueryDQUtils.p
p
Definition: AtlRunQueryDQUtils.py:209
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
AthCommonDataStore< AthCommonMsg< Algorithm > >::outputHandles
virtual std::vector< Gaudi::DataHandle * > outputHandles() const override
Return this algorithm's output handles.
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
AthCommonDataStore::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T, V, H > &t)
Definition: AthCommonDataStore.h:145
ParticleSortingAlg::m_setSortVar
bool m_setSortVar
This boolean is true if the user sets the 'SortVariable' property.
Definition: ParticleSortingAlg.h:105
ATH_CHECK
#define ATH_CHECK
Definition: AthCheckMacros.h:40
ParticleSortingAlg::m_jos
ServiceHandle< Gaudi::Interfaces::IOptionsSvc > m_jos
The job options service (will be used to forward this algs properties to the private tool)
Definition: ParticleSortingAlg.h:78
ParticleSortingAlg::m_sortDescending
BooleanProperty m_sortDescending
Define if the container should be sorted in a descending order (default=true)
Definition: ParticleSortingAlg.h:108
AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore
StoreGateSvc_t m_detStore
Pointer to StoreGate (detector store by default)
Definition: AthCommonDataStore.h:393
ParticleSortingAlg::m_setOutCollKey
bool m_setOutCollKey
This boolean is true if the user sets the 'OutputContainer' property.
Definition: ParticleSortingAlg.h:98
ParticleSortingAlg::m_nEventsProcessed
unsigned long m_nEventsProcessed
Internal event counter.
Definition: ParticleSortingAlg.h:115
ParticleSortingAlg::m_sortVar
StringProperty m_sortVar
Define by what parameter to sort (default: 'pt')
Definition: ParticleSortingAlg.h:101
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
ParticleSortingAlg::setupSortDescending
void setupSortDescending(Gaudi::Details::PropertyBase &)
This internal method will realize if a user sets the 'SortDeceding' property.
Definition: ParticleSortingAlg.h:145
merge_scale_histograms.doc
string doc
Definition: merge_scale_histograms.py:9
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:240
ParticleSortingAlg::m_setInCollKey
bool m_setInCollKey
This boolean is true if the user sets the 'InputContainer' property.
Definition: ParticleSortingAlg.h:91
AthAlgorithm::m_extendedExtraObjects
DataObjIDColl m_extendedExtraObjects
Definition: AthAlgorithm.h:79
a
TList * a
Definition: liststreamerinfos.cxx:10
h
ParticleSortingAlg::setupInputContainer
void setupInputContainer(Gaudi::Details::PropertyBase &)
This internal method will realize if a user sets the 'InputContainer' property.
Definition: ParticleSortingAlg.h:126
ATH_MSG_WARNING
#define ATH_MSG_WARNING(x)
Definition: AthMsgStreamMacros.h:32
ParticleSortingAlg::m_tool
ToolHandle< DerivationFramework::IAugmentationTool > m_tool
The ToolHandle to the private ParticleSortingTool.
Definition: ParticleSortingAlg.h:82
ParticleSortingAlg::m_setSortDescending
bool m_setSortDescending
This boolean is true if the user sets the 'SortDescending' property.
Definition: ParticleSortingAlg.h:112
SG::VarHandleBase::vhKey
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
Definition: StoreGate/src/VarHandleBase.cxx:629
ParticleSortingAlg::setupOutputContainer
void setupOutputContainer(Gaudi::Details::PropertyBase &)
This internal method will realize if a user sets the 'OutputContainer' property.
Definition: ParticleSortingAlg.h:132
AthAlgorithm::AthAlgorithm
AthAlgorithm()
Default constructor:
python.Bindings.keys
keys
Definition: Control/AthenaPython/python/Bindings.py:801
LHEF::Writer
Pythia8::Writer Writer
Definition: Prophecy4fMerger.cxx:12
fitman.k
k
Definition: fitman.py:528
ServiceHandle< ICondSvc >