0.5.0
Loading...
Searching...
No Matches
NAV::WiFiObs Class Reference

Espressif Observation Class. More...

Data Structures

struct  TimeSyncInput
 Struct for time sync. More...

Public Member Functions

std::string getType () const override
 Returns the type of the data class.
Public Member Functions inherited from NAV::NodeData
void addEvent (const std::string &text)
 Adds the event to the list.
virtual std::vector< std::string > dynamicDataDescriptors () const
 Returns a vector of data descriptors for the dynamic data.
const std::vector< std::string > & events () const
 Returns a vector of string events associated with this data.
virtual std::vector< std::pair< std::string, double > > getDynamicData () const
 Returns a vector of data descriptors and values for the dynamic data.
virtual std::optional< double > getDynamicDataAt (const std::string &) const
 Get the value for the descriptor.
virtual std::optional< double > getValueAt (size_t) const
 Get the value at the index.
double getValueAtOrNaN (size_t idx) const
 Get the value at the index or NaN if not in the observation.
virtual void guiTooltip (bool detailView, bool firstOpen, const char *displayName, const char *id, int *rootWindow) const
 Shows a GUI tooltip to look into details of the observation.
virtual bool hasTooltip () const
 Return whether this data has a tooltip.
 NodeData ()=default
 Default constructor.
 NodeData (const NodeData &)=default
 Copy constructor.
 NodeData (NodeData &&)=default
 Move constructor.
NodeDataoperator= (const NodeData &)=default
 Copy assignment operator.
NodeDataoperator= (NodeData &&)=default
 Move assignment operator.
virtual bool setDynamicDataAt (const std::string &, double)
 Set the value for the descriptor.
virtual bool setValueAt (size_t, double)
 Set the value at the index.
virtual std::vector< std::string > staticDataDescriptors () const
 Returns a vector of data descriptors.
virtual size_t staticDescriptorCount () const
 Get the amount of descriptors.
virtual ~NodeData ()=default
 Destructor.

Static Public Member Functions

static std::vector< std::string > parentTypes ()
 Returns the parent types of the data class.
static std::string type ()
 Returns the type of the data class.
Static Public Member Functions inherited from NAV::NodeData
static std::vector< std::string > GetStaticDataDescriptors ()
 Returns a vector of data descriptors.
static constexpr size_t GetStaticDescriptorCount ()
 Get the amount of descriptors.
static std::vector< std::string > parentTypes ()
 Returns the parent types of the data class.
static std::string type ()
 Returns the type of the data class.

Data Fields

double distance
 Distance to the device.
double distanceStd
 Standard deviation of the distance.
std::string macAddress
 MAC address of the device.
TimeSyncInput timeOutputs
 Time of observation.
Data Fields inherited from NAV::NodeData
InsTime insTime
 Time at which the message was received.

Additional Inherited Members

Protected Attributes inherited from NAV::NodeData
std::vector< std::string > _events
 List of events.

Detailed Description

Espressif Observation Class.

Definition at line 22 of file WiFiObs.hpp.

Member Function Documentation

◆ getType()

std::string NAV::WiFiObs::getType ( ) const
inlinenodiscardoverridevirtual

Returns the type of the data class.

Returns
The data type

Reimplemented from NAV::NodeData.

Definition at line 34 of file WiFiObs.hpp.

◆ parentTypes()

std::vector< std::string > NAV::WiFiObs::parentTypes ( )
inlinestaticnodiscard

Returns the parent types of the data class.

Returns
The parent data types

Definition at line 38 of file WiFiObs.hpp.

◆ type()

std::string NAV::WiFiObs::type ( )
inlinestaticnodiscard

Returns the type of the data class.

Returns
The data type

Definition at line 27 of file WiFiObs.hpp.

Field Documentation

◆ distance

double NAV::WiFiObs::distance

Distance to the device.

Definition at line 46 of file WiFiObs.hpp.

◆ distanceStd

double NAV::WiFiObs::distanceStd

Standard deviation of the distance.

Definition at line 48 of file WiFiObs.hpp.

◆ macAddress

std::string NAV::WiFiObs::macAddress

MAC address of the device.

Definition at line 44 of file WiFiObs.hpp.

◆ timeOutputs

TimeSyncInput NAV::WiFiObs::timeOutputs

Time of observation.

Definition at line 62 of file WiFiObs.hpp.


The documentation for this class was generated from the following file:
  • /home/runner/work/INSTINCT/INSTINCT/src/NodeData/WiFi/WiFiObs.hpp