Delays messages by buffering them. More...

Public Member Functions
	Delay ()
	Default constructor.
	Delay (const Delay &)=delete
	Copy constructor.
	Delay (Delay &&)=delete
	Move constructor.
void	guiConfig () override
	ImGui config window which is shown on double click.
bool	onCreateLink (OutputPin &startPin, InputPin &endPin) override
	Called when a new link is to be established.
Delay &	operator= (const Delay &)=delete
	Copy assignment operator.
Delay &	operator= (Delay &&)=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.
	~Delay () 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.
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 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	deinitialize () override
	Deinitialize the node.
void	delayObs (InputPin::NodeDataQueue &queue, size_t pinIdx)
	Delays the observation.
bool	initialize () override
	Initialize the node.

Private Attributes
std::deque< std::shared_ptr< const NodeData > >	_buffer
	Buffer to delay data.
int	_delayLength
	The amount to delay messages for.

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

Delays messages by buffering them.

Definition at line 25 of file Delay.hpp.

Constructor & Destructor Documentation

◆ Delay() [1/3]

NAV::experimental::Delay::Delay ( )

Default constructor.

Definition at line 20 of file Delay.cpp.

◆ ~Delay()

NAV::experimental::Delay::~Delay ( )

override

Destructor.

Definition at line 33 of file Delay.cpp.

◆ Delay() [2/3]

NAV::experimental::Delay::Delay ( const Delay & )

delete

Copy constructor.

◆ Delay() [3/3]

NAV::experimental::Delay::Delay ( Delay && )

delete

Move constructor.

Member Function Documentation

◆ category()

std::string NAV::experimental::Delay::category ( )

staticnodiscard

String representation of the Class Category.

Definition at line 48 of file Delay.cpp.

◆ deinitialize()

void NAV::experimental::Delay::deinitialize ( )

overrideprivatevirtual

Deinitialize the node.

Reimplemented from NAV::Node.

Definition at line 101 of file Delay.cpp.

◆ delayObs()

void NAV::experimental::Delay::delayObs	(	InputPin::NodeDataQueue &	queue,
		size_t	pinIdx )

private

Delays the observation.

Parameters

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

Definition at line 137 of file Delay.cpp.

◆ guiConfig()

void NAV::experimental::Delay::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 53 of file Delay.cpp.

◆ initialize()

bool NAV::experimental::Delay::initialize ( )

overrideprivatevirtual

Initialize the node.

Reimplemented from NAV::Node.

Definition at line 92 of file Delay.cpp.

◆ onCreateLink()

bool NAV::experimental::Delay::onCreateLink	(	OutputPin &	startPin,
		InputPin &	endPin )

overridevirtual

Called when a new link is to be established.

Parameters

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

Returns: True if link is allowed, false if link is rejected

Reimplemented from NAV::Node.

Definition at line 106 of file Delay.cpp.

◆ operator=() [1/2]

Delay & NAV::experimental::Delay::operator= ( const Delay & )

delete

Copy assignment operator.

◆ operator=() [2/2]

Delay & NAV::experimental::Delay::operator= ( Delay && )

delete

Move assignment operator.

◆ restore()

void NAV::experimental::Delay::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 82 of file Delay.cpp.

◆ save()

json NAV::experimental::Delay::save ( ) const

nodiscardoverridevirtual

Saves the node into a json object.

Reimplemented from NAV::Node.

Definition at line 71 of file Delay.cpp.

◆ type()

std::string NAV::experimental::Delay::type ( ) const

nodiscardoverridevirtual

String representation of the Class Type.

Implements NAV::Node.

Definition at line 43 of file Delay.cpp.

◆ typeStatic()

std::string NAV::experimental::Delay::typeStatic ( )

staticnodiscard

String representation of the Class Type.

Definition at line 38 of file Delay.cpp.

Field Documentation

◆ _buffer

std::deque<std::shared_ptr<const NodeData> > NAV::experimental::Delay::_buffer

private

Buffer to delay data.

Definition at line 86 of file Delay.hpp.

◆ _delayLength

int NAV::experimental::Delay::_delayLength

private

The amount to delay messages for.

Definition at line 83 of file Delay.hpp.

◆ INPUT_PORT_INDEX_FLOW

size_t NAV::experimental::Delay::INPUT_PORT_INDEX_FLOW

staticconstexprprivate

Flow.

Definition at line 69 of file Delay.hpp.

◆ OUTPUT_PORT_INDEX_FLOW

size_t NAV::experimental::Delay::OUTPUT_PORT_INDEX_FLOW

staticconstexprprivate

Flow.

Definition at line 68 of file Delay.hpp.

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

/home/runner/work/INSTINCT/INSTINCT/src/Nodes/Experimental/Simple/Delay.hpp
/home/runner/work/INSTINCT/INSTINCT/src/Nodes/Experimental/Simple/Delay.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Delay() [1/3]

◆ ~Delay()

◆ Delay() [2/3]

◆ Delay() [3/3]

Member Function Documentation

◆ category()

◆ deinitialize()

◆ delayObs()

◆ guiConfig()

◆ initialize()

◆ onCreateLink()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ restore()

◆ save()

◆ type()

◆ typeStatic()

Field Documentation

◆ _buffer

◆ _delayLength

◆ INPUT_PORT_INDEX_FLOW

◆ OUTPUT_PORT_INDEX_FLOW