[#BloombergLP-balm-MetricSampleGroup]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balm.adoc[balm]::MetricSampleGroup
:relfileprefix: ../../
:mrdocs:

This class provides an _in&hyphen;core_ value&hyphen;semantic representation of a group of metric record values&period;

== Synopsis

Declared in `&lt;balm&lowbar;metricsample&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
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)&period;

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balm/MetricSampleGroup/const_iterator.adoc[`const&lowbar;iterator`] 
| A `const&lowbar;iterator` is an alias for an iterator over the non&hyphen;modifiable records referenced in a `MetricSampleGroup`&period;
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balm/MetricSampleGroup/2constructor-0f.adoc[`MetricSampleGroup`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/balm/MetricSampleGroup/operator_assign.adoc[`operator&equals;`] 
| Assign to this sample group the value of the specified `rhs` sample group, and return a reference to this modifiable sample group&period;
| xref:BloombergLP/balm/MetricSampleGroup/begin.adoc[`begin`] 
| Return an iterator positioned at the beginning of the sequence of `MetricRecord` objects referenced by this object&period;
| xref:BloombergLP/balm/MetricSampleGroup/elapsedTime.adoc[`elapsedTime`] 
| Return a reference to the non&hyphen;modifiable elapsed time interval over which this object&apos;s metric records were aggregated&period;
| xref:BloombergLP/balm/MetricSampleGroup/end.adoc[`end`] 
| Return an iterator positioned one past the final `MetricRecord` object in the sequence of records referenced by this object&period;
| xref:BloombergLP/balm/MetricSampleGroup/numRecords.adoc[`numRecords`] 
| Return the number of records (referenced to by `records()`) in this object&period;
| xref:BloombergLP/balm/MetricSampleGroup/print.adoc[`print`] 
| Format this object to the specified output stream&period;
| xref:BloombergLP/balm/MetricSampleGroup/records.adoc[`records`] 
| Return the address of the contiguous sequence of non&hyphen;modifiable records of length `numRecords()`&period;
| xref:BloombergLP/balm/MetricSampleGroup/setElapsedTime.adoc[`setElapsedTime`] 
| Set the elapsed time (used to indicate the time span over which this object&apos;s metric records were aggregated) to the specified `elapsedTime`&period;
| xref:BloombergLP/balm/MetricSampleGroup/setRecords.adoc[`setRecords`] 
| Set the sequence of records referred to by this sample group to the specified sequence of `records` of specified length `numRecords`&period;
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balm/operator_not_eq-095.adoc[`operator!&equals;`]
| Return `true` if the specified `lhs` and `rhs` sample groups do not have the same value, and `false` otherwise&period;
| xref:BloombergLP/balm/operator_eq-08.adoc[`operator&equals;&equals;`]
| Return `true` if the specified `lhs` and `rhs` sample groups have the same value, and `false` otherwise&period;
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#
