Decrypts Uart packets. More...

Public Member Functions
void	guiConfig () override
	ImGui config window which is shown on double click.
UartPacketConverter &	operator= (const UartPacketConverter &)=delete
	Copy assignment operator.
UartPacketConverter &	operator= (UartPacketConverter &&)=delete
	Move assignment operator.
void	restore (const json &j) override
	Restores the node from a json object.
json	save () const override
	Saves the node into a json object.
std::string	type () const override
	String representation of the Class Type.
	UartPacketConverter ()
	Default constructor.
	UartPacketConverter (const UartPacketConverter &)=delete
	Copy constructor.
	UartPacketConverter (UartPacketConverter &&)=delete
	Move constructor.
	~UartPacketConverter () override
	Destructor.
Public Member Functions inherited from NAV::Node
virtual void	afterCreateLink (OutputPin &startPin, InputPin &endPin)
	Called when a new link was established.
virtual void	afterDeleteLink (OutputPin &startPin, InputPin &endPin)
	Called when a link was deleted.
virtual void	deinitialize ()
	Deinitialize the Node.
bool	doDeinitialize (bool wait=false)
	Asks the node worker to deinitialize the node.
bool	doDisable (bool wait=false)
	Asks the node worker to disable the node.
bool	doEnable ()
	Enable the node.
bool	doInitialize (bool wait=false)
	Asks the node worker to initialize the node.
bool	doReinitialize (bool wait=false)
	Asks the node worker to reinitialize the node.
virtual void	flush ()
	Function called by the flow executer after finishing to flush out remaining data.
template<typename T>
std::optional< InputPin::IncomingLink::ValueWrapper< T > >	getInputValue (size_t portIndex) const
	Get Input Value connected on the pin. Only const data types.
Mode	getMode () const
	Get the current mode of the node.
const ImVec2 &	getSize () const
	Get the size of the node.
State	getState () const
	Get the current state of the node.
bool	hasInputPinWithSameTime (const InsTime &insTime) const
	Checks wether there is an input pin with the same time.
InputPin &	inputPinFromId (ax::NodeEditor::PinId pinId)
	Returns the pin with the given id.
size_t	inputPinIndexFromId (ax::NodeEditor::PinId pinId) const
	Returns the index of the pin.
void	invokeCallbacks (size_t portIndex, const std::shared_ptr< const NodeData > &data)
	Calls all registered callbacks on the specified output port.
bool	isDisabled () const
	Checks if the node is disabled.
bool	isInitialized () const
	Checks if the node is initialized.
bool	isOnlyRealtime () const
	Checks if the node is only working in real time (sensors, network interfaces, ...)
bool	isTransient () const
	Checks if the node is changing its state currently.
std::string	nameId () const
	Node name and id.
	Node (const Node &)=delete
	Copy constructor.
	Node (Node &&)=delete
	Move constructor.
	Node (std::string name)
	Constructor.
void	notifyOutputValueChanged (size_t pinIdx, const InsTime &insTime, const std::scoped_lock< std::mutex > &&guard)
	Notifies connected nodes about the change.
virtual bool	onCreateLink (OutputPin &startPin, InputPin &endPin)
	Called when a new link is to be established.
virtual void	onDeleteLink (OutputPin &startPin, InputPin &endPin)
	Called when a link is to be deleted.
Node &	operator= (const Node &)=delete
	Copy assignment operator.
Node &	operator= (Node &&)=delete
	Move assignment operator.
OutputPin &	outputPinFromId (ax::NodeEditor::PinId pinId)
	Returns the pin with the given id.
size_t	outputPinIndexFromId (ax::NodeEditor::PinId pinId) const
	Returns the index of the pin.
void	releaseInputValue (size_t portIndex)
	Unblocks the connected node. Has to be called when the input value should be released and getInputValue was not called.
std::scoped_lock< std::mutex >	requestOutputValueLock (size_t pinIdx)
	Blocks the thread till the output values was read by all connected nodes.
virtual bool	resetNode ()
	Resets the node. It is guaranteed that the node is initialized when this is called.
virtual void	restoreAtferLink (const json &j)
	Restores link related properties of the node from a json object.
void	wakeWorker ()
	Wakes the worker thread.
virtual	~Node ()
	Destructor.

Static Public Member Functions
static std::string	category ()
	String representation of the Class Category.
static std::string	typeStatic ()
	String representation of the Class Type.
Static Public Member Functions inherited from NAV::Node
static std::string	toString (State state)
	Converts the state into a printable text.

