Pressure to height converter. More...

Public Member Functions
void	guiConfig () override
	ImGui config window which is shown on double click.
PressToHgt &	operator= (const PressToHgt &)=delete
	Copy assignment operator.
PressToHgt &	operator= (PressToHgt &&)=delete
	Move assignment operator.
	PressToHgt ()
	Default constructor.
	PressToHgt (const PressToHgt &)=delete
	Copy constructor.
	PressToHgt (PressToHgt &&)=delete
	Move constructor.
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.
	~PressToHgt () 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.
template<std::derived_from< Node > T>
InputPin *	CreateInputPin (const char name, Pin::Type pinType, const std::vector< std::string > &dataIdentifier, void(T::notifyFunc)(const InsTime &, size_t), int idx=-1)
	Create an Input Pin object for data pins. The additional notify function gets called when the connected data was changed and the connected node calls NAV::Node::notifyOutputValueChanged.
InputPin *	CreateInputPin (const char *name, Pin::Type pinType, const std::vector< std::string > &dataIdentifier={}, InputPin::Callback callback=static_cast< InputPin::FlowFirableCallbackFunc >(nullptr), InputPin::FlowFirableCheckFunc firable=nullptr, int priority=0, int idx=-1)
	Create an Input Pin object.
template<std::derived_from< Node > T>
InputPin *	CreateInputPin (const char name, Pin::Type pinType, const std::vector< std::string > &dataIdentifier={}, void(T::callback)(InputPin::NodeDataQueue &, size_t)=nullptr, InputPin::FlowFirableCheckFunc firable=nullptr, int priority=0, int idx=-1)
	Create an Input Pin object.
OutputPin *	CreateOutputPin (const char name, Pin::Type pinType, const std::vector< std::string > &dataIdentifier, OutputPin::PinData data=static_cast< void >(nullptr), int idx=-1)
	Create an Output Pin object.
template<std::derived_from< Node > T>
OutputPin *	CreateOutputPin (const char name, Pin::Type pinType, const std::vector< std::string > &dataIdentifier, std::shared_ptr< const NAV::NodeData >(T::peekPollDataFunc)(size_t, bool)=nullptr, int idx=-1)
	Create an Output Pin object for Flow Pins.
template<std::derived_from< Node > T>
OutputPin *	CreateOutputPin (const char name, Pin::Type pinType, const std::vector< std::string > &dataIdentifier, std::shared_ptr< const NAV::NodeData >(T::pollDataFunc)()=nullptr, int idx=-1)
	Create an Output Pin object for Flow Pins.
bool	DeleteInputPin (size_t pinIndex)
	Deletes the input pin. Invalidates the pin reference given.
bool	DeleteOutputPin (size_t pinIndex)
	Deletes the output pin. Invalidates the pin reference given.
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 class	GravityInput : uint8_t { Manual , Position , COUNT }
	Available options for gravity input. More...

Private Member Functions
void	deinitialize () override
	Deinitialize the node.
bool	initialize () override
	Initialize the node.
void	receiveObs (InputPin::NodeDataQueue &queue, size_t pinIdx)
	Converts the RtklibPosObs into PosVel.

Private Attributes
double	_exponent
	save computations, by storing g * M / R0 / L;
double	_geoidhgt
	Geoid undulation in m.
double	_gravity
	Gravity in m / s²
GravityInput	_gravityInput
	Default gravity input type.
Eigen::Vector3d	_initPos
	Initial position in LLA [deg, deg, m] for the calculation of the local gravity through EGM96.
double	_lapserate
	Temperature lapse rate in K / m.
double	_pressure0
	Pressure at Sea level in hPa.
double	_temp0
	Temperature at Sea level in deg K.

Static Private Attributes
static constexpr size_t	INPUT_PORT_INDEX_POS
	Flow.
static constexpr size_t	OUTPUT_PORT_INDEX_BAROHEIGHT
	Flow.

Friends
constexpr const char *	to_string (GravityInput value)
	Converts the enum to a string.

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

Pressure to height converter.

Definition at line 23 of file PressToHgt.hpp.

Member Enumeration Documentation

◆ GravityInput

enum class NAV::PressToHgt::GravityInput : uint8_t

strongprivate

Available options for gravity input.

Enumerator
Manual	Manual entry of the gravity's magnitude.
Position	Entry of the position, gravity is then deducted from EGM96.
COUNT	Number of items in the enum.

Definition at line 92 of file PressToHgt.hpp.

Constructor & Destructor Documentation

◆ PressToHgt() [1/3]

NAV::PressToHgt::PressToHgt ( )

Default constructor.

Definition at line 25 of file PressToHgt.cpp.

◆ ~PressToHgt()

NAV::PressToHgt::~PressToHgt ( )

override

Destructor.

Definition at line 37 of file PressToHgt.cpp.

◆ PressToHgt() [2/3]

NAV::PressToHgt::PressToHgt ( const PressToHgt & )

delete

Copy constructor.

◆ PressToHgt() [3/3]

