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

#include <OverlapLinkHelper.h>

Inheritance diagram for ORUtils::OverlapLinkHelper< CI >:

Collaboration diagram for ORUtils::OverlapLinkHelper< CI >:

Public Member Functions
	OverlapLinkHelper (const std::string &linkLabel)
	Constructor.
template<columnar::ContainerIdConcept LT>
StatusCode	addObjectLink (columnar::ObjectId< CI > p1, columnar::ObjectId< LT > p2) const
	Decorate p1 with an overlap object link to p2.
template<columnar::ContainerIdConcept LT>
columnar::OptObjectId< LT >	getObjectLink (columnar::ObjectId< CI > p, columnar::ObjectRange< LT > container) const
	Retrieve an overlap-linked particle.

Private Types
using	LTDef = columnar::VariantContainerId<columnar::ContainerId::particle1,columnar::ContainerId::particle1,columnar::ContainerId::particle2>

Private Attributes
columnar::ColumnDecorator< CI, columnar::ObjectLink< LTDef > >	m_linkDecorator
	Object link decorator.
columnar::ColumnAccessor< CI, columnar::ObjectLink< LTDef > >	m_linkAccessor
	Corresponding object link accessor (for reading only)

Detailed Description

template<columnar::ContainerIdConcept CI>
class ORUtils::OverlapLinkHelper< CI >

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 41 of file OverlapLinkHelper.h.

Member Typedef Documentation

◆ LTDef

template<columnar::ContainerIdConcept CI>

using ORUtils::OverlapLinkHelper< CI >::LTDef = columnar::VariantContainerId<columnar::ContainerId::particle1,columnar::ContainerId::particle1,columnar::ContainerId::particle2>

private

Definition at line 66 of file OverlapLinkHelper.h.

Constructor & Destructor Documentation

◆ OverlapLinkHelper()

template<columnar::ContainerIdConcept CI>

ORUtils::OverlapLinkHelper< CI >::OverlapLinkHelper ( const std::string & linkLabel )

Constructor.

Definition at line 79 of file OverlapLinkHelper.h.

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

Member Function Documentation

◆ addObjectLink()

template<columnar::ContainerIdConcept CI>

template<columnar::ContainerIdConcept LT>

StatusCode ORUtils::OverlapLinkHelper< CI >::addObjectLink	(	columnar::ObjectId< CI >	p1,
		columnar::ObjectId< LT >	p2 ) const

Decorate p1 with an overlap object link to p2.

Definition at line 88 of file OverlapLinkHelper.h.

  {
    m_linkDecorator.set (p1, p2);
    return StatusCode::SUCCESS;
  }

◆ getObjectLink()

template<columnar::ContainerIdConcept CI>

template<columnar::ContainerIdConcept LT>

columnar::OptObjectId< LT > ORUtils::OverlapLinkHelper< CI >::getObjectLink	(	columnar::ObjectId< CI >	p,
		columnar::ObjectRange< LT >	container ) const

Retrieve an overlap-linked particle.

Returns null if no ElementLink decoration exists.

Definition at line 99 of file OverlapLinkHelper.h.

  {
    // Check if the decoration is present and valid
    if(!m_linkAccessor.isAvailable(p))
      return {};
    auto link = m_linkAccessor(p);
    if (!link)
      return {};
    if constexpr (columnar::ColumnarModeDefault::isXAOD)
    {
      if (link.getXAODObject()->container() != &container.getXAODObject())
        return {};
    }
    return link.template tryGetVariant<LT>();
  }