SCT_FlaggedConditionTool.h

Go to the documentation of this file.

// -*- C++ -*-
 
/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
 
/*
 * @file SCT_FlaggedConditionTool.h
 * header file for tool allowing one to flag modules as 'bad' with a reason
 * @author gwilliam@mail.cern.ch
 */
 
#ifndef SCT_FlaggedConditionTool_h
#define SCT_FlaggedConditionTool_h
 
// Athena
#include "AthenaBaseComps/AthAlgTool.h"
#include "SCT_ConditionsTools/ISCT_FlaggedConditionTool.h"
#include "InDetConditionsSummaryService/InDetHierarchy.h"
#include "StoreGate/ReadHandleKey.h"
 
// STL
#include <atomic>
 
// Forward declarations
class SCT_ID;
 
/*
 * @class SCT_FlaggedConditionTool
 * Service allowing one to flag detector elements as 'bad' with a reason
 */
 
class SCT_FlaggedConditionTool: public extends<AthAlgTool, ISCT_FlaggedConditionTool> {
 
public:
  //@name Tool methods
  SCT_FlaggedConditionTool(const std::string& type, const std::string& name, const IInterface* parent);
  virtual ~SCT_FlaggedConditionTool() = default;
  virtual StatusCode initialize() override;
  virtual StatusCode finalize() override;

  virtual bool canReportAbout(InDetConditions::Hierarchy h) const override;
  
  virtual bool isGood(const Identifier& elementId, InDetConditions::Hierarchy h=InDetConditions::DEFAULT) const override;
  virtual bool isGood(const Identifier& elementId, const EventContext& ctx, InDetConditions::Hierarchy h=InDetConditions::DEFAULT) const override;
  virtual bool isGood(const IdentifierHash& hashId) const override;
  virtual bool isGood(const IdentifierHash& hashId, const EventContext& ctx) const override;
  virtual void getDetectorElementStatus(const EventContext& ctx, InDet::SiDetectorElementStatus &element_status, 
                                        SG::WriteCondHandle<InDet::SiDetectorElementStatus>* whandle) const override;
 
  virtual const std::string& details(const Identifier& id) const override;
  virtual const std::string& details(const Identifier& id, const EventContext& ctx) const override; 
  virtual const std::string& details(const IdentifierHash& id) const override;
  virtual const std::string& details(const IdentifierHash& id, const EventContext& ctx) const override;

  virtual int numBadIds() const override;
  virtual int numBadIds(const EventContext& ctx) const override;

  virtual const IDCInDetBSErrContainer* getBadIds() const override;
  virtual const IDCInDetBSErrContainer* getBadIds(const EventContext& ctx) const override;
 
 private:
  // SCT_FlaggedCondData created by SCT_Clusterization
  // SCT_FlaggedCondData_TRIG created by SCT_TrgClusterization for InDetTrigInDetSCT_FlaggedConditionTool
  SG::ReadHandleKey<IDCInDetBSErrContainer> m_badIds{this, "SCT_FlaggedCondData", "SCT_FlaggedCondData", "SCT flagged conditions data"};
 
  UnsignedIntegerProperty m_maxNumWarnForFailures{this, "MaxNumWarnForFailures", 5};
  mutable std::atomic_uint m_numWarnForFailures{0};
 
  const SCT_ID* m_sctID{nullptr}; 
 
  const IDCInDetBSErrContainer* getCondData(const EventContext& ctx) const;
};
 
#endif // SCT_FlaggedConditionTool_h