bdlm::Metric Class Reference

#include <bdlm_metric.h>

Detailed Description

This class provides storage for various types of metric values.

See bdlm_metric

Public Types
typedef double	Gauge

Public Member Functions
	Metric ()
	Metric (const Gauge &value)
	~Metric ()=default
Metric &	operator= (const Gauge &value)
bool	isGauge () const
const Gauge &	theGauge () const

Friends
bool	operator== (const Metric &lhs, const Metric &rhs)
bool	operator!= (const Metric &lhs, const Metric &rhs)

Member Typedef Documentation

Gauge

typedef double bdlm::Metric::Gauge

Constructor & Destructor Documentation

Metric() [1/2]

bdlm::Metric::Metric ( )

inline

Create a default (empty) metric.

Metric() [2/2]

bdlm::Metric::Metric ( const Gauge &  value )

inlineexplicit

Create a metric with the specified value.

~Metric()

bdlm::Metric::~Metric ( )

default

Member Function Documentation

isGauge()

bool bdlm::Metric::isGauge ( ) const

inline

Return true if the value of this metric is of gauge type, and false otherwise.

operator=()

Metric & bdlm::Metric::operator= ( const Gauge &  value )

inline

Assign to this metric the specified value.

theGauge()

const Metric::Gauge & bdlm::Metric::theGauge ( ) const

inline

Return a const reference to the value of this metric of gauge type.

Precondition

The behavior is undefined unless true == isGuage().

Friends And Related Symbol Documentation

operator!=

bool operator!= ( const Metric &  lhs, const Metric &  rhs  )

friend

Return true if the specified lhs command-line metric has a different value from the specified rhs command-line metric, and false otherwise. Two Metric objects do not have the same value if their types are not the same or they have different values.

operator==

bool operator== ( const Metric &  lhs, const Metric &  rhs  )

friend

Return true if the specified lhs and rhs have the same value, and false otherwise. Two Metric objects have the same value if their types are the same and they have the same value.

---

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

• bdlm_metric.h