artdaq_utilities  v1_07_00
artdaq::MetricData Struct Reference

Small structure used to hold a metric data point before sending to the metric plugins More...

#include <artdaq-utilities/Plugins/MetricData.hh>

Classes

union  MetricDataValue
 This union holds the values for all other metric types More...
 

Public Member Functions

 MetricData (const MetricData &r)=default
 Default copy constructor More...
 
 MetricData (MetricData &&r) noexcept=default
 Default move constructor More...
 
MetricDataoperator= (const MetricData &r)=default
 Default copy assignment operator More...
 
MetricDataoperator= (MetricData &&r) noexcept=default
 Default move assignment operator More...
 
 MetricData (std::string const &name, std::string const &value, std::string const &unit, int level, MetricMode mode, std::string const &metricPrefix, bool useNameOverride)
 Construct a MetricData point using a string value More...
 
 MetricData (std::string const &name, int const &value, std::string const &unit, int level, MetricMode mode, std::string const &metricPrefix, bool useNameOverride)
 Construct a MetricData point using a int value More...
 
 MetricData (std::string const &name, double const &value, std::string const &unit, int level, MetricMode mode, std::string const &metricPrefix, bool useNameOverride)
 Construct a MetricData point using a double value More...
 
 MetricData (std::string const &name, float const &value, std::string const &unit, int level, MetricMode mode, std::string const &metricPrefix, bool useNameOverride)
 Construct a MetricData point using a float value More...
 
 MetricData (std::string const &name, uint64_t const &value, std::string const &unit, int level, MetricMode mode, std::string const &metricPrefix, bool useNameOverride)
 Construct a MetricData point using a uint64_t value More...
 
 MetricData ()
 Default constructor, constructs an MetricType::InvalidMetric More...
 
bool Add (MetricData other)
 Add two MetricData instances together More...
 
void AddPoint (int point)
 Add an integer point to this MetricData More...
 
void AddPoint (double point)
 Add a double point to this MetricData More...
 
void AddPoint (float point)
 Add a float point to this MetricData More...
 
void AddPoint (uint64_t point)
 Add an uint64_t point to this MetricData More...
 
void Reset ()
 Reset this MetricData instance to the initial state More...
 

Public Attributes

std::string Name
 Name of the metric More...
 
std::string StringValue
 Value of the metric, if it is a MetricType::StringMetric More...
 
MetricDataValue Value
 Accumulated value of this MetricData More...
 
MetricDataValue Last
 Last value of this MetricData.
 
MetricDataValue Min
 Minimum recorded value of this MetricData.
 
MetricDataValue Max
 Maximum recorded vaule of this MetricData.
 
MetricType Type {MetricType::InvalidMetric}
 Type of the metric More...
 
std::string Unit
 Units of the metric More...
 
int Level
 Reporting level of the metric More...
 
MetricMode Mode
 Accumulation mode of the metric More...
 
std::string MetricPrefix
 Name prefix for the metric More...
 
bool UseNameOverride
 Whether to override the default naming convention for this metric More...
 
size_t DataPointCount {0}
 Number of data points accumulated in this MetricData More...
 

Detailed Description

Small structure used to hold a metric data point before sending to the metric plugins

Definition at line 65 of file MetricData.hh.

Constructor & Destructor Documentation

artdaq::MetricData::MetricData ( const MetricData r)
default

Default copy constructor

Parameters
rMetricData to copy
artdaq::MetricData::MetricData ( MetricData &&  r)
defaultnoexcept

Default move constructor

Parameters
rMetricData to move
artdaq::MetricData::MetricData ( std::string const &  name,
std::string const &  value,
std::string const &  unit,
int  level,
MetricMode  mode,
std::string const &  metricPrefix,
bool  useNameOverride 
)
inline

Construct a MetricData point using a string value

Parameters
nameName of the metric
valueValue of the metric
unitUnits of the metric
levelReporting level of the metric
modeAccumulation mode of the metric
metricPrefixName prefix for the metric
useNameOverrideWhether to override the default name

Definition at line 190 of file MetricData.hh.

artdaq::MetricData::MetricData ( std::string const &  name,
int const &  value,
std::string const &  unit,
int  level,
MetricMode  mode,
std::string const &  metricPrefix,
bool  useNameOverride 
)
inline

Construct a MetricData point using a int value

Parameters
nameName of the metric
valueValue of the metric
unitUnits of the metric
levelReporting level of the metric
modeAccumulation mode of the metric
metricPrefixName prefix for the metric
useNameOverrideWhether to override the default name

Definition at line 204 of file MetricData.hh.

