#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 > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)

void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
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 > &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
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::IAugmentationTool >	m_tool
	The ToolHandle to the private ParticleSortingTool. More...

StringProperty	m_inCollKey
	Input container name. More...

bool	m_setInCollKey
	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
	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
	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
	This boolean is true if the user sets the 'SortDescending' property. More...

unsigned long	m_nEventsProcessed
	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.

                                                                    :
   ::AthAlgorithm( name, pSvcLocator ),
   m_jos("JobOptionsSvc", name),
   m_tool("ParticleSortingTool/ParticleSortingTool", this),
   m_inCollKey(""),
   m_setInCollKey(false),
   m_outCollKey(""),
   m_setOutCollKey(false),
   m_sortVar("pt"),
   m_setSortVar(false),
   m_sortDescending(true),
   m_setSortDescending(false),
   m_nEventsProcessed(0)
 {
   declareProperty("JobOptionsSvc",   m_jos, "The JobOptionService instance.");
  
   declareProperty("SortingTool",        m_tool, "The private ParticleSortingTool" );
  
   declareProperty("InputContainer",  m_inCollKey="",   "Input container name" );
   m_inCollKey.declareUpdateHandler( &ParticleSortingAlg::setupInputContainer, this );
  
   declareProperty("OutputContainer", m_outCollKey="",
                   "The name of the output container (with SG::VIEW_ELEMENTS) with the sorted copy of input objects" );
   m_outCollKey.declareUpdateHandler( &ParticleSortingAlg::setupOutputContainer, this );
  
   declareProperty("SortVariable",    m_sortVar="pt",
                   "Define by what parameter to sort (default: 'pt'; allowed: 'pt', 'eta', 'phi', 'm', 'e', 'rapidity')" );
   m_sortVar.declareUpdateHandler( &ParticleSortingAlg::setupSortVar, this );
  
   declareProperty("SortDescending",   m_sortDescending=true,
                   "Define if the container should be sorted in a descending order (default=true)" );
   m_sortDescending.declareUpdateHandler( &ParticleSortingAlg::setupSortDescending, this );
 }

◆ ~ParticleSortingAlg()

ParticleSortingAlg::~ParticleSortingAlg ( )

virtual

Destructor:

Definition at line 64 of file ParticleSortingAlg.cxx.

65 {}

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.

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

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

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

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

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

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

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

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

inlineinherited

Declare a new Gaudi property.

Parameters

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

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

Definition at line 245 of file AthCommonDataStore.h.

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

◆ declareProperty() [2/6]

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

inlineinherited

Declare a new Gaudi property.

Parameters

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

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

Definition at line 221 of file AthCommonDataStore.h.

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

◆ declareProperty() [3/6]

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

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

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

◆ declareProperty() [4/6]

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

inlineinherited

Declare a new Gaudi property.

Parameters

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

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

Definition at line 333 of file AthCommonDataStore.h.

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

◆ declareProperty() [5/6]

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

inlineinherited

Declare a new Gaudi property.

Parameters

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

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

Definition at line 352 of file AthCommonDataStore.h.

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

◆ declareProperty() [6/6]

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

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

◆ detStore()

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

inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

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 145 of file ParticleSortingAlg.cxx.

 {
   // Increase the event counter
   ++m_nEventsProcessed;
  
   // Simple status message at the beginning of each event execute,
   ATH_MSG_DEBUG ( "==> execute " << name() << " on " << m_nEventsProcessed << ". event..." );
  
   // Call the tool
   ATH_CHECK( m_tool->addBranches() );
  
   return StatusCode::SUCCESS;
 }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 50 of file AthAlgorithm.cxx.

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

◆ finalize()

StatusCode ParticleSortingAlg::finalize ( )

overridevirtual

Athena algorithm's finalize hook.

Definition at line 132 of file ParticleSortingAlg.cxx.

 {
   ATH_MSG_DEBUG ("Finalizing " << name() << "...");
  
   // Release all tools and services
   ATH_CHECK( m_jos.release() );
   ATH_CHECK( m_tool.release() );
  
   return StatusCode::SUCCESS;
 }

◆ initialize()

StatusCode ParticleSortingAlg::initialize ( )

overridevirtual

Athena algorithm's initalize hook.

