MonitorObject.h

Go to the documentation of this file.

// Copyright CERN and copyright holders of ALICE O2. This software is
// distributed under the terms of the GNU General Public License v3 (GPL
// Version 3), copied verbatim in the file "COPYING".
//
// See http://alice-o2.web.cern.ch/license for full licensing information.
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.


#ifndef QC_CORE_MONITOROBJECT_H
#define QC_CORE_MONITOROBJECT_H

// std
#include <string>
#include <map>
// ROOT
#include <Rtypes.h>
#include <TObject.h>
// O2
#include <Common/Exceptions.h>

namespace o2::quality_control::core
{

struct DuplicateObjectError : virtual AliceO2::Common::ExceptionBase {
  const char* what() const noexcept override
  {
    return "Duplicate object error";
  }
};

class MonitorObject : public TObject
{
 public:
  MonitorObject();
  MonitorObject(TObject* object, const std::string& taskName, const std::string& detectorName = "DET");
  ~MonitorObject() override;

  MonitorObject(const MonitorObject& other) = default;
  MonitorObject(MonitorObject&& other) /*noexcept*/ = default;
  MonitorObject& operator=(const MonitorObject& other) = default;
  MonitorObject& operator=(MonitorObject&& other) /*noexcept*/ = default;

  const std::string getName() const;

  const char* GetName() const override;

  const std::string getFullName() const { return getTaskName() + "/" + getName(); }

  TObject* getObject() const { return mObject; }

  void setObject(TObject* object) { mObject = object; }

  bool isIsOwner() const { return mIsOwner; }

  void setIsOwner(bool isOwner) { mIsOwner = isOwner; }

  const std::string& getTaskName() const { return mTaskName; }
  void setTaskName(const std::string& taskName) { mTaskName = taskName; }

  const std::string& getDetectorName() const { return mDetectorName; }
  void setDetectorName(const std::string& detectorName) { mDetectorName = detectorName; }

  void addMetadata(std::string key, std::string value);
  void addMetadata(std::map<std::string, std::string> pairs);
  void updateMetadata(std::string key, std::string value);
  const std::map<std::string, std::string>& getMetadataMap() const;
  void addOrUpdateMetadata(std::string key, std::string value);

  void Draw(Option_t* option) override;
  TObject* DrawClone(Option_t* option) const override;

  std::string getPath() const;

  const std::string& getDescription() const;
  void setDescription(const std::string& description);

 private:
  TObject* mObject;
  std::string mTaskName;
  std::string mDetectorName;
  std::map<std::string, std::string> mUserMetadata;
  std::string mDescription;

  // indicates that we are the owner of mObject. It is the case by default. It is not the case when a task creates the
  // object.
  // TODO : maybe we should always be the owner ?
  bool mIsOwner;

  ClassDefOverride(MonitorObject, 7);
};

} // namespace o2::quality_control::core

#endif // QC_CORE_MONITOROBJECT_H