InputMakerBase.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2019 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef DECISIONHANDLING_INPUTMAKERBASE_H
#define DECISIONHANDLING_INPUTMAKERBASE_H 1
 
#include "TrigCompositeUtils/TrigCompositeUtils.h"
#include "AthenaBaseComps/AthReentrantAlgorithm.h"
#include "StoreGate/ReadHandleKeyArray.h"

class InputMakerBase : public ::AthReentrantAlgorithm {
 
 public:
  InputMakerBase( const std::string& name, ISvcLocator* pSvcLocator );
  virtual ~InputMakerBase(); 
  virtual StatusCode sysInitialize() override;
 
 protected:
  struct MatchingCache {
    void setMatchingHash(const TrigCompositeUtils::Decision* inputDecision, const uint64_t matchingHash);
    void linkOutputToInput(const TrigCompositeUtils::Decision* outputDecision, const TrigCompositeUtils::Decision* inputDecision);
    uint64_t getMatchingHash(const TrigCompositeUtils::Decision* outputDecision) const;
    std::map<const TrigCompositeUtils::Decision*, const TrigCompositeUtils::Decision*> m_outputDecToInputDec;
    std::map<const TrigCompositeUtils::Decision*, uint64_t> m_inputDecToMatchingHash;
  };

  const SG::ReadHandleKeyArray<TrigCompositeUtils::DecisionContainer>& decisionInputs() const;

  const SG::WriteHandleKey<TrigCompositeUtils::DecisionContainer>& decisionOutputs() const;
 
  // name of link to the RoI
  StringProperty m_roisLink {this, "RoIsLink", "initialRoI",
    "Name of EL to RoI object linked to the decision, used in merging input Decision objects when mergeUsingFeature=False." };
  
  Gaudi::Property<bool> m_mergeUsingFeature {this, "mergeUsingFeature", false,
    "True=the IParicle-derived feature from the previous step is used to determine identical inputs. False=the ROI located with the RoIsLink property is used to determine identical inputs" };
 
  Gaudi::Property<bool> m_isEmptyStep {this, "isEmptyStep", false,
    "True if this InputMaker instance is being used in an empty step. Forgoes the requirement to link an ROI, and auto-configures the 'mergeUsingFeature' property at runtime." };
  
  // helper methods for derived classes to reduce boiler plate code  //

  void debugPrintOut(const EventContext& context, SG::WriteHandle<TrigCompositeUtils::DecisionContainer>& outputHandle) const;

  StatusCode decisionInputToOutput(const EventContext& context, SG::WriteHandle<TrigCompositeUtils::DecisionContainer>& outputHandle) const;  

  size_t matchDecision(const TrigCompositeUtils::DecisionContainer* outDecisions, 
    const TrigCompositeUtils::Decision* toMatch, 
    const std::string& linkNameToMatch,
    MatchingCache& matchingCache) const;

  bool matchInCollection(const TrigCompositeUtils::DecisionContainer* outDecisions, 
    const TrigCompositeUtils::Decision* toMatch,
    size_t& matchIndex,
    bool& usedROIMatchingFlag,
    MatchingCache& matchingCache) const;

  uint64_t getMatchingHashForDecision(const TrigCompositeUtils::Decision* toMatch, const std::string& linkNameToMatch) const;
 
 private:

  SG::ReadHandleKeyArray<TrigCompositeUtils::DecisionContainer> m_inputs { this, "InputMakerInputDecisions", {}, "Input Decisions (implicit)" };

  SG::WriteHandleKey<TrigCompositeUtils::DecisionContainer> m_outputs { this, "InputMakerOutputDecisions", "", "Output Decisions" };
  
};
 
#endif // DECISIONHANDLING_INPUTMAKERBASE_H