artdaq::PeriodicReportMetric Class Reference

PeriodicReportMetric writes metric data to a file on disk. More...

Inheritance diagram for artdaq::PeriodicReportMetric:
artdaq::MetricPlugin

List of all members.

Public Member Functions

 PeriodicReportMetric (fhicl::ParameterSet const &config, std::string const &app_name)
 PeriodicReportMetric Constructor.
virtual ~PeriodicReportMetric ()
 PeriodicReportMetric Destructor. Calls stopMetrics and then closes the file.
std::string getLibName () const override
 Get the library name for the PeriodicReport metric.
void sendMetric_ (const std::string &name, const std::string &value, const std::string &unit) override
 Write metric data to a file.
void sendMetric_ (const std::string &name, const int &value, const std::string &unit) override
 Write metric data to a file.
void sendMetric_ (const std::string &name, const double &value, const std::string &unit) override
 Write metric data to a file.
void sendMetric_ (const std::string &name, const float &value, const std::string &unit) override
 Write metric data to a file.
void sendMetric_ (const std::string &name, const unsigned long int &value, const std::string &unit) override
 Write metric data to a file.
void startMetrics_ () override
 Perform startup actions.
void stopMetrics_ () override
 Perform shutdown actions.

Detailed Description

PeriodicReportMetric writes metric data to a file on disk.

Definition at line 24 of file report_metric.cc.


Constructor & Destructor Documentation

artdaq::PeriodicReportMetric::PeriodicReportMetric ( fhicl::ParameterSet const &  config,
std::string const &  app_name 
) [inline, explicit]

PeriodicReportMetric Constructor.

Parameters:
config ParameterSet used to configure PeriodicReportMetric
app_name Name of the application sending metrics
		 * PeriodicReportMetric accepts no parameters.
		 * 

Definition at line 42 of file report_metric.cc.


Member Function Documentation

std::string artdaq::PeriodicReportMetric::getLibName (  )  const [inline, override, virtual]

Get the library name for the PeriodicReport metric.

Returns:
The library name for the PeriodicReport metric, "report"

Reimplemented from artdaq::MetricPlugin.

Definition at line 61 of file report_metric.cc.

void artdaq::PeriodicReportMetric::sendMetric_ ( const std::string &  name,
const unsigned long int &  value,
const std::string &  unit 
) [inline, override]

Write metric data to a file.

Parameters:
name Name of the metric
value Value of the metric
unit Units of the metric

Definition at line 117 of file report_metric.cc.

void artdaq::PeriodicReportMetric::sendMetric_ ( const std::string &  name,
const float &  value,
const std::string &  unit 
) [inline, override, virtual]

Write metric data to a file.

Parameters:
name Name of the metric
value Value of the metric
unit Units of the metric

Implements artdaq::MetricPlugin.

Definition at line 106 of file report_metric.cc.

void artdaq::PeriodicReportMetric::sendMetric_ ( const std::string &  name,
const double &  value,
const std::string &  unit 
) [inline, override, virtual]

Write metric data to a file.

Parameters:
name Name of the metric
value Value of the metric
unit Units of the metric

Implements artdaq::MetricPlugin.

Definition at line 95 of file report_metric.cc.

void artdaq::PeriodicReportMetric::sendMetric_ ( const std::string &  name,
const int &  value,
const std::string &  unit 
) [inline, override, virtual]

Write metric data to a file.

Parameters:
name Name of the metric
value Value of the metric
unit Units of the metric

Implements artdaq::MetricPlugin.

Definition at line 84 of file report_metric.cc.

void artdaq::PeriodicReportMetric::sendMetric_ ( const std::string &  name,
const std::string &  value,
const std::string &  unit 
) [inline, override, virtual]

Write metric data to a file.

Parameters:
name Name of the metric
value Value of the metric
unit Units of the metric

Implements artdaq::MetricPlugin.

Definition at line 69 of file report_metric.cc.


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

Generated on 4 Feb 2019 for artdaq_utilities by  doxygen 1.6.1