0.4.1
Loading...
Searching...
No Matches
NAV::NodeData Class Reference

Parent class for all data transmitted over Flow pins. More...

Public Member Functions

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::string getType () const
 Returns the type of the data class.
 
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 > 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

InsTime insTime
 Time at which the message was received.
 

Protected Attributes

std::vector< std::string > _events
 List of events.
 

Detailed Description

Parent class for all data transmitted over Flow pins.

Definition at line 27 of file NodeData.hpp.

Constructor & Destructor Documentation

◆ NodeData() [1/3]

NAV::NodeData::NodeData ( )
default

Default constructor.

◆ ~NodeData()

virtual NAV::NodeData::~NodeData ( )
virtualdefault

Destructor.

◆ NodeData() [2/3]

NAV::NodeData::NodeData ( const NodeData & )
default

Copy constructor.

◆ NodeData() [3/3]

NAV::NodeData::NodeData ( NodeData && )
default

Move constructor.

Member Function Documentation

◆ addEvent()

void NAV::NodeData::addEvent ( const std::string & text)
inline

Adds the event to the list.

Parameters
[in]textEvent text

Definition at line 72 of file NodeData.hpp.

◆ dynamicDataDescriptors()

virtual std::vector< std::string > NAV::NodeData::dynamicDataDescriptors ( ) const
inlinenodiscardvirtual

Returns a vector of data descriptors for the dynamic data.

Reimplemented in NAV::DynamicData, NAV::GnssCombination, NAV::GnssObs, NAV::SppSolution, and NAV::VectorNavBinaryOutput.

Definition at line 92 of file NodeData.hpp.

◆ events()

const std::vector< std::string > & NAV::NodeData::events ( ) const
inlinenodiscard

Returns a vector of string events associated with this data.

Definition at line 68 of file NodeData.hpp.

◆ getDynamicData()

virtual std::vector< std::pair< std::string, double > > NAV::NodeData::getDynamicData ( ) const
inlinenodiscardvirtual

Returns a vector of data descriptors and values for the dynamic data.

Reimplemented in NAV::DynamicData, NAV::GnssCombination, NAV::GnssObs, NAV::SppSolution, and NAV::VectorNavBinaryOutput.

Definition at line 107 of file NodeData.hpp.

◆ getDynamicDataAt()

virtual std::optional< double > NAV::NodeData::getDynamicDataAt ( const std::string & ) const
inlinenodiscardvirtual

Get the value for the descriptor.

Returns
Value if in the observation

Reimplemented in NAV::DynamicData, NAV::GnssCombination, NAV::GnssObs, NAV::SppSolution, and NAV::VectorNavBinaryOutput.

Definition at line 96 of file NodeData.hpp.

◆ GetStaticDataDescriptors()

static std::vector< std::string > NAV::NodeData::GetStaticDataDescriptors ( )
inlinestaticnodiscard

Returns a vector of data descriptors.

Definition at line 56 of file NodeData.hpp.

◆ GetStaticDescriptorCount()

static constexpr size_t NAV::NodeData::GetStaticDescriptorCount ( )
inlinestaticnodiscardconstexpr

Get the amount of descriptors.

Definition at line 59 of file NodeData.hpp.

◆ getType()

◆ getValueAt()

virtual std::optional< double > NAV::NodeData::getValueAt ( size_t ) const
inlinenodiscardvirtual

◆ getValueAtOrNaN()

double NAV::NodeData::getValueAtOrNaN ( size_t idx) const
inlinenodiscard

Get the value at the index or NaN if not in the observation.

Parameters
idxIndex corresponding to data descriptor order
Returns
Value or NaN if not in the observation

Definition at line 89 of file NodeData.hpp.

◆ guiTooltip()

virtual void NAV::NodeData::guiTooltip ( bool detailView,
bool firstOpen,
const char * displayName,
const char * id,
int * rootWindow ) const
inlinevirtual

Shows a GUI tooltip to look into details of the observation.

Parameters
[in]detailViewFlag to show the detailed view
[in]firstOpenFlag whether the tooltip is opened once
[in]displayNameData identifier, can be used in dynamic data to identify the correct data
[in]idUnique identifier
[in]rootWindowPointer to the root window opening the tooltip

Reimplemented in NAV::DynamicData.

Definition at line 115 of file NodeData.hpp.

◆ hasTooltip()

virtual bool NAV::NodeData::hasTooltip ( ) const
inlinenodiscardvirtual

Return whether this data has a tooltip.

Reimplemented in NAV::DynamicData.

Definition at line 120 of file NodeData.hpp.

◆ operator=() [1/2]

NodeData & NAV::NodeData::operator= ( const NodeData & )
default

Copy assignment operator.

◆ operator=() [2/2]

NodeData & NAV::NodeData::operator= ( NodeData && )
default

Move assignment operator.

◆ parentTypes()

static std::vector< std::string > NAV::NodeData::parentTypes ( )
inlinestaticnodiscard

Returns the parent types of the data class.

Returns
The parent data types

Definition at line 53 of file NodeData.hpp.

◆ setDynamicDataAt()

virtual bool NAV::NodeData::setDynamicDataAt ( const std::string & ,
double  )
inlinenodiscardvirtual

Set the value for the descriptor.

Returns
True if the value was updated

Definition at line 100 of file NodeData.hpp.

◆ setValueAt()

virtual bool NAV::NodeData::setValueAt ( size_t ,
double  )
inlinenodiscardvirtual

Set the value at the index.

Returns
True if the value was updated

Reimplemented in NAV::BaroHgt, NAV::BaroPressObs, NAV::ImuObs, NAV::ImuObsSimulated, NAV::ImuObsWDelta, NAV::Pos, NAV::PosVel, and NAV::PosVelAtt.

Definition at line 80 of file NodeData.hpp.

◆ staticDataDescriptors()

virtual std::vector< std::string > NAV::NodeData::staticDataDescriptors ( ) const
inlinenodiscardvirtual

◆ staticDescriptorCount()

virtual size_t NAV::NodeData::staticDescriptorCount ( ) const
inlinenodiscardvirtual

◆ type()

static std::string NAV::NodeData::type ( )
inlinestaticnodiscard

Returns the type of the data class.

Returns
The data type

Definition at line 45 of file NodeData.hpp.

Field Documentation

◆ _events

std::vector<std::string> NAV::NodeData::_events
protected

List of events.

Definition at line 127 of file NodeData.hpp.

◆ insTime

InsTime NAV::NodeData::insTime

Time at which the message was received.

Definition at line 123 of file NodeData.hpp.


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