This class provides an in‐core value‐semantic representation of a group of metric record values. 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).

Synopsis

Declared in <balm_metricsample.h>

class MetricSampleGroup;

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. Note that only the pointer to the MetricRecord array and the length are copied, and not the records themselves.

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 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.

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. The behavior is undefined unless 0 <= numRecords, and records refers to a contiguous sequence of (at least) numRecords. Note that the contents of records is not copied and the supplied array must remain valid for the productive lifetime of this object or until the records are set to a different sequence by calling the setRecords manipulator.

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. Two sample groups do not have the same value if any of the respective record‐sequence addresses, number of records, or elapsed time, are not the same.

operator==

Return true if the specified lhs and rhs sample groups have the same value, and false otherwise. Two sample groups have the same value if the respective record sequence‐addresses, number of records, and elapsed time are the same.

Created with MrDocs