HARDT - The Ham Radio DSP Toolkit
Public Member Functions | Public Attributes | List of all members
HMetrics Class Reference

#include <hmetrics.h>

Public Member Functions

 HMetrics ()
 
std::string ToString ()
 

Public Attributes

unsigned long BytesOut
 
unsigned long BytesIn
 
unsigned long BlocksOut
 
unsigned long BlocksIn
 
unsigned long Writes
 
unsigned long Reads
 

Detailed Description

Metrics data.

The metrics is provided by all types derived from HObject , which almost all types are.

Updating the metrics must be done by the implementing class but currently, not all readers and writers do this - however processors do update metrics and since they are the hubs that allows data to flow, measuring metrics there should be sufficient.

Constructor & Destructor Documentation

◆ HMetrics()

HMetrics::HMetrics ( )
inline

Initialize all members of a metrics object

Member Function Documentation

◆ ToString()

std::string HMetrics::ToString ( )
inline

Return a string with the metrics information

Member Data Documentation

◆ BlocksIn

unsigned long HMetrics::BlocksIn

Blocks read from the previous reader

◆ BlocksOut

unsigned long HMetrics::BlocksOut

Blocks written to the next writer

◆ BytesIn

unsigned long HMetrics::BytesIn

Bytes (not samples) read from the previous reader

◆ BytesOut

unsigned long HMetrics::BytesOut

Bytes (not samples) written to the next writer

◆ Reads

unsigned long HMetrics::Reads

How many times Read() was called on the reader

◆ Writes

unsigned long HMetrics::Writes

How many times Write() was called on the writer


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