QC-373 Replace largely unused and not respected CheckInterface::getAcceptedType and isObjectCheckable with an optional helper (#2597)

* Initial plan

* Remove CheckInterface::getAcceptedType and isObjectCheckable methods from framework and all user code

Co-authored-by: knopers8 <14327588+knopers8@users.noreply.github.com>

* Apply ALICE coding guidelines formatting using git-clang-format

Co-authored-by: knopers8 <14327588+knopers8@users.noreply.github.com>

* Address review comments: Add encapsulatedInheritFrom method and fix cosmetic issues

Co-authored-by: knopers8 <14327588+knopers8@users.noreply.github.com>

* Fix TOF check classes to use consistent types and add mAcceptedType constants

Co-authored-by: knopers8 <14327588+knopers8@users.noreply.github.com>

* Rename encapsulatedInheritFrom to encapsulatedInheritsFrom method

Co-authored-by: knopers8 <14327588+knopers8@users.noreply.github.com>

* bump MonitorObject version

* missing TClass inclusion

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: knopers8 <14327588+knopers8@users.noreply.github.com>
Co-authored-by: Piotr Konopka <piotr.jan.konopka@cern.ch>

Author: Copilot

Framework/include/QualityControl/CheckInterface.h

@@ -69,17 +69,6 @@ class CheckInterface : public core::UserCodeInterface
   /// then this should be reset here.
   virtual void reset(); // not fully abstract because we don't want to change all the existing subclasses
 
-  /// \brief Returns the name of the class that can be treated by this check.
-  ///
-  /// The name of the class returned by this method will be checked against the MonitorObject's encapsulated
-  /// object's class. If it is the same or a parent then the check will be applied. Therefore, this method
-  /// must return the highest class in the hierarchy that this check can use.
-  /// If the class does not override it, we return "TObject".
-  virtual std::string getAcceptedType();
-
-  bool isObjectCheckable(const std::shared_ptr<core::MonitorObject> mo);
-  bool isObjectCheckable(const core::MonitorObject* mo);
-
   virtual void startOfActivity(const core::Activity& activity); // not fully abstract because we don't want to change all the existing subclasses
   virtual void endOfActivity(const core::Activity& activity);   // not fully abstract because we don't want to change all the existing subclasses
 

Framework/include/QualityControl/MonitorObject.h

@@ -117,6 +117,11 @@ class MonitorObject : public TObject
   /// \brief Get metadata value of given key, returns std::nullopt if none exists;
   std::optional<std::string> getMetadata(const std::string& key);
 
+  /// \brief Check if the encapsulated object inherits from the given class name
+  /// \param className Name of the class to check inheritance from
+  /// \return true if the encapsulated object inherits from the given class, false otherwise
+  bool encapsulatedInheritsFrom(std::string_view className) const;
+
   void Draw(Option_t* option) override;
   TObject* DrawClone(Option_t* option) const override;
 
@@ -149,7 +154,7 @@ class MonitorObject : public TObject
   void releaseObject();
   void cloneAndSetObject(const MonitorObject&);
 
-  ClassDefOverride(MonitorObject, 14);
+  ClassDefOverride(MonitorObject, 15);
 };
 
 } // namespace o2::quality_control::core

Framework/src/CheckInterface.cxx

@@ -18,28 +18,12 @@
 #include "QualityControl/ReferenceUtils.h"
 #include "QualityControl/MonitorObject.h"
 
