Trigger/TrigCost/TrigCostAnalysis/src/Variable.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2021 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef TRIGCOSTANALYSIS_VARIABLE_H
#define TRIGCOSTANALYSIS_VARIABLE_H 1
 
#include "GaudiKernel/StatusCode.h"
#include "AthenaBaseComps/AthCheckMacros.h"
 
class TH1; //<! Forward declaration

enum VariableType { 
  kPerCall, 
  kPerEvent 
};

enum LogType { 
  kLinear, 
  kLog  
};

class Variable {
  public:
    Variable() = delete;

    Variable(const std::string& name, TH1* cacheHistoPtr, VariableType type = kPerCall);

    ~Variable() = default;

    Variable& operator=(const Variable&) = delete;

    Variable(const Variable&) = delete;

    const std::string& getName() const;

    size_t getCalls() const;

    float getAccumulator() const;

    StatusCode fill(float value, float weight = 1.0);

    StatusCode fill(float xvalue, float yvalue, float weight);

    StatusCode fill(const std::string& label, float weight = 1.0);

    StatusCode increment(float weight = 1.0);

    StatusCode setBinLabel(int bin, const std::string& label);

    StatusCode setYBinLabel(int bin, const std::string& label);

    void setDenominator(float value);

    StatusCode endEvent();
 
  private:
 
    const std::string m_name; //<! Variable's name
    const VariableType m_variableType; //<! Variable's type enumeration
    TH1* m_cacheHistoPtr; //<! Mutable cached non-owning ptr to this Variable's histogram.
    size_t m_calls; //<! Counter of how many times the Variable is Filled in an event.
    float m_xaccumulator; //<! For per-Event quantities, the accumulator buffers until the final quantity is known.
    float m_yaccumulator; //<! Buffer as xaccumulator, but for y axis, used of 2D histograms
    float m_weight; 
    float m_oneOverDenominator; 
};
 
#endif // TRIGCOSTANALYSIS_VARIABLE_H