This class provides an in‐core value‐semantic representation of a group of metric record values.

Synopsis

Declared in <balm_metricsample.h>

class MetricSampleGroup;

Description

This class contains the address of an array of (externally managed) MetricRecord objects, the number of records in that array, and an elapsed time value (used to indicate the time span over which the metric values were aggregated).

Type Aliases

Name

Description

const_iterator

A const_iterator is an alias for an iterator over the non‐modifiable records referenced in a MetricSampleGroup.

Member Functions

Name

Description

MetricSampleGroup [constructor]

Constructors

operator=

Assign to this sample group the value of the specified rhs sample group, and return a reference to this modifiable sample group.

begin

Return an iterator positioned at the beginning of the sequence of MetricRecord objects referenced by this object.

elapsedTime

Return a reference to the non‐modifiable elapsed time interval over which this object's metric records were aggregated.

end

Return an iterator positioned one past the final MetricRecord object in the sequence of records referenced by this object.

numRecords

Return the number of records (referenced to by records()) in this object.

print

Format this object to the specified output stream.

records

Return the address of the contiguous sequence of non‐modifiable records of length numRecords().

setElapsedTime

Set the elapsed time (used to indicate the time span over which this object's metric records were aggregated) to the specified elapsedTime.

setRecords

Set the sequence of records referred to by this sample group to the specified sequence of records of specified length numRecords.

Non-Member Functions

Name

Description

operator!=

Return true if the specified lhs and rhs sample groups do not have the same value, and false otherwise.

operator==

Return true if the specified lhs and rhs sample groups have the same value, and false otherwise.

Created with MrDocs