Definition at line 71 of file ParticleSortingAlg.cxx.

 {
   ATH_MSG_DEBUG ("Initializing " << name() << "...");
  
   // Print out the used configuration
   ATH_MSG_DEBUG ( " using = " << m_jos );
   ATH_MSG_DEBUG ( " using = " << m_tool );
   ATH_MSG_DEBUG ( " using = " << m_inCollKey );
   ATH_MSG_DEBUG ( " using = " << m_outCollKey );
   ATH_MSG_DEBUG ( " using = " << m_sortVar );
   ATH_MSG_DEBUG ( " using = " << m_sortDescending );
  
  
   // Initialize the counters to zero
   m_nEventsProcessed = 0 ;
  
  
   // Get the JobOptionService
   // We will use this to set the properties of our private skimming tool
   // from the properties of this algorithm.
   ATH_MSG_VERBOSE( "Getting the JobOptionService");
   ATH_CHECK( m_jos.retrieve() );
  
   // Get the full name of the private skimTool
   ATH_MSG_VERBOSE( "Getting the full name of the tool");
   const std::string& fullToolName = this->name() + "." + m_tool.name();
   ATH_MSG_DEBUG( "Got the full name of the tool: " << fullToolName );
  
   // Now, set all properties of the private skimTool that were acutally configured
   if (m_setInCollKey) {
     ATH_MSG_DEBUG( "Setting property" << m_inCollKey
                    << " of private tool with name: '" << fullToolName << "'" );
     m_jos->set (fullToolName + "." + m_inCollKey.name(), m_inCollKey.toString());
   }
   if (m_setOutCollKey) {
     ATH_MSG_DEBUG( "Setting property" << m_outCollKey
                    << " of private tool with name: '" << fullToolName << "'" );
     m_jos->set (fullToolName + "." + m_outCollKey.name(), m_outCollKey.toString());
   }
   if (m_setSortVar) {
     ATH_MSG_DEBUG( "Setting property" << m_sortVar
                    << " of private tool with name: '" << fullToolName << "'" );
     m_jos->set (fullToolName + "." + m_sortVar.name(), m_sortVar.toString());
   }
   if (m_setSortDescending) {
     ATH_MSG_DEBUG( "Setting property" << m_sortDescending
                    << " of private tool with name: '" << fullToolName << "'" );
     m_jos->set (fullToolName + "." + m_sortDescending.name(),  m_sortDescending.toString());
   }
   ATH_MSG_DEBUG( "Done setting properties of the tool");
  
   // Get the skimming tool
   ATH_CHECK( m_tool.retrieve() );
  
   ATH_MSG_DEBUG ( "==> done with initialize " << name() << "..." );
  
   return StatusCode::SUCCESS;
 }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

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

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ setupInputContainer()

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

inlineprivate

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

Definition at line 123 of file ParticleSortingAlg.h.

                                                                                  {
   m_setInCollKey = true;
   return;
 }

◆ setupOutputContainer()

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

inlineprivate

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

Definition at line 129 of file ParticleSortingAlg.h.

                                                                                   {
   m_setOutCollKey = true;
   return;
 }

◆ setupSortDescending()

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

inlineprivate

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

Definition at line 142 of file ParticleSortingAlg.h.

 {
   m_setSortDescending = true;
   return;
 }

◆ setupSortVar()

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

inlineprivate

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

Definition at line 135 of file ParticleSortingAlg.h.

 {
   m_setSortVar = true;
   return;
 }

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

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

Definition at line 66 of file AthAlgorithm.cxx.

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

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

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

Member Data Documentation

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

Input container name.

Definition at line 84 of file ParticleSortingAlg.h.

◆ m_jos

ServiceHandle<Gaudi::Interfaces::IOptionsSvc> ParticleSortingAlg::m_jos

private

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

private

Internal event counter.

Definition at line 112 of file ParticleSortingAlg.h.

◆ m_outCollKey

StringProperty ParticleSortingAlg::m_outCollKey

private

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

Definition at line 91 of file ParticleSortingAlg.h.

◆ m_setInCollKey

bool ParticleSortingAlg::m_setInCollKey

private

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

Definition at line 87 of file ParticleSortingAlg.h.

◆ m_setOutCollKey

bool ParticleSortingAlg::m_setOutCollKey

private

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

Definition at line 94 of file ParticleSortingAlg.h.

◆ m_setSortDescending

bool ParticleSortingAlg::m_setSortDescending

private

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

Definition at line 108 of file ParticleSortingAlg.h.

◆ m_setSortVar

bool ParticleSortingAlg::m_setSortVar

private

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

Definition at line 101 of file ParticleSortingAlg.h.

◆ m_sortDescending

BooleanProperty ParticleSortingAlg::m_sortDescending

private

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

Definition at line 105 of file ParticleSortingAlg.h.

◆ m_sortVar

StringProperty ParticleSortingAlg::m_sortVar

private

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

Definition at line 98 of file ParticleSortingAlg.h.

◆ m_tool

ToolHandle<DerivationFramework::IAugmentationTool> ParticleSortingAlg::m_tool

private

The ToolHandle to the private ParticleSortingTool.

Definition at line 81 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:

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ ParticleSortingAlg()

◆ ~ParticleSortingAlg()

Member Function Documentation

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setupInputContainer()

◆ setupOutputContainer()

◆ setupSortDescending()

◆ setupSortVar()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_inCollKey

◆ m_jos

◆ m_nEventsProcessed

◆ m_outCollKey

◆ m_setInCollKey

◆ m_setOutCollKey

◆ m_setSortDescending

◆ m_setSortVar

◆ m_sortDescending

◆ m_sortVar

◆ m_tool

◆ m_varHandleArraysDeclared

◆ m_vhka