NAV::PressToHgt::PressToHgt ( PressToHgt && )

delete

Move constructor.

Member Function Documentation

◆ category()

std::string NAV::PressToHgt::category ( )

staticnodiscard

String representation of the Class Category.

Definition at line 52 of file PressToHgt.cpp.

◆ deinitialize()

void NAV::PressToHgt::deinitialize ( )

overrideprivatevirtual

Deinitialize the node.

Reimplemented from NAV::Node.

Definition at line 118 of file PressToHgt.cpp.

◆ guiConfig()

void NAV::PressToHgt::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 57 of file PressToHgt.cpp.

◆ initialize()

bool NAV::PressToHgt::initialize ( )

overrideprivatevirtual

Initialize the node.

Reimplemented from NAV::Node.

Definition at line 106 of file PressToHgt.cpp.

◆ operator=() [1/2]

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

delete

Copy assignment operator.

◆ operator=() [2/2]

PressToHgt & NAV::PressToHgt::operator= ( PressToHgt && )

delete

Move assignment operator.

◆ receiveObs()

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

private

Converts the RtklibPosObs into PosVel.

Parameters

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

Definition at line 173 of file PressToHgt.cpp.

◆ restore()

void NAV::PressToHgt::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 139 of file PressToHgt.cpp.

◆ save()

json NAV::PressToHgt::save ( ) const

nodiscardoverridevirtual

Saves the node into a json object.

Reimplemented from NAV::Node.

Definition at line 123 of file PressToHgt.cpp.

◆ type()

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

nodiscardoverridevirtual

String representation of the Class Type.

Implements NAV::Node.

Definition at line 47 of file PressToHgt.cpp.

◆ typeStatic()

std::string NAV::PressToHgt::typeStatic ( )

staticnodiscard

String representation of the Class Type.

Definition at line 42 of file PressToHgt.cpp.

◆ to_string

const char * to_string ( GravityInput value )

friend

Converts the enum to a string.

Parameters

[in] value Enum value to convert into text

Returns: String representation of the enum

Definition at line 111 of file PressToHgt.hpp.

Field Documentation

◆ _exponent

double NAV::PressToHgt::_exponent

private

save computations, by storing g * M / R0 / L;

Definition at line 86 of file PressToHgt.hpp.

◆ _geoidhgt

double NAV::PressToHgt::_geoidhgt

private

Geoid undulation in m.

Definition at line 81 of file PressToHgt.hpp.

◆ _gravity

double NAV::PressToHgt::_gravity

private

Gravity in m / s²

Definition at line 83 of file PressToHgt.hpp.

◆ _gravityInput

GravityInput NAV::PressToHgt::_gravityInput

private

Default gravity input type.

Definition at line 100 of file PressToHgt.hpp.

◆ _initPos

Eigen::Vector3d NAV::PressToHgt::_initPos

private

Initial position in LLA [deg, deg, m] for the calculation of the local gravity through EGM96.

Definition at line 89 of file PressToHgt.hpp.

◆ _lapserate

double NAV::PressToHgt::_lapserate

private

Temperature lapse rate in K / m.

Definition at line 79 of file PressToHgt.hpp.

◆ _pressure0

double NAV::PressToHgt::_pressure0

private

Pressure at Sea level in hPa.

Definition at line 77 of file PressToHgt.hpp.

◆ _temp0

double NAV::PressToHgt::_temp0

private

Temperature at Sea level in deg K.

Definition at line 75 of file PressToHgt.hpp.

◆ INPUT_PORT_INDEX_POS

size_t NAV::PressToHgt::INPUT_PORT_INDEX_POS

staticconstexprprivate

Flow.

Definition at line 61 of file PressToHgt.hpp.

◆ OUTPUT_PORT_INDEX_BAROHEIGHT

size_t NAV::PressToHgt::OUTPUT_PORT_INDEX_BAROHEIGHT

staticconstexprprivate

Flow.

Definition at line 60 of file PressToHgt.hpp.

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

/home/runner/work/INSTINCT/INSTINCT/src/Nodes/DataProcessor/Barometer/PressToHgt.hpp
/home/runner/work/INSTINCT/INSTINCT/src/Nodes/DataProcessor/Barometer/PressToHgt.cpp

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ GravityInput

Constructor & Destructor Documentation

◆ PressToHgt() [1/3]

◆ ~PressToHgt()

◆ PressToHgt() [2/3]

◆ PressToHgt() [3/3]

Member Function Documentation

◆ category()

◆ deinitialize()

◆ guiConfig()

◆ initialize()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ receiveObs()

◆ restore()

◆ save()

◆ type()

◆ typeStatic()

Friends And Related Symbol Documentation

◆ to_string

Field Documentation

◆ _exponent

◆ _geoidhgt

◆ _gravity

◆ _gravityInput

◆ _initPos

◆ _lapserate

◆ _pressure0

◆ _temp0

◆ INPUT_PORT_INDEX_POS

◆ OUTPUT_PORT_INDEX_BAROHEIGHT