TrigAnalysisHelpers/TrigAnalysisHelpers/FeatureRequestDescriptor.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef TRIGANALYSISHELPERS_FEATUREREQUESTDESCRIPTOR_H
#define TRIGANALYSISHELPERS_FEATUREREQUESTDESCRIPTOR_H
 
/**********************************************************************************
 * @Package: TrigAnalysisHelpers
 * @class  : FeatureRequestDescriptor
 *
 * @brief Helper class to encapsulate all possible configuration options when making a
 * request for trigger chain features using the TrigDecisionTool's run 3 interface.
 *
 ***********************************************************************************/
#include <string>
#include <sstream>
#include <regex>
 
#include "AsgMessaging/MsgStream.h"
#include "TrigDecisionInterface/Conditions.h"
#include "TrigCompositeUtils/TrigCompositeUtils.h"
 
namespace Trig {
 
  class FeatureRequestDescriptor {
 
   public:

    FeatureRequestDescriptor(const std::string& chainGroupName = "",
      const unsigned int condition = TrigDefs::Physics,
      const std::string& containerSGKey = "",
      const unsigned int featureCollectionMode = TrigDefs::lastFeatureOfType,
      const std::string& navElementLinkKey = TrigCompositeUtils::featureString(),
      const int restrictToLegIndex = -1);

    ~FeatureRequestDescriptor() = default;

    FeatureRequestDescriptor(FeatureRequestDescriptor&&) = default; 

    FeatureRequestDescriptor(const FeatureRequestDescriptor&) = default;  

    void reset();

    void print(MsgStream& msg, const MSG::Level level = MSG::INFO);

    FeatureRequestDescriptor& setChainGroup(const std::string& chainGroupName);

    FeatureRequestDescriptor& setCondition(const unsigned int condition);

    FeatureRequestDescriptor& setRequireSGKey(const std::string& containerSGKey);

    FeatureRequestDescriptor& setFeatureCollectionMode(const unsigned int featureCollectionMode);

    FeatureRequestDescriptor& setLinkName(const std::string& navElementLinkKey);

    FeatureRequestDescriptor& setRestrictRequestToLeg(const int restrictToLegIndex);

    const std::string& chainGroup() const;

    unsigned int condition() const;

    const std::string& SGKey() const;

    const std::regex& SGKeyExpression() const;

    unsigned int featureCollectionMode() const;

    const std::string& linkName() const;

    int restrictRequestToLeg() const;
 
   private:
 
    std::string m_chainGroupName;
    int m_condition;
    std::string m_containerSGKey;
    std::regex m_containerSGKeyExpression;
    int m_featureCollectionMode;
    std::string m_navElementLinkKey;
    int m_restrictToLegIndex;
 
  };
} // End of namespace
 
#endif // TRIGANALYSISHELPERS_FEATUREREQUESTDESCRIPTOR_H