Private Types
enum	OutputType : uint8_t { OutputType_UbloxObs , OutputType_EmlidObs , OutputType_WiFiObs }
	Enum specifying the type of the output message. More...

Private Member Functions
bool	initialize () override
	Initialize the node.
void	receiveObs (InputPin::NodeDataQueue &queue, size_t pinIdx)
	Converts the UartPacket to the selected message type.

Private Attributes
int64_t	_lastSyncInCnt
	Last received syncInCnt.
int64_t	_lastSyncOutCnt
	Last received syncOutCnt.
OutputType	_outputType
	The selected output type in the GUI.
int64_t	_syncInCntCorr
	Corrected SyncIn counter in case of a reset (target)
bool	_syncInPin
	Show the SyncIn Pin.
int64_t	_syncOutCntCorr
	Corrected SyncOut counter in case of a reset (initiator)

Static Private Attributes
static constexpr size_t	INPUT_PORT_INDEX_SYNC_IN
	Flow (SyncIn)
static constexpr size_t	INPUT_PORT_INDEX_UART_PACKET
	Flow (UartPacket)
static constexpr size_t	OUTPUT_PORT_INDEX_CONVERTED
	Flow.

Additional Inherited Members
Public Types inherited from NAV::Node
enum class	Mode : uint8_t { REAL_TIME , POST_PROCESSING }
	Different Modes the Node can work in. More...
enum class	State : uint8_t { Disabled , Deinitialized , DoInitialize , Initializing , Initialized , DoDeinitialize , Deinitializing , DoShutdown , Shutdown }
	Possible states of the node. More...
Data Fields inherited from NAV::Node
bool	callbacksEnabled
	Enables the callbacks.
ax::NodeEditor::NodeId	id
	Unique Id of the Node.
std::vector< InputPin >	inputPins
	List of input pins.
Kind	kind
	Kind of the Node.
std::string	name
	Name of the Node.
std::vector< OutputPin >	outputPins
	List of output pins.
std::multimap< InsTime, std::pair< OutputPin *, size_t > >	pollEvents
	Map with callback events (sorted by time)
Protected Attributes inherited from NAV::Node
ImVec2	_guiConfigDefaultWindowSize
bool	_hasConfig
	Flag if the config window should be shown.
bool	_lockConfigDuringRun
	Lock the config when executing post-processing.
bool	_onlyRealTime
	Whether the node can run in post-processing or only real-time.

Detailed Description

Decrypts Uart packets.

Definition at line 23 of file UartPacketConverter.hpp.

Member Enumeration Documentation

◆ OutputType

enum NAV::UartPacketConverter::OutputType : uint8_t

private

Enum specifying the type of the output message.

Enumerator
OutputType_UbloxObs	Extract UbloxObs data.
OutputType_EmlidObs	Extract EmlidObs data.
OutputType_WiFiObs	Extract WiFiObs data.

Definition at line 65 of file UartPacketConverter.hpp.

Constructor & Destructor Documentation

◆ UartPacketConverter() [1/3]

NAV::UartPacketConverter::UartPacketConverter ( )

Default constructor.

Definition at line 31 of file UartPacketConverter.cpp.

◆ ~UartPacketConverter()

NAV::UartPacketConverter::~UartPacketConverter ( )

override

Destructor.

Definition at line 43 of file UartPacketConverter.cpp.

◆ UartPacketConverter() [2/3]

NAV::UartPacketConverter::UartPacketConverter ( const UartPacketConverter & )

delete

Copy constructor.

◆ UartPacketConverter() [3/3]

NAV::UartPacketConverter::UartPacketConverter ( UartPacketConverter && )

delete

Move constructor.

Member Function Documentation

◆ category()

std::string NAV::UartPacketConverter::category ( )

staticnodiscard

String representation of the Class Category.

Definition at line 58 of file UartPacketConverter.cpp.

◆ guiConfig()

void NAV::UartPacketConverter::guiConfig ( )

overridevirtual

ImGui config window which is shown on double click.

Attention: Don't forget to set _hasConfig to true in the constructor of the node

Reimplemented from NAV::Node.

Definition at line 63 of file UartPacketConverter.cpp.

◆ initialize()

bool NAV::UartPacketConverter::initialize ( )

overrideprivatevirtual

Initialize the node.

Reimplemented from NAV::Node.

Definition at line 182 of file UartPacketConverter.cpp.

◆ operator=() [1/2]

UartPacketConverter & NAV::UartPacketConverter::operator= ( const UartPacketConverter & )

delete

Copy assignment operator.

◆ operator=() [2/2]

UartPacketConverter & NAV::UartPacketConverter::operator= ( UartPacketConverter && )

delete

Move assignment operator.

◆ receiveObs()

void NAV::UartPacketConverter::receiveObs	(	InputPin::NodeDataQueue &	queue,
		size_t	pinIdx )

private

Converts the UartPacket to the selected message type.

Parameters

[in]	queue	Queue with all the received data messages
[in]	pinIdx	Index of the pin the data is received on

Definition at line 194 of file UartPacketConverter.cpp.

◆ restore()

void NAV::UartPacketConverter::restore ( const json & j )

overridevirtual

Restores the node from a json object.

Parameters

[in] j Json object with the node state

Reimplemented from NAV::Node.

Definition at line 145 of file UartPacketConverter.cpp.

◆ save()

json NAV::UartPacketConverter::save ( ) const

nodiscardoverridevirtual

Saves the node into a json object.

Reimplemented from NAV::Node.

Definition at line 133 of file UartPacketConverter.cpp.

◆ type()

std::string NAV::UartPacketConverter::type ( ) const

nodiscardoverridevirtual

String representation of the Class Type.

Implements NAV::Node.

Definition at line 53 of file UartPacketConverter.cpp.

◆ typeStatic()

std::string NAV::UartPacketConverter::typeStatic ( )

staticnodiscard

String representation of the Class Type.

Definition at line 48 of file UartPacketConverter.cpp.

Field Documentation

◆ _lastSyncInCnt

int64_t NAV::UartPacketConverter::_lastSyncInCnt

private

Last received syncInCnt.

Definition at line 79 of file UartPacketConverter.hpp.

◆ _lastSyncOutCnt

int64_t NAV::UartPacketConverter::_lastSyncOutCnt

private

Last received syncOutCnt.

Definition at line 82 of file UartPacketConverter.hpp.

◆ _outputType

OutputType NAV::UartPacketConverter::_outputType

private

The selected output type in the GUI.

Definition at line 73 of file UartPacketConverter.hpp.

◆ _syncInCntCorr

int64_t NAV::UartPacketConverter::_syncInCntCorr

private

Corrected SyncIn counter in case of a reset (target)

Definition at line 88 of file UartPacketConverter.hpp.

◆ _syncInPin

bool NAV::UartPacketConverter::_syncInPin

private

Show the SyncIn Pin.

Definition at line 76 of file UartPacketConverter.hpp.

◆ _syncOutCntCorr

int64_t NAV::UartPacketConverter::_syncOutCntCorr

private

Corrected SyncOut counter in case of a reset (initiator)

Definition at line 85 of file UartPacketConverter.hpp.

◆ INPUT_PORT_INDEX_SYNC_IN

size_t NAV::UartPacketConverter::INPUT_PORT_INDEX_SYNC_IN

staticconstexprprivate

Flow (SyncIn)

Definition at line 62 of file UartPacketConverter.hpp.

◆ INPUT_PORT_INDEX_UART_PACKET

size_t NAV::UartPacketConverter::INPUT_PORT_INDEX_UART_PACKET

staticconstexprprivate

Flow (UartPacket)

Definition at line 61 of file UartPacketConverter.hpp.

◆ OUTPUT_PORT_INDEX_CONVERTED

size_t NAV::UartPacketConverter::OUTPUT_PORT_INDEX_CONVERTED

staticconstexprprivate

Flow.

Definition at line 60 of file UartPacketConverter.hpp.

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

/home/runner/work/INSTINCT/INSTINCT/src/Nodes/Converter/GNSS/UartPacketConverter.hpp
/home/runner/work/INSTINCT/INSTINCT/src/Nodes/Converter/GNSS/UartPacketConverter.cpp

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ OutputType

Constructor & Destructor Documentation

◆ UartPacketConverter() [1/3]

◆ ~UartPacketConverter()

◆ UartPacketConverter() [2/3]

◆ UartPacketConverter() [3/3]

Member Function Documentation

◆ category()

◆ guiConfig()

◆ initialize()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ receiveObs()

◆ restore()

◆ save()

◆ type()

◆ typeStatic()

Field Documentation

◆ _lastSyncInCnt

◆ _lastSyncOutCnt

◆ _outputType

◆ _syncInCntCorr

◆ _syncInPin

◆ _syncOutCntCorr

◆ INPUT_PORT_INDEX_SYNC_IN

◆ INPUT_PORT_INDEX_UART_PACKET

◆ OUTPUT_PORT_INDEX_CONVERTED