roo_transceivers
API Documentation for roo_transceivers
Loading...
Searching...
No Matches
roo_transceivers::Measurement Class Reference

Measurement of a quantity at a specific time. More...

#include <measurement.h>

Public Member Functions

 Measurement ()
 
bool isInitial () const
 Returns true if this is the initial/empty measurement.
 
bool isDefined () const
 Returns true if quantity and value are defined.
 
 Measurement (roo_transceivers_Quantity quantity, roo_time::Uptime time, float value=nanf(""))
 
roo_transceivers_Quantity quantity () const
 Returns the quantity type.
 
roo_time::Uptime time () const
 Returns the measurement timestamp.
 
float value () const
 Returns the measurement value.
 
bool isUnknown () const
 Returns true if value is unknown (NaN).
 

Detailed Description

Measurement of a quantity at a specific time.

Definition at line 11 of file measurement.h.

Constructor & Destructor Documentation

◆ Measurement() [1/2]

roo_transceivers::Measurement::Measurement ( )
inline

Definition at line 13 of file measurement.h.

◆ Measurement() [2/2]

roo_transceivers::Measurement::Measurement ( roo_transceivers_Quantity  quantity,
roo_time::Uptime  time,
float  value = nanf("") 
)
inline

Definition at line 27 of file measurement.h.

Member Function Documentation

◆ isDefined()

bool roo_transceivers::Measurement::isDefined ( ) const
inline

Returns true if quantity and value are defined.

Definition at line 22 of file measurement.h.

References quantity_, and roo_transceivers_Quantity_kUnspecifiedQuantity.

◆ isInitial()

bool roo_transceivers::Measurement::isInitial ( ) const
inline

Returns true if this is the initial/empty measurement.

Definition at line 19 of file measurement.h.

References time_micros_.

◆ isUnknown()

bool roo_transceivers::Measurement::isUnknown ( ) const
inline

Returns true if value is unknown (NaN).

Definition at line 46 of file measurement.h.

◆ quantity()

roo_transceivers_Quantity roo_transceivers::Measurement::quantity ( ) const
inline

Returns the quantity type.

Definition at line 35 of file measurement.h.

References quantity_.

Referenced by roo_transceivers::Multiverse::read().

◆ time()

roo_time::Uptime roo_transceivers::Measurement::time ( ) const
inline

Returns the measurement timestamp.

Definition at line 38 of file measurement.h.

References time_micros_.

◆ value()

float roo_transceivers::Measurement::value ( ) const
inline

Returns the measurement value.

Definition at line 43 of file measurement.h.

Field Documentation

◆ quantity_

roo_transceivers_Quantity roo_transceivers::Measurement::quantity_

Definition at line 50 of file measurement.h.

Referenced by isDefined(), and quantity().

◆ time_micros_

uint64_t roo_transceivers::Measurement::time_micros_

Definition at line 51 of file measurement.h.

Referenced by isInitial(), and time().


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