This class provides an in-core value-semantic representation of a sample of metric values.
Declared in <balm_metricsample.h>
class MetricSample;The class contains a collection of addresses to (external) MetricRecord objects holding the values for their respective metrics (aggregated over some period of time). The metric records contained by a sample are broken into a series of groups, which are represented by MetricSampleGroup objects. Each group contains a sequence of records and an elapsed time value, indicating the period of time over which those records were taken. This class also provides a timestamp value, used to indicate when the sample was collected. The class provides a method, appendGroups, that appends a group of metric records to the sample. Arrays supplied using appendGroups must be valid for the productive lifetime of the MetricSample object or until they are removed by calling removeAllRecords.
| Name | Description |
|---|---|
const_iterator | A const_iterator is an alias for an iterator over the non-modifiable sample groups contained in a MetricSample. |
| Name | Description |
|---|---|
MetricSample [constructor] | Constructors |
~MetricSample [destructor] | Destroy this metric sample. |
operator= | Assign to this sample the value of the specified rhs sample. |
appendGroup | appendGroup overloads |
begin | Return an iterator positioned at the beginning of the sequence of MetricSampleGroup objects contained by this object. |
end | Return an iterator positioned one past the final MetricSampleGroup object in the sequence of sample groups contained by this object. |
numGroups | Return the number of record groups (i.e., MetricSampleGroup objects) that are contained in this object. |
numRecords | Return the total number of records in this sample (i.e., the sum of the lengths of all the appended record groups). |
print | Format this object to the specified output stream. |
removeAllRecords | Remove all metric records from this sample. |
sampleGroup | Return a reference to the non-modifiable MetricSampleGroup object at the specified index in this sample. |
setTimeStamp | Set the timestamp (used to indicate when the sample was taken) to the specified timeStamp. |
timeStamp | Return a reference to the non-modifiable timestamp for this sample. |
operator BloombergLP::bslmf::NestedTraitDeclaration<MetricSample, UsesBslmaAllocator> | Declare that this type uses a bslma allocator. |
| Name | Description |
|---|---|
BloombergLP::balm::operator== | Return true if the specified lhs and rhs samples have the same value, and false otherwise. |
| Name | Description |
|---|---|
operator!= | Return true if the specified lhs and rhs samples do not have the same value, and false otherwise. |