artdaq::StatisticsCollection Class Reference

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

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

List of all members.

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.
MonitoredQuantityPtr getMonitoredQuantity (const std::string &name) const
 Lookup and return a MonitoredQuantity from the StatisticsCollection.
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.

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:
name Name of the MonitoredQuantity (used for lookup)
mqPtr shared_ptr to MonitoredQuantity

Definition at line 25 of file StatisticsCollection.cc.

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

Returns the singleton instance of the StatisticsCollection.

Returns:
StatisticsCollection instance.

Definition at line 5 of file StatisticsCollection.cc.

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

Lookup and return a MonitoredQuantity from the StatisticsCollection.

Parameters:
name Name of the MonitoredQuantity
Returns:
MonitoredQuantityPtr (nullptr if not found in StatisticsCollection)

Definition at line 33 of file StatisticsCollection.cc.


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

Generated on 4 May 2018 for artdaq_core by  doxygen 1.6.1