From 00cded717115f1caaf27e7f8a3a35f5ecfd0539f Mon Sep 17 00:00:00 2001
From: Susumu Oda <susumu.oda@cern.ch>
Date: Wed, 11 Dec 2019 12:49:01 +0000
Subject: [PATCH] Add comments to SiElementPropertiesTableCondAlg
(ATLIDTRKCP-222)
---
.../src/SiElementPropertiesTableCondAlg.cxx | 1 -
.../src/SiElementPropertiesTableCondAlg.h | 47 ++++++++++++++++++-
2 files changed, 45 insertions(+), 3 deletions(-)
diff --git a/InnerDetector/InDetRecAlgs/SiSpacePointFormation/src/SiElementPropertiesTableCondAlg.cxx b/InnerDetector/InDetRecAlgs/SiSpacePointFormation/src/SiElementPropertiesTableCondAlg.cxx
index 79e80dcf6d4..71d77bda01e 100644
--- a/InnerDetector/InDetRecAlgs/SiSpacePointFormation/src/SiElementPropertiesTableCondAlg.cxx
+++ b/InnerDetector/InDetRecAlgs/SiSpacePointFormation/src/SiElementPropertiesTableCondAlg.cxx
@@ -14,7 +14,6 @@ namespace InDet {
SiElementPropertiesTableCondAlg::SiElementPropertiesTableCondAlg(const std::string& name, ISvcLocator* pSvcLocator)
: ::AthReentrantAlgorithm(name, pSvcLocator)
, m_condSvc{"CondSvc", name}
- , m_idHelper{nullptr}
{
}
diff --git a/InnerDetector/InDetRecAlgs/SiSpacePointFormation/src/SiElementPropertiesTableCondAlg.h b/InnerDetector/InDetRecAlgs/SiSpacePointFormation/src/SiElementPropertiesTableCondAlg.h
index 6eacd6b7dcd..a1e44e7f323 100644
--- a/InnerDetector/InDetRecAlgs/SiSpacePointFormation/src/SiElementPropertiesTableCondAlg.h
+++ b/InnerDetector/InDetRecAlgs/SiSpacePointFormation/src/SiElementPropertiesTableCondAlg.h
@@ -18,25 +18,68 @@ class SCT_ID;
namespace InDet {
+ /**
+ * @class SiElementPropertiesTableCondAlg
+ * This class is a condition algorithm and inherits AthReentrantAlgorithm.
+ * This class reads SCT_DetectorElementCollection from condition store,
+ * prepares SCT "neighbours" using SCT_ElementPropertiesTable class,
+ * register it in condition store.
+ * The created SCT_ElementPropertiesTable object in condition store
+ * is used by SiTrackerSpacePointFinder.
+ */
+
class SiElementPropertiesTableCondAlg : public AthReentrantAlgorithm {
public:
+ /**
+ * @name Methods of AthReentrantAlgorithm
+ */
+ //@{
SiElementPropertiesTableCondAlg(const std::string& name, ISvcLocator* pSvcLocator);
virtual ~SiElementPropertiesTableCondAlg() override = default;
virtual StatusCode initialize() override;
virtual StatusCode execute(const EventContext& ctx) const override;
virtual StatusCode finalize() override;
+
/** Make this algorithm clonable. */
virtual bool isClonable() const override { return true; };
+ //@}
private:
+ /**
+ * @name Input data using SG::ReadCondHandleKey
+ */
+ //@{
SG::ReadCondHandleKey<InDetDD::SiDetectorElementCollection> m_readKey{this, "ReadKey", "SCT_DetectorElementCollection", "Key of input SiDetectorElementCollection for SCT"};
+ //@}
+
+ /**
+ * @name Output data using SG::WriteCondHandleKey
+ */
+ //@{
SG::WriteCondHandleKey<InDet::SiElementPropertiesTable> m_writeKey{this, "WriteKey", "SCT_ElementPropertiesTable", "Key of output SiElementPropertiesTable for SCT"};
+ //@}
+ /**
+ * @name Parameter for SiElementPropertiesTable and SiElementProperties
+ */
+ //@{
FloatProperty m_epsWidth{this, "EpsWidth", 0.02, "Safety margin for half-widths, in cm"};
+ //@}
+
+ /**
+ * @name Service
+ */
+ //@{
+ ServiceHandle<ICondSvc> m_condSvc; //!< For SG::WriteCondHandle
+ //@}
- ServiceHandle<ICondSvc> m_condSvc;
- const SCT_ID* m_idHelper;
+ /**
+ * @name Id helper
+ */
+ //@{
+ const SCT_ID* m_idHelper{nullptr};
+ //@}
};
}
--
GitLab