NAV::InputPin::IncomingLink Struct Reference

Collection of information about the connected node and pin. More...

Data Structures
class	ValueWrapper
	Value wrapper, automatically incrementing and decrementing the data access counter. More...

Public Member Functions
OutputPin *	getConnectedPin () const
	Returns a pointer to the pin which is connected to this one.
template<typename T>
std::optional< ValueWrapper< T > >	getValue () const
	Get the value connected on the pin if the pin is connected. Automatically increments the data access counter to prevent editing.
	IncomingLink ()=default
	Default Constructor.
	IncomingLink (ax::NodeEditor::LinkId linkId, Node *connectedNode, ax::NodeEditor::PinId connectedPinId)
	Constructor.

Additional Inherited Members
Data Fields inherited from NAV::Pin::Link
Node *	connectedNode
	Pointer to the node, which is connected to this pin.
ax::NodeEditor::PinId	connectedPinId
	Id of the pin, which is connected to this pin.
ax::NodeEditor::LinkId	linkId
	Unique id of the link.
Protected Member Functions inherited from NAV::Pin::Link
	Link ()=default
	Default Constructor.
	Link (ax::NodeEditor::LinkId linkId, Node *connectedNode, ax::NodeEditor::PinId connectedPinId)
	Constructor.

Detailed Description

Collection of information about the connected node and pin.

Definition at line 564 of file Pin.hpp.

Constructor & Destructor Documentation

IncomingLink() [1/2]

NAV::InputPin::IncomingLink::IncomingLink ( )

default

Default Constructor.

IncomingLink() [2/2]

NAV::InputPin::IncomingLink::IncomingLink ( ax::NodeEditor::LinkId linkId, Node * connectedNode, ax::NodeEditor::PinId connectedPinId )

inline

Constructor.

Parameters

[in]	linkId	Unique id of the link
[in]	connectedNode	Node connected on the other end of the link
[in]	connectedPinId	Id of the pin, which is connected on the other end of the link

Definition at line 573 of file Pin.hpp.

Member Function Documentation

getConnectedPin()

NAV::OutputPin * NAV::InputPin::IncomingLink::getConnectedPin ( ) const

nodiscard

Returns a pointer to the pin which is connected to this one.

Definition at line 438 of file Pin.cpp.

getValue()

template<typename T>

std::optional< ValueWrapper< T > > NAV::InputPin::IncomingLink::getValue ( ) const

inlinenodiscard

Get the value connected on the pin if the pin is connected. Automatically increments the data access counter to prevent editing.

Template Parameters

T	Type of the connected object

Returns

ValueWrapper with a const pointer to the connected data

Definition at line 666 of file Pin.hpp.

---

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

• /home/runner/work/INSTINCT/INSTINCT/src/internal/Node/Pin.hpp
• /home/runner/work/INSTINCT/INSTINCT/src/internal/Node/Pin.cpp