artdaq::MetricData::MetricData ( std::string const &  name,
double const &  value,
std::string const &  unit,
int  level,
MetricMode  mode,
std::string const &  metricPrefix,
bool  useNameOverride 
)
inline

Construct a MetricData point using a double value

Parameters
nameName of the metric
valueValue of the metric
unitUnits of the metric
levelReporting level of the metric
modeAccumulation mode of the metric
metricPrefixName prefix for the metric
useNameOverrideWhether to override the default name

Definition at line 218 of file MetricData.hh.

artdaq::MetricData::MetricData ( std::string const &  name,
float const &  value,
std::string const &  unit,
int  level,
MetricMode  mode,
std::string const &  metricPrefix,
bool  useNameOverride 
)
inline

Construct a MetricData point using a float value

Parameters
nameName of the metric
valueValue of the metric
unitUnits of the metric
levelReporting level of the metric
modeAccumulation mode of the metric
metricPrefixName prefix for the metric
useNameOverrideWhether to override the default name

Definition at line 232 of file MetricData.hh.

artdaq::MetricData::MetricData ( std::string const &  name,
uint64_t const &  value,
std::string const &  unit,
int  level,
MetricMode  mode,
std::string const &  metricPrefix,
bool  useNameOverride 
)
inline

Construct a MetricData point using a uint64_t value

Parameters
nameName of the metric
valueValue of the metric
unitUnits of the metric
levelReporting level of the metric
modeAccumulation mode of the metric
metricPrefixName prefix for the metric
useNameOverrideWhether to override the default name

Definition at line 246 of file MetricData.hh.

artdaq::MetricData::MetricData ( )
inline

Default constructor, constructs an MetricType::InvalidMetric

Definition at line 253 of file MetricData.hh.

Member Function Documentation

bool artdaq::MetricData::Add ( MetricData  other)
inline

Add two MetricData instances together

Parameters
otherMetricData to add to this one
Returns
True if the other MetricData is compatible and was added, false otherwise

Definition at line 261 of file MetricData.hh.

void artdaq::MetricData::AddPoint ( int  point)
inline

Add an integer point to this MetricData

Parameters
pointInt value to add

Definition at line 348 of file MetricData.hh.

void artdaq::MetricData::AddPoint ( double  point)
inline

Add a double point to this MetricData

Parameters
pointDouble value to add

Definition at line 360 of file MetricData.hh.

void artdaq::MetricData::AddPoint ( float  point)
inline

Add a float point to this MetricData

Parameters
pointFloat value to add

Definition at line 372 of file MetricData.hh.

void artdaq::MetricData::AddPoint ( uint64_t  point)
inline

Add an uint64_t point to this MetricData

Parameters
pointuint64_t value to add

Definition at line 384 of file MetricData.hh.

MetricData& artdaq::MetricData::operator= ( const MetricData r)
default

Default copy assignment operator

Parameters
rMetricData to copy
Returns
MetricData copy
MetricData& artdaq::MetricData::operator= ( MetricData &&  r)
defaultnoexcept

Default move assignment operator

Parameters
rMetricData to move
Returns
MetricData reference
void artdaq::MetricData::Reset ( )
inline

Reset this MetricData instance to the initial state

Sets the value, last and count fields to 0, the min to the maximum for the datatype and the max to the minimum for the datatype

Definition at line 398 of file MetricData.hh.

Member Data Documentation

size_t artdaq::MetricData::DataPointCount {0}

Number of data points accumulated in this MetricData

Definition at line 178 of file MetricData.hh.

int artdaq::MetricData::Level

Reporting level of the metric

Definition at line 162 of file MetricData.hh.

std::string artdaq::MetricData::MetricPrefix

Name prefix for the metric

Definition at line 170 of file MetricData.hh.

MetricMode artdaq::MetricData::Mode

Accumulation mode of the metric

Definition at line 166 of file MetricData.hh.

std::string artdaq::MetricData::Name

Name of the metric

Definition at line 96 of file MetricData.hh.

std::string artdaq::MetricData::StringValue

Value of the metric, if it is a MetricType::StringMetric

Definition at line 100 of file MetricData.hh.

MetricType artdaq::MetricData::Type {MetricType::InvalidMetric}

Type of the metric

Definition at line 154 of file MetricData.hh.

std::string artdaq::MetricData::Unit

Units of the metric

Definition at line 158 of file MetricData.hh.

bool artdaq::MetricData::UseNameOverride

Whether to override the default naming convention for this metric

Definition at line 174 of file MetricData.hh.

MetricDataValue artdaq::MetricData::Value

Accumulated value of this MetricData

Definition at line 146 of file MetricData.hh.


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