Limits measurement data from any source to a user-defined timewindow. More...

Public Member Functions
void	guiConfig () override
	ImGui config window which is shown on double click.

TimeWindow &	operator= (const TimeWindow &)=delete
	Copy assignment operator.

TimeWindow &	operator= (TimeWindow &&)=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.

	TimeWindow ()
	Default constructor.

	TimeWindow (const TimeWindow &)=delete
	Copy Constructor.

	TimeWindow (TimeWindow &&)=delete
	Move Constructor.

std::string	type () const override
	String representation of the Class Type.

	~TimeWindow () override
	Destructor.

Public Member Functions inherited from NAV::Node
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 Member Functions
void	afterCreateLink (OutputPin &startPin, InputPin &endPin) override
	Called when a new link was established.

void	afterDeleteLink (OutputPin &startPin, InputPin &endPin) override
	Called when a link was deleted.

bool	initialize () override
	Initialize the node.

void	receiveObs (InputPin::NodeDataQueue &queue, size_t pinIdx)
	Callback when receiving data on a port.

Private Attributes
bool	_inverseWindow
	If true, the window lets only times pass through, which are out of the time frame.

std::array< InsTime, 2 >	_startEndTime
	Beginning and end of the time window.

std::array< gui::widgets::TimeEditFormat, 2 >	_timeEditFormat
	Time edit format for start and end times.

Static Private Attributes
static constexpr size_t	INPUT_PORT_INDEX_FLOW
	Flow.

static constexpr size_t	OUTPUT_PORT_INDEX_FLOW
	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

Limits measurement data from any source to a user-defined timewindow.

Definition at line 27 of file TimeWindow.hpp.

Constructor & Destructor Documentation

◆ TimeWindow() [1/3]

NAV::TimeWindow::TimeWindow ( )

Default constructor.

Definition at line 21 of file TimeWindow.cpp.

◆ ~TimeWindow()

NAV::TimeWindow::~TimeWindow ( )

override

Destructor.

Definition at line 32 of file TimeWindow.cpp.

◆ TimeWindow() [2/3]

NAV::TimeWindow::TimeWindow ( const TimeWindow & )

delete

Copy Constructor.

◆ TimeWindow() [3/3]

NAV::TimeWindow::TimeWindow ( TimeWindow && )

delete

Move Constructor.

Member Function Documentation

◆ afterCreateLink()

void NAV::TimeWindow::afterCreateLink	(	OutputPin &	startPin,
		InputPin &	endPin )

overrideprivatevirtual

Called when a new link was established.

Parameters

[in]	startPin	Pin where the link starts
[in]	endPin	Pin where the link ends

Reimplemented from NAV::Node.

Definition at line 127 of file TimeWindow.cpp.

◆ afterDeleteLink()

void NAV::TimeWindow::afterDeleteLink	(	OutputPin &	startPin,
		InputPin &	endPin )

overrideprivatevirtual

Called when a link was deleted.

Parameters

[in]	startPin	Pin where the link starts
[in]	endPin	Pin where the link ends

Reimplemented from NAV::Node.

Definition at line 170 of file TimeWindow.cpp.

◆ category()

std::string NAV::TimeWindow::category ( )

staticnodiscard

String representation of the Class Category.

Definition at line 47 of file TimeWindow.cpp.

◆ guiConfig()

void NAV::TimeWindow::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 52 of file TimeWindow.cpp.

◆ initialize()

bool NAV::TimeWindow::initialize ( )

overrideprivatevirtual

Initialize the node.

Reimplemented from NAV::Node.

Definition at line 114 of file TimeWindow.cpp.

◆ operator=() [1/2]

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

delete

Copy assignment operator.

◆ operator=() [2/2]

TimeWindow & NAV::TimeWindow::operator= ( TimeWindow && )

delete

Move assignment operator.

◆ receiveObs()

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

private

Callback when receiving data on a port.

Parameters

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

Definition at line 183 of file TimeWindow.cpp.

◆ restore()

void NAV::TimeWindow::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 96 of file TimeWindow.cpp.

◆ save()

json NAV::TimeWindow::save ( ) const

nodiscardoverridevirtual

Saves the node into a json object.

Reimplemented from NAV::Node.

Definition at line 83 of file TimeWindow.cpp.

◆ type()

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

nodiscardoverridevirtual

String representation of the Class Type.

Implements NAV::Node.

Definition at line 42 of file TimeWindow.cpp.

◆ typeStatic()

std::string NAV::TimeWindow::typeStatic ( )

staticnodiscard

String representation of the Class Type.

Definition at line 37 of file TimeWindow.cpp.

Field Documentation

◆ _inverseWindow

bool NAV::TimeWindow::_inverseWindow

private

If true, the window lets only times pass through, which are out of the time frame.

Definition at line 92 of file TimeWindow.hpp.

◆ _startEndTime

std::array<InsTime, 2> NAV::TimeWindow::_startEndTime

private

Beginning and end of the time window.

Definition at line 86 of file TimeWindow.hpp.

◆ _timeEditFormat

std::array<gui::widgets::TimeEditFormat, 2> NAV::TimeWindow::_timeEditFormat

private

Time edit format for start and end times.

Definition at line 89 of file TimeWindow.hpp.

◆ INPUT_PORT_INDEX_FLOW

size_t NAV::TimeWindow::INPUT_PORT_INDEX_FLOW

staticconstexprprivate

Flow.

Definition at line 65 of file TimeWindow.hpp.

◆ OUTPUT_PORT_INDEX_FLOW

size_t NAV::TimeWindow::OUTPUT_PORT_INDEX_FLOW

staticconstexprprivate

Flow.

Definition at line 64 of file TimeWindow.hpp.

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

/home/runner/work/INSTINCT/INSTINCT/src/Nodes/Utility/TimeWindow.hpp
/home/runner/work/INSTINCT/INSTINCT/src/Nodes/Utility/TimeWindow.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TimeWindow() [1/3]

◆ ~TimeWindow()

◆ TimeWindow() [2/3]

◆ TimeWindow() [3/3]

Member Function Documentation

◆ afterCreateLink()

◆ afterDeleteLink()

◆ category()

◆ guiConfig()

◆ initialize()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ receiveObs()

◆ restore()

◆ save()

◆ type()

◆ typeStatic()

Field Documentation

◆ _inverseWindow

◆ _startEndTime

◆ _timeEditFormat

◆ INPUT_PORT_INDEX_FLOW

◆ OUTPUT_PORT_INDEX_FLOW