artdaq_core  v3_05_00
artdaq::StatisticsCollection Class Reference

A collection of MonitoredQuantity instances describing low-level statistics of the artdaq system. More...

#include <artdaq-core/Core/StatisticsCollection.hh>

Public Member Functions

virtual ~StatisticsCollection () noexcept
 StatisticsCollection Destructor.
 
void addMonitoredQuantity (const std::string &name, MonitoredQuantityPtr mqPtr)
 Registers a new MonitoredQuantity to be tracked by the StatisticsCollection. More...
 
MonitoredQuantityPtr getMonitoredQuantity (const std::string &name) const
 Lookup and return a MonitoredQuantity from the StatisticsCollection. More...
 
void reset ()
 Reset all MonitoredQuantity object in this StatisticsCollection.
 
void requestStop ()
 Stops the statistics calculation thread.
 
void run ()
 Start the background thread that performs MonitoredQuantity statistics calculation.
 

Static Public Member Functions

static StatisticsCollectiongetInstance ()
 Returns the singleton instance of the StatisticsCollection. More...
 

Detailed Description

A collection of MonitoredQuantity instances describing low-level statistics of the artdaq system.

A collection of MonitoredQuantity instances describing low-level statistics of the artdaq system. Periodically (default 1s) calculates statistics for each MonitoredQuantity instance.

Definition at line 23 of file StatisticsCollection.hh.

Member Function Documentation

void artdaq::StatisticsCollection::addMonitoredQuantity ( const std::string &  name,
MonitoredQuantityPtr  mqPtr 
)

Registers a new MonitoredQuantity to be tracked by the StatisticsCollection.

Parameters
nameName of the MonitoredQuantity (used for lookup)
mqPtrshared_ptr to MonitoredQuantity

Definition at line 35 of file StatisticsCollection.cc.

StatisticsCollection & artdaq::StatisticsCollection::getInstance ( )
static

Returns the singleton instance of the StatisticsCollection.

Returns
StatisticsCollection instance.

Definition at line 6 of file StatisticsCollection.cc.

MonitoredQuantityPtr artdaq::StatisticsCollection::getMonitoredQuantity ( const std::string &  name) const

Lookup and return a MonitoredQuantity from the StatisticsCollection.

Parameters
nameName of the MonitoredQuantity
Returns
MonitoredQuantityPtr (nullptr if not found in StatisticsCollection)

Definition at line 43 of file StatisticsCollection.cc.


The documentation for this class was generated from the following files: