Helper class for setting links between overlapping objects. More...

#include <OverlapLinkHelper.h>

Collaboration diagram for ORUtils::OverlapLinkHelper:

Public Member Functions
	OverlapLinkHelper (const std::string &linkLabel)
	Constructor. More...

StatusCode	addObjectLink (const xAOD::IParticle &p1, const xAOD::IParticle &p2) const
	Decorate p1 with an overlap object link to p2. More...

const xAOD::IParticle *	getObjectLink (const xAOD::IParticle &p) const
	Retrieve an overlap-linked particle. More...

Private Attributes
ort::objLinkDecorator_t	m_linkDecorator
	Object link decorator. More...

ort::objLinkAccessor_t	m_linkAccessor
	Corresponding object link accessor (for reading only) More...

Detailed Description

Helper class for setting links between overlapping objects.

This utility class is used by the OverlapTools, though it could probably be used by a user as well. It can do two things at the moment:

Link one object to another
Retrieve a linked object

For this simple implementation, use a single object link. I might later allow for an array of links to include all possible object overlaps.

Author: Steve Farrell Steve.nosp@m.n.Fa.nosp@m.rrell.nosp@m.@cer.nosp@m.n.ch

Definition at line 34 of file OverlapLinkHelper.h.

Constructor & Destructor Documentation

◆ OverlapLinkHelper()

ORUtils::OverlapLinkHelper::OverlapLinkHelper ( const std::string & linkLabel )

Constructor.

Definition at line 14 of file OverlapLinkHelper.cxx.

     : m_linkDecorator(linkLabel),
       m_linkAccessor(linkLabel)
   {}

Member Function Documentation

◆ addObjectLink()

StatusCode ORUtils::OverlapLinkHelper::addObjectLink	(	const xAOD::IParticle &	p1,
		const xAOD::IParticle &	p2
	)		const

Decorate p1 with an overlap object link to p2.

Definition at line 22 of file OverlapLinkHelper.cxx.

   {
     const xAOD::IParticleContainer* overlapContainer =
       static_cast<const xAOD::IParticleContainer*>( p2.container() );
     m_linkDecorator(p1) = ort::objLink_t(*overlapContainer, p2.index());
     return StatusCode::SUCCESS;
   }

◆ getObjectLink()

const xAOD::IParticle * ORUtils::OverlapLinkHelper::getObjectLink ( const xAOD::IParticle & p ) const

Retrieve an overlap-linked particle.

Returns null if no ElementLink decoration exists.

Definition at line 34 of file OverlapLinkHelper.cxx.

   {
     // Check if the decoration is present and valid
     if(m_linkAccessor.isAvailable(p)) {
       auto& link = m_linkAccessor(p);
       if(link.isValid()) return *link;
     }
     return nullptr;
   }

Member Data Documentation

◆ m_linkAccessor

ort::objLinkAccessor_t ORUtils::OverlapLinkHelper::m_linkAccessor

private

Corresponding object link accessor (for reading only)

Definition at line 55 of file OverlapLinkHelper.h.

◆ m_linkDecorator

ort::objLinkDecorator_t ORUtils::OverlapLinkHelper::m_linkDecorator

private

Object link decorator.

Definition at line 53 of file OverlapLinkHelper.h.

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

Public Member Functions

Private Attributes