This class provides a value‐semantic representation of the formatting specification for a metric aggregate value. The scale() is a multiplier used to scale the numeric value. The format() is a printf‐style format string suitable for formatting a single floating‐point value.

Synopsis

Declared in <balm_metricformat.h>

class MetricFormatSpec;

Member Functions

Name

Description

MetricFormatSpec [constructor]

Constructors

operator=

Assign to this format spec the value of the specified rhs format spec, and return a reference to this modifiable format spec.

format

Return the address of the null‐terminated string containing the printf‐style format that may be used to format values.

print

Format this object to the specified output stream at the (absolute value of) the optionally specified indentation level and return a reference to stream. If level is specified, optionally specify spacesPerLevel, the number of spaces per indentation level for this and all of its nested objects. If level is negative, suppress indentation of the first line. If spacesPerLevel is negative, format the entire output on one line, suppressing all but the initial indentation (as governed by level). If stream is not valid on entry, this operation has no effect.

scale

Return the floating‐point multiplier value that may be applied to scale formatted values.

setFormat

Set, to the specified format, the printf‐style formatting string that may be applied when formatting values. The behavior is undefined unless format is null‐terminated, contains a printf‐style format string valid for a single floating‐point value, and remains valid and unmodified for the lifetime of this object.

setScale

Set, to the specified scale, the scale multiplier that may be applied when formatting values.

Static Member Functions

Name

Description

formatValue

Write the specified value to the specified stream using the specified format, and return a reference to the modifiable stream.

Non-Member Functions

Name

Description

operator!=

Return true if the specified lhs and rhs metric format specs do not have the same value, and false otherwise. Two format specs do not have same value if they differ in their respective values for scale or format attributes.

operator==

Return true if the specified lhs and rhs metric format specs have the same value, and false otherwise. Two format specs have the same value if they have the same values for their scale and format attributes, respectively.

Created with MrDocs