This class defines an in‐core value‐semantic type used to identify a metric.

Synopsis

Declared in <balm_metricid.h>

class MetricId;

Description

A MetricId object's value is the address of a non‐modifiable MetricDescription object. In addition, a MetricDescription object provides auxiliary methods, category, categoryName, and name, that enable access to the properties of the held MetricDescription. Two MetricId objects have the same value if the values of their respective MetricDescription object addresses are the same.

Member Functions

Name

Description

MetricId [constructor]

Constructors

category

Return the address of the non‐modifiable Category object identifying the category with which this metric id is associated.

categoryName

Return the address of the non‐modifiable name for the category with which this metric id is associated.

description

description overloads

isValid

Return true if this metric id object contains the address of a valid MetricDescription object, and false otherwise.

metricName

Return the address of the non‐modifiable name of this metric id.

print

Print this metric id to the specified output stream in some single‐line human‐readable form, and return a reference to the modifiable stream.

operator BloombergLP::bslmf::NestedTraitDeclaration<MetricId, is_trivially_copyable>

Declare that this type is trivially copyable.

Non-Member Functions

Name

Description

operator!=

Return true if the specified lhs and rhs metric ids do not have the same value and false otherwise.

operator<

Return true if the specified lhs metric id is less than (ordered before) the specified rhs metric id, and return false otherwise'.

operator==

Return true if the specified lhs and rhs metric ids have the same value and false otherwise.

Created with MrDocs