roo_monitoring
API Documentation for roo_monitoring
Loading...
Searching...
No Matches
roo_monitoring::Sample Class Reference

Represents a single data sample stored in a vault file. More...

#include <sample.h>

Public Member Functions

 Sample (uint64_t stream_id, uint16_t avg_value, uint16_t min_value, uint16_t max_value, uint16_t fill)
 Creates a sample with aggregated values.
 
uint64_t stream_id () const
 Returns the stream identifier.
 
uint16_t avg_value () const
 Returns the average value for the bucket.
 
uint16_t min_value () const
 Returns the minimum value for the bucket.
 
uint16_t max_value () const
 Returns the maximum value for the bucket.
 
uint16_t fill () const
 Returns the fill value (0x2000 == 100%).
 

Detailed Description

Represents a single data sample stored in a vault file.

Definition at line 6 of file sample.h.

Constructor & Destructor Documentation

◆ Sample()

roo_monitoring::Sample::Sample ( uint64_t  stream_id,
uint16_t  avg_value,
uint16_t  min_value,
uint16_t  max_value,
uint16_t  fill 
)
inline

Creates a sample with aggregated values.

Definition at line 9 of file sample.h.

Member Function Documentation

◆ avg_value()

uint16_t roo_monitoring::Sample::avg_value ( ) const
inline

Returns the average value for the bucket.

Definition at line 20 of file sample.h.

Referenced by roo_monitoring::Aggregator::add().

◆ fill()

uint16_t roo_monitoring::Sample::fill ( ) const
inline

Returns the fill value (0x2000 == 100%).

Definition at line 26 of file sample.h.

Referenced by roo_monitoring::Aggregator::add().

◆ max_value()

uint16_t roo_monitoring::Sample::max_value ( ) const
inline

Returns the maximum value for the bucket.

Definition at line 24 of file sample.h.

Referenced by roo_monitoring::Aggregator::add().

◆ min_value()

uint16_t roo_monitoring::Sample::min_value ( ) const
inline

Returns the minimum value for the bucket.

Definition at line 22 of file sample.h.

Referenced by roo_monitoring::Aggregator::add().

◆ stream_id()

uint64_t roo_monitoring::Sample::stream_id ( ) const
inline

Returns the stream identifier.

Definition at line 18 of file sample.h.

Referenced by roo_monitoring::Aggregator::add().


The documentation for this class was generated from the following file: