Kvh Observation storage Class. More...

Public Member Functions
std::string	getType () const override
	Returns the type of the data class.

std::optional< double >	getValueAt (size_t idx) const override
	Get the value at the index.

	KvhObs (const ImuPos &imuPos)
	Constructor.

	KvhObs (const ImuPos &imuPos, uart::protocol::Packet &packet)
	Constructor.

std::vector< std::string >	staticDataDescriptors () const override
	Returns a vector of data descriptors.

size_t	staticDescriptorCount () const override
	Get the amount of descriptors.

Public Member Functions inherited from NAV::ImuObs
	ImuObs (const ImuPos &imuPos)
	Constructor.

bool	setValueAt (size_t idx, double value) override
	Set the value at the index.

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.

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	~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.

Static Public Member Functions inherited from NAV::ImuObs
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.

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
uart::protocol::Packet	raw
	Complete message raw binary data including header and checksum.

uint8_t	sequenceNumber
	Increments for each message and resets to 0 after 127.

std::bitset< 8 >	status
	Status Byte.

Data Fields inherited from NAV::ImuObs
const ImuPos &	imuPos
	Position and rotation information for conversion from platform to body frame.

Eigen::Vector3d	p_acceleration
	The IMU acceleration measured in units of [m/s^2], given in the platform frame.

Eigen::Vector3d	p_angularRate
	The IMU angular rate measured in units of [rad/s], given in the platform frame.

std::optional< Eigen::Vector3d >	p_magneticField
	The IMU magnetic field measured in units of [Gauss], given in the platform frame.

std::optional< double >	temperature
	The IMU temperature measured in units of [Celsius].

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

Kvh Observation storage Class.

Definition at line 23 of file KvhObs.hpp.

Constructor & Destructor Documentation

◆ KvhObs() [1/2]

NAV::KvhObs::KvhObs	(	const ImuPos &	imuPos,
		uart::protocol::Packet &	packet )

inline

Constructor.

Parameters

[in]	imuPos	Reference to the position and rotation info of the Imu
[in]	packet	The packet to copy into the raw data

Definition at line 29 of file KvhObs.hpp.

◆ KvhObs() [2/2]

NAV::KvhObs::KvhObs ( const ImuPos & imuPos )

inlineexplicit

Constructor.

Parameters

[in] imuPos Reference to the position and rotation info of the Imu

Definition at line 34 of file KvhObs.hpp.

Member Function Documentation

◆ GetStaticDataDescriptors()

static std::vector< std::string > NAV::KvhObs::GetStaticDataDescriptors ( )

inlinestaticnodiscard

Returns a vector of data descriptors.

Definition at line 56 of file KvhObs.hpp.

◆ GetStaticDescriptorCount()

static constexpr size_t NAV::KvhObs::GetStaticDescriptorCount ( )

inlinestaticnodiscardconstexpr

Get the amount of descriptors.

Definition at line 65 of file KvhObs.hpp.

◆ getType()

std::string NAV::KvhObs::getType ( ) const

inlinenodiscardoverridevirtual

Returns the type of the data class.

Returns: The data type

Reimplemented from NAV::ImuObs.

Definition at line 46 of file KvhObs.hpp.

◆ getValueAt()

std::optional< double > NAV::KvhObs::getValueAt ( size_t idx ) const

inlinenodiscardoverridevirtual

Get the value at the index.

Parameters

idx	Index corresponding to data descriptor order

Returns: Value if in the observation

Reimplemented from NAV::ImuObs.

Definition at line 76 of file KvhObs.hpp.

◆ parentTypes()

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

inlinestaticnodiscard

Returns the parent types of the data class.

Returns: The parent data types

Definition at line 50 of file KvhObs.hpp.

◆ staticDataDescriptors()

std::vector< std::string > NAV::KvhObs::staticDataDescriptors ( ) const

inlinenodiscardoverridevirtual

Returns a vector of data descriptors.

Reimplemented from NAV::ImuObs.

Definition at line 68 of file KvhObs.hpp.

◆ staticDescriptorCount()

size_t NAV::KvhObs::staticDescriptorCount ( ) const

inlinenodiscardoverridevirtual

Get the amount of descriptors.

Reimplemented from NAV::ImuObs.

Definition at line 71 of file KvhObs.hpp.

◆ type()

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

inlinestaticnodiscard

Returns the type of the data class.

Returns: The data type

Definition at line 39 of file KvhObs.hpp.

Field Documentation

◆ raw

uart::protocol::Packet NAV::KvhObs::raw

Complete message raw binary data including header and checksum.

Definition at line 94 of file KvhObs.hpp.

◆ sequenceNumber

uint8_t NAV::KvhObs::sequenceNumber

Increments for each message and resets to 0 after 127.

Definition at line 110 of file KvhObs.hpp.

◆ status

std::bitset<8> NAV::KvhObs::status

Status Byte.

Definition at line 107 of file KvhObs.hpp.

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

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

Public Member Functions

Static Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KvhObs() [1/2]

◆ KvhObs() [2/2]

Member Function Documentation

◆ GetStaticDataDescriptors()

◆ GetStaticDescriptorCount()

◆ getType()

◆ getValueAt()

◆ parentTypes()

◆ staticDataDescriptors()

◆ staticDescriptorCount()

◆ type()

Field Documentation

◆ raw

◆ sequenceNumber

◆ status