Data Logger for WiFiObs observations. More...

Public Member Functions
void	flush () override
	Function called by the flow executer after finishing to flush out remaining data.
void	guiConfig () override
	ImGui config window which is shown on double click.
WiFiObsLogger &	operator= (const WiFiObsLogger &)=delete
	Copy assignment operator.
WiFiObsLogger &	operator= (WiFiObsLogger &&)=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.
	WiFiObsLogger ()
	Default constructor.
	WiFiObsLogger (const WiFiObsLogger &)=delete
	Copy constructor.
	WiFiObsLogger (WiFiObsLogger &&)=delete
	Move constructor.
	~WiFiObsLogger () 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.
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.
Public Member Functions inherited from NAV::FileWriter
	FileWriter (const FileWriter &)=delete
	Copy constructor.
	FileWriter (FileWriter &&)=delete
	Move constructor.
FileWriter &	operator= (const FileWriter &)=delete
	Copy assignment operator.
FileWriter &	operator= (FileWriter &&)=delete
	Move assignment operator.
	~FileWriter ()=default
	Destructor.
Public Member Functions inherited from NAV::CommonLog
	CommonLog (CommonLog &&)=delete
	Move constructor.
	CommonLog (const CommonLog &)=delete
	Copy constructor.
void	initialize () const
	Initialize the common log variables.
CommonLog &	operator= (CommonLog &&)=delete
	Move assignment operator.
CommonLog &	operator= (const CommonLog &)=delete
	Copy assignment operator.
virtual	~CommonLog ()
	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.
Static Public Member Functions inherited from NAV::FileWriter
static const char *	to_string (FileType type)
	Converts the provided type into string.
Static Public Member Functions inherited from NAV::CommonLog
static LocalPosition	calcLocalPosition (const Eigen::Vector3d &lla_position)
	Calculate the local position offset from a reference point.
static double	calcTimeIntoRun (const InsTime &insTime)
	Calculates the relative time into he run.
static void	restore (const json &j)
	Read info from a json object.
static json	save ()
	Returns a json object of the common log.
static bool	ShowOriginInput (const char *id)
	Shows a GUI to input a origin location.

Private Member Functions
void	deinitialize () override
	Deinitialize the node.
bool	initialize () override
	Initialize the node.
void	writeObservation (InputPin::NodeDataQueue &queue, size_t pinIdx)
	Write Observation to the file.

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 Types inherited from NAV::FileWriter
enum class	FileType : uint8_t { NONE , BINARY , ASCII }
	File Type. 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 Member Functions inherited from NAV::FileWriter
void	deinitialize ()
	Deinitialize the file reader.
	FileWriter ()=default
	Default constructor.
std::filesystem::path	getFilepath ()
	Returns the path of the file.
bool	guiConfig (const char *vFilters, const std::vector< std::string > &extensions, size_t id, const std::string &nameId)
	ImGui config.
bool	initialize ()
	Initialize the file reader.
void	restore (const json &j)
	Restores the node from a json object.
json	save () const
	Saves the node into a json object.
Protected Member Functions inherited from NAV::CommonLog
	CommonLog ()
	Default constructor.
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.
Protected Attributes inherited from NAV::FileWriter
std::ofstream	_filestream
	File stream to write the file.
FileType	_fileType
	File Type.
std::string	_path
	Path to the file.
Static Protected Attributes inherited from NAV::CommonLog
static std::optional< gui::widgets::PositionWithFrame >	_originPosition
	Origin for calculation of relative position.
static InsTime	_startTime
	Start Time for calculation of relative time.
static bool	_useGuiInputs
	Use GUI inputs.

Detailed Description

Data Logger for WiFiObs observations.

Definition at line 25 of file WiFiObsLogger.hpp.

Constructor & Destructor Documentation

◆ WiFiObsLogger() [1/3]

NAV::WiFiObsLogger::WiFiObsLogger ( )

Default constructor.

Definition at line 23 of file WiFiObsLogger.cpp.

◆ ~WiFiObsLogger()

NAV::WiFiObsLogger::~WiFiObsLogger ( )

override

Destructor.

Definition at line 36 of file WiFiObsLogger.cpp.

◆ WiFiObsLogger() [2/3]

NAV::WiFiObsLogger::WiFiObsLogger ( const WiFiObsLogger & )

delete

Copy constructor.

◆ WiFiObsLogger() [3/3]

NAV::WiFiObsLogger::WiFiObsLogger ( WiFiObsLogger && )

delete

Move constructor.

Member Function Documentation

◆ category()

std::string NAV::WiFiObsLogger::category ( )

staticnodiscard

String representation of the Class Category.

Definition at line 51 of file WiFiObsLogger.cpp.

◆ deinitialize()

void NAV::WiFiObsLogger::deinitialize ( )

overrideprivatevirtual

Deinitialize the node.

Reimplemented from NAV::Node.

Definition at line 115 of file WiFiObsLogger.cpp.

◆ flush()

void NAV::WiFiObsLogger::flush ( )

overridevirtual

Function called by the flow executer after finishing to flush out remaining data.

Reimplemented from NAV::Node.

Definition at line 91 of file WiFiObsLogger.cpp.

◆ guiConfig()

void NAV::WiFiObsLogger::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 56 of file WiFiObsLogger.cpp.

◆ initialize()

bool NAV::WiFiObsLogger::initialize ( )

overrideprivatevirtual

Initialize the node.

Reimplemented from NAV::Node.

Definition at line 96 of file WiFiObsLogger.cpp.

◆ operator=() [1/2]

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

delete

Copy assignment operator.

◆ operator=() [2/2]

WiFiObsLogger & NAV::WiFiObsLogger::operator= ( WiFiObsLogger && )

delete

Move assignment operator.

◆ restore()

void NAV::WiFiObsLogger::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 81 of file WiFiObsLogger.cpp.

◆ save()

json NAV::WiFiObsLogger::save ( ) const

nodiscardoverridevirtual

Saves the node into a json object.

Reimplemented from NAV::Node.

Definition at line 70 of file WiFiObsLogger.cpp.

◆ type()

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

nodiscardoverridevirtual

String representation of the Class Type.

Implements NAV::Node.

Definition at line 46 of file WiFiObsLogger.cpp.

◆ typeStatic()

std::string NAV::WiFiObsLogger::typeStatic ( )

staticnodiscard

String representation of the Class Type.

Definition at line 41 of file WiFiObsLogger.cpp.

◆ writeObservation()

void NAV::WiFiObsLogger::writeObservation	(	InputPin::NodeDataQueue &	queue,
		size_t	pinIdx )

private

Write Observation to the file.

Parameters

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

Definition at line 122 of file WiFiObsLogger.cpp.

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

/home/runner/work/INSTINCT/INSTINCT/src/Nodes/DataLogger/WiFi/WiFiObsLogger.hpp
/home/runner/work/INSTINCT/INSTINCT/src/Nodes/DataLogger/WiFi/WiFiObsLogger.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WiFiObsLogger() [1/3]

◆ ~WiFiObsLogger()

◆ WiFiObsLogger() [2/3]

◆ WiFiObsLogger() [3/3]

Member Function Documentation

◆ category()

◆ deinitialize()

◆ flush()

◆ guiConfig()

◆ initialize()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ restore()

◆ save()

◆ type()

◆ typeStatic()

◆ writeObservation()