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...

MetricData &	operator= (const MetricData &r)=default
	Default copy assignment operator More...

MetricData &	operator= (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, long unsigned int const &value, std::string const &unit, int level, MetricMode mode, std::string const &metricPrefix, bool useNameOverride)
	Construct a MetricData point using a unsigned long int 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 (unsigned long int point)
	Add an unsigned int point to this MetricData 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
	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
	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 64 of file MetricData.hh.

Constructor & Destructor Documentation

artdaq::MetricData::MetricData ( const MetricData & r )

default

Default copy constructor

Parameters

r	MetricData to copy

artdaq::MetricData::MetricData ( MetricData && r )

defaultnoexcept

Default move constructor

Parameters

r	MetricData 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

name	Name of the metric
value	Value of the metric
unit	Units of the metric
level	Reporting level of the metric
mode	Accumulation mode of the metric
metricPrefix	Name prefix for the metric
useNameOverride	Whether to override the default name

Definition at line 189 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

name	Name of the metric
value	Value of the metric
unit	Units of the metric
level	Reporting level of the metric
mode	Accumulation mode of the metric
metricPrefix	Name prefix for the metric
useNameOverride	Whether to override the default name

Definition at line 203 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

name	Name of the metric
value	Value of the metric
unit	Units of the metric
level	Reporting level of the metric
mode	Accumulation mode of the metric
metricPrefix	Name prefix for the metric
useNameOverride	Whether to override the default name

Definition at line 217 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

name	Name of the metric
value	Value of the metric
unit	Units of the metric
level	Reporting level of the metric
mode	Accumulation mode of the metric
metricPrefix	Name prefix for the metric
useNameOverride	Whether to override the default name

Definition at line 231 of file MetricData.hh.

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

inline

Construct a MetricData point using a unsigned long int value

Parameters

name	Name of the metric
value	Value of the metric
unit	Units of the metric
level	Reporting level of the metric
mode	Accumulation mode of the metric
metricPrefix	Name prefix for the metric
useNameOverride	Whether to override the default name

Definition at line 245 of file MetricData.hh.

artdaq::MetricData::MetricData ( )

inline

Default constructor, constructs an MetricType::InvalidMetric

Definition at line 252 of file MetricData.hh.

Member Function Documentation

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

inline

Add two MetricData instances together

Parameters

other MetricData to add to this one

Returns: True if the other MetricData is compatible and was added, false otherwise

Definition at line 260 of file MetricData.hh.

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

inline

Add an integer point to this MetricData

Parameters

point Int value to add

Definition at line 306 of file MetricData.hh.

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

inline

Add a double point to this MetricData

Parameters

point Double value to add

Definition at line 318 of file MetricData.hh.

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

inline

Add a float point to this MetricData

Parameters

point Float value to add

Definition at line 330 of file MetricData.hh.

void artdaq::MetricData::AddPoint ( unsigned long int point )

inline

Add an unsigned int point to this MetricData

Parameters

point Unsigned int value to add

Definition at line 342 of file MetricData.hh.

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

default

Default copy assignment operator

Parameters

r	MetricData to copy

Returns: MetricData copy

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

defaultnoexcept

Default move assignment operator

Parameters

r	MetricData to move

Returns: MetricData reference

Member Data Documentation

size_t artdaq::MetricData::DataPointCount

Number of data points accumulated in this MetricData

Definition at line 177 of file MetricData.hh.

int artdaq::MetricData::Level

Reporting level of the metric

Definition at line 161 of file MetricData.hh.

std::string artdaq::MetricData::MetricPrefix

Name prefix for the metric

Definition at line 169 of file MetricData.hh.

MetricMode artdaq::MetricData::Mode

Accumulation mode of the metric

Definition at line 165 of file MetricData.hh.

std::string artdaq::MetricData::Name

Name of the metric

Definition at line 95 of file MetricData.hh.

std::string artdaq::MetricData::StringValue

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

Definition at line 99 of file MetricData.hh.

MetricType artdaq::MetricData::Type

Type of the metric

Definition at line 153 of file MetricData.hh.

std::string artdaq::MetricData::Unit

Units of the metric

Definition at line 157 of file MetricData.hh.

bool artdaq::MetricData::UseNameOverride

Whether to override the default naming convention for this metric

Definition at line 173 of file MetricData.hh.

MetricDataValue artdaq::MetricData::Value

Accumulated value of this MetricData

Definition at line 145 of file MetricData.hh.

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

artdaq_utilities/artdaq-utilities/Plugins/MetricData.hh

Classes

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation