QualityControl  1.5.1
O2 Data Quality Control Framework
Public Member Functions | List of all members
o2::quality_control::core::MonitorObject Class Reference

This class keeps the meta data about one published object. More...

#include <MonitorObject.h>

Inheritance diagram for o2::quality_control::core::MonitorObject:
Collaboration diagram for o2::quality_control::core::MonitorObject:

Public Member Functions

 MonitorObject ()
 Default constructor.
 
 MonitorObject (TObject *object, const std::string &taskName, const std::string &detectorName="DET")
 
 ~MonitorObject () override
 Destructor.
 
 MonitorObject (const MonitorObject &other)=default
 Copy constructor.
 
 MonitorObject (MonitorObject &&other)=default
 Move constructor.
 
MonitorObject & operator= (const MonitorObject &other)=default
 Copy assignment operator.
 
MonitorObject & operator= (MonitorObject &&other)=default
 Move assignment operator.
 
const std::string getName () const
 Return the name of the encapsulated object (if any). More...
 
const char * GetName () const override
 Overwrite the TObject's method just to avoid confusion. More...
 
const std::string getFullName () const
 Return joined task name and name of the encapsulated object (if any). More...
 
TObject * getObject () const
 
void setObject (TObject *object)
 
bool isIsOwner () const
 
void setIsOwner (bool isOwner)
 
const std::string & getTaskName () const
 
void setTaskName (const std::string &taskName)
 
const std::string & getDetectorName () const
 
void setDetectorName (const std::string &detectorName)
 
void addMetadata (std::string key, std::string value)
 Add key value pair that will end up in the database as metadata of the object Add a metadata (key value pair) to the MonitorObject. It will be stored in the database as metadata. If the key already exists the value will NOT be updated.
 
void addMetadata (std::map< std::string, std::string > pairs)
 Add key value pairs that will end up in the database as metadata of the object Add all the key-value pairs in the map to the MonitorObject. It will be stored in the database as metadata. If a key already exists the value will NOT be updated.
 
void updateMetadata (std::string key, std::string value)
 Update the value of metadata. If the key does not exist it will ignore it.
 
const std::map< std::string, std::string > & getMetadataMap () const
 Get the full map of user's metadata.
 
void addOrUpdateMetadata (std::string key, std::string value)
 Update the value of metadata or add it if it does not exist yet.
 
void Draw (Option_t *option) override
 
TObject * DrawClone (Option_t *option) const override
 
std::string getPath () const
 Build the path to this object. Build the path to this object as it will appear in the GUI. More...
 
const std::string & getDescription () const
 
void setDescription (const std::string &description)
 

Detailed Description

This class keeps the meta data about one published object.

Author
Barthelemy von Haller

Member Function Documentation

const std::string o2::quality_control::core::MonitorObject::getFullName ( ) const
inline

Return joined task name and name of the encapsulated object (if any).

Returns
The name as "{getTaskName()}/{getName())}.
const std::string o2::quality_control::core::MonitorObject::getName ( ) const

Return the name of the encapsulated object (if any).

Returns
The name of the encapsulated object or "" if there is no object.
const char * o2::quality_control::core::MonitorObject::GetName ( ) const
override

Overwrite the TObject's method just to avoid confusion.

Returns
The name of the encapsulated object or "" if there is no object.
std::string o2::quality_control::core::MonitorObject::getPath ( ) const

Build the path to this object. Build the path to this object as it will appear in the GUI.

Returns
A string containing the path.
The documentation for this class was generated from the following files: