HypoBase.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2021 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef DECISIONHANDLING_HYPOBASE_H
#define DECISIONHANDLING_HYPOBASE_H 1
 
#include "TrigCompositeUtils/TrigCompositeUtils.h"
#include "AthenaBaseComps/AthAlgorithm.h"
#include "AthenaBaseComps/AthReentrantAlgorithm.h"
#include "StoreGate/ReadHandleKeyArray.h"
 
class HypoBase : public ::AthReentrantAlgorithm {
 public:
  HypoBase( const std::string& name, ISvcLocator* pSvcLocator );
  virtual ~HypoBase(); 
  virtual StatusCode sysInitialize() override;

  static StatusCode runtimeValidation(SG::WriteHandle<TrigCompositeUtils::DecisionContainer>& outputHandle, 
    MsgStream& msg,
    bool onlyValidateOneStep = true,
    bool runTwoConversion = false);
 
 protected:

  const SG::ReadHandleKey<TrigCompositeUtils::DecisionContainer>& decisionInput() const;
  const SG::WriteHandleKey<TrigCompositeUtils::DecisionContainer>& decisionOutput() const;
  StatusCode hypoBaseOutputProcessing(SG::WriteHandle<TrigCompositeUtils::DecisionContainer>& outputHandle, 
    MSG::Level lvl = MSG::DEBUG) const;
 
 private:

 
  enum LogicalFlowCheckMode { 
    kRequireOne, 
    kRequireAll //<! Require all DecisionIDs to be present in all of my parent Decision objects
  };

  static StatusCode validateHasLinks(const ElementLink<TrigCompositeUtils::DecisionContainer>& dEL,
    MsgStream& msg);

  static StatusCode validateLogicalFlow(const ElementLink<TrigCompositeUtils::DecisionContainer>& dEL,
    MsgStream& msg,
    const LogicalFlowCheckMode mode);

  static StatusCode validateDuplicatedDecisionID(const ElementLink<TrigCompositeUtils::DecisionContainer>& dEL,
    MsgStream& msg);

  static StatusCode validateDecisionIDs(const ElementLink<TrigCompositeUtils::DecisionContainer>& dEL,
    MsgStream& msg);

  static StatusCode validateParentLinking(const ElementLink<TrigCompositeUtils::DecisionContainer>& dEL, 
    MsgStream& msg,
    bool runTwoConversion);

  static StatusCode recursiveValidateGraph(const ElementLink<TrigCompositeUtils::DecisionContainer>& dEL, 
    MsgStream& msg,
    bool onlyValidateOneStep,
    bool runTwoConversion,
    size_t callDepth,
    std::set<const TrigCompositeUtils::Decision*>& fullyExploredFrom);

  static void printBangs(MsgStream& msg);

  static void printErrorHeader(const ElementLink<TrigCompositeUtils::DecisionContainer>& dEL,
    MsgStream& msg);


  StatusCode printDebugInformation(SG::WriteHandle<TrigCompositeUtils::DecisionContainer>& outputHandle,
    MSG::Level lvl) const;
  
  SG::ReadHandleKey<TrigCompositeUtils::DecisionContainer> m_input { this, "HypoInputDecisions", "UNSPECIFIED_INPUT", "Input Decision (implicit)" };
  SG::WriteHandleKey<TrigCompositeUtils::DecisionContainer> m_output { this, "HypoOutputDecisions", "UNSPECIFIED_OUTPUT", "Ouput Decision" };
  Gaudi::Property<bool> m_runtimeValidation { this, "RuntimeValidation", false, "Enable detailed runtime validation of HypoAlg output, and upstream Decisions." };
    
  // for future implementation: ToolHandleArray<ITestHypoTool> m_tools { this, "HypoTools", {}, "Hypo tools" };
 
 
};
 
 
#endif // DECISIONHANDLING_HYPOBASE_H