-#include <TClass.h>
-
 using namespace std;
 using namespace o2::quality_control::core;
 
 namespace o2::quality_control::checker
 {
 
-std::string CheckInterface::getAcceptedType() { return "TObject"; }
-
-bool CheckInterface::isObjectCheckable(const std::shared_ptr<MonitorObject> mo)
-{
-  return isObjectCheckable(mo.get());
-}
-
-bool CheckInterface::isObjectCheckable(const MonitorObject* mo)
-{
-  TObject* encapsulated = mo->getObject();
-
-  return encapsulated->IsA()->InheritsFrom(getAcceptedType().c_str());
-}
-
 void CheckInterface::configure()
 {
   // noop, override it if you want.

Framework/src/MonitorObject.cxx

@@ -16,6 +16,7 @@
 
 #include "QualityControl/MonitorObject.h"
 #include <TObject.h>
+#include <TClass.h>
 #include "QualityControl/RepoPathUtils.h"
 #include "QualityControl/QcInfoLogger.h"
 
@@ -162,6 +163,14 @@ std::optional<std::string> MonitorObject::getMetadata(const std::string& key)
   return std::nullopt;
 }
 
+bool MonitorObject::encapsulatedInheritsFrom(std::string_view className) const
+{
+  if (!mObject) {
+    return false;
+  }
+  return mObject->IsA()->InheritsFrom(className.data());
+}
+
 std::string MonitorObject::getPath() const
 {
   return RepoPathUtils::getMoPath(this);

Framework/test/testCheckInterface.cxx

@@ -62,11 +62,6 @@ class TestCheck : public checker::CheckInterface
     str->String().Append(" is beautiful now");
   }
 
-  std::string getAcceptedType() override
-  {
-    return "TObjString";
-  }
-
   string mValidString;
 };
 
@@ -90,6 +85,4 @@ TEST_CASE("test_invoke_all_interface_methods")
 
   testCheck.beautify(mo);
   CHECK(reinterpret_cast<TObjString*>(mo->getObject())->String() == "A string is beautiful now");
-
-  CHECK(testCheck.getAcceptedType() == "TObjString");
 }

Modules/Benchmark/include/Benchmark/AlwaysGoodCheck.h

@@ -37,8 +37,6 @@ class AlwaysGoodCheck : public o2::quality_control::checker::CheckInterface
   void configure() override;
   Quality check(std::map<std::string, std::shared_ptr<MonitorObject>>* moMap) override;
   void beautify(std::shared_ptr<MonitorObject> mo, Quality checkResult = Quality::Null) override;
-  std::string getAcceptedType() override;
-
   ClassDefOverride(AlwaysGoodCheck, 2);
 };
 

Modules/Benchmark/src/AlwaysGoodCheck.cxx

@@ -33,8 +33,6 @@ Quality AlwaysGoodCheck::check(std::map<std::string, std::shared_ptr<MonitorObje
   return Quality::Good;
 }
 
-std::string AlwaysGoodCheck::getAcceptedType() { return ""; }
-
 void AlwaysGoodCheck::beautify(std::shared_ptr<MonitorObject>, Quality)
 {
 }

Modules/CPV/include/CPV/PedestalCheck.h

@@ -37,7 +37,6 @@ class PedestalCheck : public o2::quality_control::checker::CheckInterface
   void configure() override;
   Quality check(std::map<std::string, std::shared_ptr<MonitorObject>>* moMap) override;
   void beautify(std::shared_ptr<MonitorObject> mo, Quality checkResult = Quality::Null) override;
-  std::string getAcceptedType() override;
 
  private:
   int getRunNumberFromMO(std::shared_ptr<MonitorObject> mo);

Modules/CPV/include/CPV/PhysicsCheck.h

@@ -37,7 +37,6 @@ class PhysicsCheck : public o2::quality_control::checker::CheckInterface
   void configure() override;
   Quality check(std::map<std::string, std::shared_ptr<MonitorObject>>* moMap) override;
   void beautify(std::shared_ptr<MonitorObject> mo, Quality checkResult = Quality::Null) override;
-  std::string getAcceptedType() override { return "TH1"; }
 
  private:
   int getRunNumberFromMO(std::shared_ptr<MonitorObject> mo);

Modules/CPV/src/PedestalCheck.cxx

@@ -279,9 +279,6 @@ Quality PedestalCheck::check(std::map<std::string, std::shared_ptr<MonitorObject
   return result;
 }
 
-// std::string PedestalCheck::getAcceptedType() { return "TObject"; }
-std::string PedestalCheck::getAcceptedType() { return "TH1"; }
-
 void PedestalCheck::beautify(std::shared_ptr<MonitorObject> mo, Quality checkResult)
 {
   return;                                // do noting for the time being. Maybe in the future we will do something sofisticated