0.3.0
Loading...
Searching...
No Matches
NAV::PressToHgt Class Reference

Pressure to height converter. More...

Public Member Functions

void guiConfig () override
 ImGui config window which is shown on double click.
 
PressToHgtoperator= (const PressToHgt &)=delete
 Copy assignment operator.
 
PressToHgtoperator= (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.
 
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.
 
InputPininputPinFromId (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.
 
Nodeoperator= (const Node &)=delete
 Copy assignment operator.
 
Nodeoperator= (Node &&)=delete
 Move assignment operator.
 
OutputPinoutputPinFromId (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...
 
- Public Attributes inherited from NAV::Node
bool callbacksEnabled
 Enables the callbacks.
 
ax::NodeEditor::NodeId id
 Unique Id of the Node.
 
std::vector< InputPininputPins
 List of input pins.
 
Kind kind
 Kind of the Node.
 
std::string name
 Name of the Node.
 
std::vector< OutputPinoutputPins
 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.

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.

Member Function Documentation

◆ deinitialize()

void NAV::PressToHgt::deinitialize ( )
overrideprivatevirtual

Deinitialize the node.

Reimplemented from NAV::Node.

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

◆ initialize()

bool NAV::PressToHgt::initialize ( )
overrideprivatevirtual

Initialize the node.

Reimplemented from NAV::Node.

◆ receiveObs()

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

Converts the RtklibPosObs into PosVel.

Parameters
[in]queueQueue with all the received data messages
[in]pinIdxIndex of the pin the data is received on

◆ restore()

void NAV::PressToHgt::restore ( const json & j)
overridevirtual

Restores the node from a json object.

Parameters
[in]jJson object with the node state

Reimplemented from NAV::Node.

◆ save()

json NAV::PressToHgt::save ( ) const
nodiscardoverridevirtual

Saves the node into a json object.

Reimplemented from NAV::Node.

◆ type()

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

String representation of the Class Type.

Implements NAV::Node.

Friends And Related Symbol Documentation

◆ to_string

const char * to_string ( GravityInput value)
friend

Converts the enum to a string.

Parameters
[in]valueEnum value to convert into text
Returns
String representation of the enum

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