Logo ROOT  

Reference Guide
 
Loading...
Searching...
No Matches
List of all members | Public Member Functions | Private Attributes | Static Private Attributes | List of all members
ROOT::Experimental::Detail::RNTuplePerfCounter Class Referenceabstract
RNTuple-related classes

A performance counter with a name and a unit, which can be activated on demand.

Derived classes decide on the counter type and implement printing of the value.

Definition at line 52 of file RNTupleMetrics.hxx.

Public Member Functions

 RNTuplePerfCounter (const std::string &name, const std::string &unit, const std::string &desc)
 
virtual ~RNTuplePerfCounter ()
 
void Enable ()
 
const std::string & GetDescription () const
 
const std::string & GetName () const
 
const std::string & GetUnit () const
 
virtual std::int64_t GetValueAsInt () const =0
 
virtual std::string GetValueAsString () const =0
 
bool IsEnabled () const
 
std::string ToString () const
 

Private Attributes

std::string fDescription
 
bool fIsEnabled = false
 
std::string fName
 
std::string fUnit
 

Static Private Attributes

static constexpr char kFieldSeperator = '|'
 Symbol to split name, unit, description, and value when printing.
 

#include <ROOT/RNTupleMetrics.hxx>

Inheritance diagram for ROOT::Experimental::Detail::RNTuplePerfCounter:
[legend]

Constructor & Destructor Documentation

◆ RNTuplePerfCounter()

ROOT::Experimental::Detail::RNTuplePerfCounter::RNTuplePerfCounter ( const std::string & name,
const std::string & unit,
const std::string & desc )
inline

Definition at line 63 of file RNTupleMetrics.hxx.

◆ ~RNTuplePerfCounter()

ROOT::Experimental::Detail::RNTuplePerfCounter::~RNTuplePerfCounter ( )
virtual

Definition at line 22 of file RNTupleMetrics.cxx.

Member Function Documentation

◆ Enable()

void ROOT::Experimental::Detail::RNTuplePerfCounter::Enable ( )
inline

Definition at line 66 of file RNTupleMetrics.hxx.

◆ GetDescription()

const std::string & ROOT::Experimental::Detail::RNTuplePerfCounter::GetDescription ( ) const
inline

Definition at line 69 of file RNTupleMetrics.hxx.

◆ GetName()

const std::string & ROOT::Experimental::Detail::RNTuplePerfCounter::GetName ( ) const
inline

Definition at line 68 of file RNTupleMetrics.hxx.

◆ GetUnit()

const std::string & ROOT::Experimental::Detail::RNTuplePerfCounter::GetUnit ( ) const
inline

Definition at line 70 of file RNTupleMetrics.hxx.

◆ GetValueAsInt()

virtual std::int64_t ROOT::Experimental::Detail::RNTuplePerfCounter::GetValueAsInt ( ) const
pure virtual

Implemented in ROOT::Experimental::Detail::RNTupleTickCounter< ROOT::Experimental::Detail::RNTupleAtomicCounter >, ROOT::Experimental::Detail::RNTupleTickCounter< ROOT::Experimental::Detail::RNTuplePlainCounter >, ROOT::Experimental::Detail::RNTuplePlainCounter, ROOT::Experimental::Detail::RNTupleAtomicCounter, and ROOT::Experimental::Detail::RNTupleCalcPerf.

◆ GetValueAsString()

virtual std::string ROOT::Experimental::Detail::RNTuplePerfCounter::GetValueAsString ( ) const
pure virtual

Implemented in ROOT::Experimental::Detail::RNTupleTickCounter< ROOT::Experimental::Detail::RNTupleAtomicCounter >, ROOT::Experimental::Detail::RNTupleTickCounter< ROOT::Experimental::Detail::RNTuplePlainCounter >, ROOT::Experimental::Detail::RNTuplePlainCounter, ROOT::Experimental::Detail::RNTupleAtomicCounter, and ROOT::Experimental::Detail::RNTupleCalcPerf.

◆ IsEnabled()

bool ROOT::Experimental::Detail::RNTuplePerfCounter::IsEnabled ( ) const
inline

Definition at line 67 of file RNTupleMetrics.hxx.

◆ ToString()

std::string ROOT::Experimental::Detail::RNTuplePerfCounter::ToString ( ) const

Definition at line 26 of file RNTupleMetrics.cxx.

Member Data Documentation

◆ fDescription

std::string ROOT::Experimental::Detail::RNTuplePerfCounter::fDescription
private

Definition at line 59 of file RNTupleMetrics.hxx.

◆ fIsEnabled

bool ROOT::Experimental::Detail::RNTuplePerfCounter::fIsEnabled = false
private

Definition at line 60 of file RNTupleMetrics.hxx.

◆ fName

std::string ROOT::Experimental::Detail::RNTuplePerfCounter::fName
private

Definition at line 57 of file RNTupleMetrics.hxx.

◆ fUnit

std::string ROOT::Experimental::Detail::RNTuplePerfCounter::fUnit
private

Definition at line 58 of file RNTupleMetrics.hxx.

◆ kFieldSeperator

constexpr char ROOT::Experimental::Detail::RNTuplePerfCounter::kFieldSeperator = '|'
staticconstexprprivate

Symbol to split name, unit, description, and value when printing.

Definition at line 55 of file RNTupleMetrics.hxx.

Libraries for ROOT::Experimental::Detail::RNTuplePerfCounter:
[legend]
The documentation for this class was generated from the following files: