This class provides a mechanism for describing a metric.

Synopsis

Declared in <balm_metricdescription.h>

class MetricDescription;

Description

A MetricDescription holds the category to which the metric belongs, and a null‐terminated string containing the name of the metric.

Type Aliases

Name

Description

UserDataKey

A key used to refer to a data value associated with a metric.

Member Functions

Name

Description

MetricDescription [constructor]

Create a metric description for the specified category and the specified name.

category

Return the address of the non‐modifiable category object indicating the category of the metric described by this object.

format

Return a shared pointer to the non‐modifiable format for this metric description.

name

Return the address of the non‐modifiable, null‐terminated string containing the name of the described metric.

preferredPublicationType

Return the preferred publication type of this metric.

print

Print the category and name of this metric description.

printDescription

Print the properties of this metric description.

setCategory

Set the category of this metric description to the object at the specified category address.

setFormat

Set the format for this metric description to the specified format.

setName

Set the name of this metric description to the specified name.

setPreferredPublicationType

Set the preferred publication type of this metric to the specified type.

setUserData

Associate the specified value with the specified data key.

userData

Return the non‐modifiable value associated with the specified user‐data key.

Created with MrDocs