ColumnarLinkTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/

 
 
#ifndef COLUMNAR_HELPER_TOOLS_COLUMNAR_LINK_TOOL_H
#define COLUMNAR_HELPER_TOOLS_COLUMNAR_LINK_TOOL_H
 
#include <AsgTools/AsgTool.h>
#include <AsgTools/PropertyWrapper.h>
#include <ColumnarCore/ColumnAccessor.h>
#include <ColumnarCore/ColumnAccessorDataArray.h>
#include <ColumnarCore/ColumnarDef.h>
#include <ColumnarCore/ColumnarTool.h>
#include <SGCore/sgkey_t.h>
 
#include <memory>
#include <string>
#include <vector>
 
namespace columnar
{
 
  class ColumnarLinkTool final
    : public asg::AsgTool,
      public ColumnarTool<>
  {
  public:
 
    // Create a proper constructor for Athena
    ASG_TOOL_CLASS( ColumnarLinkTool, asg::IAsgTool )
 
    ColumnarLinkTool (const std::string& name);
 
    virtual StatusCode initialize () override;
 
    virtual void callEvents (EventContextRange events) const override;
 
 
    Gaudi::Property<std::vector<std::string>> m_targetContainerNames {
      this, "targetContainerNames", {},
      "names of the allowed target containers, in order of their columnar-key index"};
 
    Gaudi::Property<bool> m_errorOnUnknownKey {
      this, "errorOnUnknownKey", true,
      "whether an unknown sgkey should produce an error (true), or an invalid link (false)"};
 
    Gaudi::Property<unsigned> m_nestingDepth {
      this, "nestingDepth", 0u,
      "nesting depth of vector-of-link inputs (0 = scalar link per particle, 1 = vector of links per particle, 2 = vector of vector of links, ...)"};
 

    struct ColumnSlot final
    {
      unsigned dataIndex = 0u;
      std::unique_ptr<ColumnAccessorDataArray> accessorData;
    };
 
 
  private:

    struct TargetSlot final
    {
      SG::sgkey_t sgKey = 0;
      unsigned dataIndex = 0u;
      std::unique_ptr<ColumnAccessorDataArray> accessorData;
    };
    std::vector<TargetSlot> m_targetSlots;

    ColumnSlot m_srcContainerSlot;

    std::vector<ColumnSlot> m_linkOffsetSlots;

    ColumnSlot m_indexSlot;

    ColumnSlot m_keySlot;

    ColumnSlot m_outLinkSlot;
  };
}
 
#endif