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.

NodeData &	operator= (const NodeData &)=default
	Copy assignment operator.

NodeData &	operator= (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.

Public Attributes
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.

Member Function Documentation

◆ addEvent()

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

inline

Adds the event to the list.

Parameters

[in] text Event text

◆ 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, and NAV::SppSolution.

◆ 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, and NAV::SppSolution.

◆ 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, and NAV::SppSolution.

◆ getType()

virtual std::string NAV::NodeData::getType ( ) const

inlinenodiscardvirtual

Returns the type of the data class.

Returns: The data type

Reimplemented in NAV::DynamicData, NAV::EmlidObs, NAV::GnssCombination, NAV::GnssObs, NAV::ImuObs, NAV::ImuObsSimulated, NAV::ImuObsWDelta, NAV::InsGnssLCKFSolution, NAV::InsGnssTCKFSolution, NAV::KvhObs, NAV::Pos, NAV::PosVel, NAV::PosVelAtt, NAV::RtklibPosObs, NAV::SppSolution, NAV::StringObs, NAV::UartPacket, NAV::UbloxObs, NAV::VectorNavBinaryOutput, NAV::WiFiObs, and NAV::WiFiPositioningSolution.

◆ getValueAt()

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

inlinenodiscardvirtual

Get the value at the index.

Returns: Value if in the observation

Reimplemented in NAV::ImuObs, NAV::ImuObsSimulated, NAV::ImuObsWDelta, NAV::InsGnssLCKFSolution, NAV::InsGnssTCKFSolution, NAV::KvhObs, NAV::Pos, NAV::PosVel, NAV::PosVelAtt, NAV::RtklibPosObs, NAV::SppSolution, NAV::VectorNavBinaryOutput, and NAV::WiFiPositioningSolution.

◆ getValueAtOrNaN()

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

inlinenodiscard

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

Parameters

idx	Index corresponding to data descriptor order

Returns: Value or NaN if not in the observation

◆ 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]	detailView	Flag to show the detailed view
[in]	firstOpen	Flag whether the tooltip is opened once
[in]	displayName	Data identifier, can be used in dynamic data to identify the correct data
[in]	id	Unique identifier
[in]	rootWindow	Pointer to the root window opening the tooltip

Reimplemented in NAV::DynamicData.

◆ hasTooltip()

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

inlinenodiscardvirtual

Return whether this data has a tooltip.

Reimplemented in NAV::DynamicData.

◆ parentTypes()

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

inlinestaticnodiscard

Returns the parent types of the data class.

Returns: The parent data types

◆ setDynamicDataAt()

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

inlinenodiscardvirtual

Set the value for the descriptor.

Returns: True if the value was updated

◆ 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::ImuObs, NAV::ImuObsSimulated, NAV::ImuObsWDelta, NAV::Pos, NAV::PosVel, and NAV::PosVelAtt.

◆ staticDataDescriptors()

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

inlinenodiscardvirtual

Returns a vector of data descriptors.

Reimplemented in NAV::ImuObs, NAV::ImuObsSimulated, NAV::ImuObsWDelta, NAV::InsGnssLCKFSolution, NAV::InsGnssTCKFSolution, NAV::KvhObs, NAV::Pos, NAV::PosVel, NAV::PosVelAtt, NAV::RtklibPosObs, NAV::SppSolution, NAV::VectorNavBinaryOutput, and NAV::WiFiPositioningSolution.

◆ staticDescriptorCount()

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

inlinenodiscardvirtual

Get the amount of descriptors.

Reimplemented in NAV::ImuObs, NAV::ImuObsSimulated, NAV::ImuObsWDelta, NAV::InsGnssTCKFSolution, NAV::KvhObs, NAV::Pos, NAV::PosVel, NAV::PosVelAtt, NAV::RtklibPosObs, NAV::SppSolution, NAV::VectorNavBinaryOutput, and NAV::WiFiPositioningSolution.

◆ type()

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

inlinestaticnodiscard

Returns the type of the data class.

Returns: The data type

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

/home/runner/work/INSTINCT/INSTINCT/src/NodeData/NodeData.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Member Function Documentation

◆ addEvent()

◆ dynamicDataDescriptors()

◆ getDynamicData()

◆ getDynamicDataAt()

◆ getType()

◆ getValueAt()

◆ getValueAtOrNaN()

◆ guiTooltip()

◆ hasTooltip()

◆ parentTypes()

◆ setDynamicDataAt()

◆ setValueAt()

◆ staticDataDescriptors()

◆ staticDescriptorCount()

◆ type()