ParticleSortingAlg.h

Go to the documentation of this file.

 
/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
// ParticleSortingAlg.h
// Header file for class ParticleSortingAlg
// Author: Karsten Koeneke <karsten.koeneke@cern.ch>
#ifndef EVENTUTILS_PARTICLESORTINGALG_H
#define EVENTUTILS_PARTICLESORTINGALG_H 1
 
// FrameWork includes
#include "Gaudi/Interfaces/IOptionsSvc.h"
#include "GaudiKernel/ToolHandle.h"
#include "GaudiKernel/ServiceHandle.h"
#include "AthenaBaseComps/AthAlgorithm.h"
 
// STL includes
#include <string>
 
// Forward declarations
namespace DerivationFramework {
  class IAugmentationTool;
}
 
class ParticleSortingAlg
  : public ::AthAlgorithm
{

  // Public methods:
 public:
 
  // Copy constructor:

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

  virtual ~ParticleSortingAlg();

  virtual StatusCode initialize() override;

  virtual StatusCode execute() override;

  virtual StatusCode finalize() override;
 
 
private:
  // The update handlers

  void setupInputContainer( Gaudi::Details::PropertyBase& /*prop*/ );

  void setupOutputContainer( Gaudi::Details::PropertyBase& /*prop*/ );

  void setupSortVar( Gaudi::Details::PropertyBase& /*prop*/ );

  void setupSortDescending( Gaudi::Details::PropertyBase& /*prop*/ );
 
 

  // Private data:
 private:
  ServiceHandle<Gaudi::Interfaces::IOptionsSvc> m_jos{
    this, "JobOptionsSvc", "JobOptionsSvc", "The JobOptionService instance." };

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

  StringProperty m_inCollKey{this, "InputContainer", "", &ParticleSortingAlg::setupInputContainer,
    "Input container name" };

  bool m_setInCollKey{false};

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

  bool m_setOutCollKey{false};

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

  bool m_setSortVar{false};

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

  bool m_setSortDescending{false};

  unsigned long m_nEventsProcessed{0};
 
};
 
 

// Inline methods:

inline void ParticleSortingAlg::setupInputContainer( Gaudi::Details::PropertyBase& /*prop*/ ) {
  m_setInCollKey = true;
  return;
}

inline void ParticleSortingAlg::setupOutputContainer( Gaudi::Details::PropertyBase& /*prop*/ ) {
  m_setOutCollKey = true;
  return;
}

inline void ParticleSortingAlg::setupSortVar( Gaudi::Details::PropertyBase& /*prop*/ )
{
  m_setSortVar = true;
  return;
}

inline void ParticleSortingAlg::setupSortDescending( Gaudi::Details::PropertyBase& /*prop*/ )
{
  m_setSortDescending = true;
  return;
}
 
 
#endif //> !EVENTUTILS_PARTICLESORTINGALG_H