Pin.hpp File Reference

Pin class. More...

Go to the source code of this file.

Classes
struct	NAV::InputPin::IncomingLink
	Collection of information about the connected node and pin. More...
class	NAV::InputPin
	Input pins of nodes. More...
struct	NAV::Pin::Kind
	Kind of the Pin (Input/Output) More...
struct	NAV::Pin::Link
	Link between two pins. More...
struct	NAV::OutputPin::OutgoingLink
	Collection of information about the connected node and pin. More...
class	NAV::OutputPin
	Output pins of nodes. More...
class	NAV::Pin
	Pins in the GUI for information exchange. More...
struct	NAV::Pin::Type
	Type of the data on the Pin. More...
class	NAV::InputPin::IncomingLink::ValueWrapper< T >
	Value wrapper, automatically incrementing and decrementing the data access counter. More...

Typedefs
using	json
	json namespace

Functions
void	NAV::from_json (const json &j, InputPin &pin)
	Converts the provided json object into a pin object.
void	NAV::from_json (const json &j, OutputPin &pin)
	Converts the provided json object into a pin object.
constexpr bool	NAV::operator!= (const Pin::Kind &lhs, const Pin::Kind &rhs)
	Inequal compares Pin::Kind values.
constexpr bool	NAV::operator!= (const Pin::Kind &lhs, const Pin::Kind::Value &rhs)
	Inequal compares Pin::Kind values.
constexpr bool	NAV::operator!= (const Pin::Kind::Value &lhs, const Pin::Kind &rhs)
	Inequal compares Pin::Kind values.
constexpr bool	NAV::operator!= (const Pin::Type &lhs, const Pin::Type &rhs)
	Inequal compares Pin::Type values.
constexpr bool	NAV::operator!= (const Pin::Type &lhs, const Pin::Type::Value &rhs)
	Inequal compares Pin::Type values.
constexpr bool	NAV::operator!= (const Pin::Type::Value &lhs, const Pin::Type &rhs)
	Inequal compares Pin::Type values.
constexpr bool	NAV::operator== (const Pin::Kind &lhs, const Pin::Kind &rhs)
	Equal compares Pin::Kind values.
constexpr bool	NAV::operator== (const Pin::Kind &lhs, const Pin::Kind::Value &rhs)
	Equal compares Pin::Kind values.
constexpr bool	NAV::operator== (const Pin::Kind::Value &lhs, const Pin::Kind &rhs)
	Equal compares Pin::Kind values.
constexpr bool	NAV::operator== (const Pin::Type &lhs, const Pin::Type &rhs)
	Equal compares Pin::Type values.
constexpr bool	NAV::operator== (const Pin::Type &lhs, const Pin::Type::Value &rhs)
	Equal compares Pin::Type values.
constexpr bool	NAV::operator== (const Pin::Type::Value &lhs, const Pin::Type &rhs)
	Equal compares Pin::Type values.
void	NAV::to_json (json &j, const InputPin &pin)
	Converts the provided pin into a json object.
void	NAV::to_json (json &j, const OutputPin &pin)
	Converts the provided pin into a json object.

Detailed Description

Pin class.

Author

T. Topp (topp@.nosp@m.ins..nosp@m.uni-s.nosp@m.tutt.nosp@m.gart..nosp@m.de)

Date

2020-12-14

Function Documentation

from_json() [1/2]

void NAV::from_json	(	const json &	j,
		InputPin &	pin )

Converts the provided json object into a pin object.

Parameters

[in]	j	Json object with the needed values
[out]	pin	Object to fill from the json

from_json() [2/2]

void NAV::from_json	(	const json &	j,
		OutputPin &	pin )

Converts the provided json object into a pin object.

Parameters

[in]	j	Json object with the needed values
[out]	pin	Object to fill from the json

operator!=() [1/6]

constexpr bool NAV::operator!= ( const Pin::Kind & lhs, const Pin::Kind & rhs )

constexpr

Inequal compares Pin::Kind values.

Parameters

[in]	lhs	Left-hand side of the operator
[in]	rhs	Right-hand side of the operator

Returns

Whether the comparison was successful

operator!=() [2/6]

constexpr bool NAV::operator!= ( const Pin::Kind & lhs, const Pin::Kind::Value & rhs )

constexpr

Inequal compares Pin::Kind values.

Parameters

[in]	lhs	Left-hand side of the operator
[in]	rhs	Right-hand side of the operator

Returns

Whether the comparison was successful

operator!=() [3/6]

constexpr bool NAV::operator!= ( const Pin::Kind::Value & lhs, const Pin::Kind & rhs )

constexpr

Inequal compares Pin::Kind values.

Parameters

[in]	lhs	Left-hand side of the operator
[in]	rhs	Right-hand side of the operator

Returns

Whether the comparison was successful

operator!=() [4/6]

constexpr bool NAV::operator!= ( const Pin::Type & lhs, const Pin::Type & rhs )

constexpr

Inequal compares Pin::Type values.

Parameters

[in]	lhs	Left-hand side of the operator
[in]	rhs	Right-hand side of the operator

Returns

Whether the comparison was successful

operator!=() [5/6]

constexpr bool NAV::operator!= ( const Pin::Type & lhs, const Pin::Type::Value & rhs )

constexpr

Inequal compares Pin::Type values.

Parameters

[in]	lhs	Left-hand side of the operator
[in]	rhs	Right-hand side of the operator

Returns

Whether the comparison was successful

operator!=() [6/6]

constexpr bool NAV::operator!= ( const Pin::Type::Value & lhs, const Pin::Type & rhs )

constexpr

Inequal compares Pin::Type values.

Parameters

[in]	lhs	Left-hand side of the operator
[in]	rhs	Right-hand side of the operator

Returns

Whether the comparison was successful

operator==() [1/6]

constexpr bool NAV::operator== ( const Pin::Kind & lhs, const Pin::Kind & rhs )

constexpr

Equal compares Pin::Kind values.

Parameters

[in]	lhs	Left-hand side of the operator
[in]	rhs	Right-hand side of the operator

Returns

Whether the comparison was successful

operator==() [2/6]

constexpr bool NAV::operator== ( const Pin::Kind & lhs, const Pin::Kind::Value & rhs )

constexpr

Equal compares Pin::Kind values.

Parameters

[in]	lhs	Left-hand side of the operator
[in]	rhs	Right-hand side of the operator

Returns

Whether the comparison was successful

operator==() [3/6]

constexpr bool NAV::operator== ( const Pin::Kind::Value & lhs, const Pin::Kind & rhs )

constexpr

Equal compares Pin::Kind values.

Parameters

[in]	lhs	Left-hand side of the operator
[in]	rhs	Right-hand side of the operator

Returns

Whether the comparison was successful

operator==() [4/6]

constexpr bool NAV::operator== ( const Pin::Type & lhs, const Pin::Type & rhs )

constexpr

Equal compares Pin::Type values.

Parameters

[in]	lhs	Left-hand side of the operator
[in]	rhs	Right-hand side of the operator

Returns

Whether the comparison was successful

operator==() [5/6]

constexpr bool NAV::operator== ( const Pin::Type & lhs, const Pin::Type::Value & rhs )

constexpr

Equal compares Pin::Type values.

Parameters

[in]	lhs	Left-hand side of the operator
[in]	rhs	Right-hand side of the operator

Returns

Whether the comparison was successful

operator==() [6/6]

constexpr bool NAV::operator== ( const Pin::Type::Value & lhs, const Pin::Type & rhs )

constexpr

Equal compares Pin::Type values.

Parameters

[in]	lhs	Left-hand side of the operator
[in]	rhs	Right-hand side of the operator

Returns

Whether the comparison was successful

to_json() [1/2]

void NAV::to_json	(	json &	j,
		const InputPin &	pin )

Converts the provided pin into a json object.

Parameters

[out]	j	Json object which gets filled with the info
[in]	pin	Node to convert into json

to_json() [2/2]

void NAV::to_json	(	json &	j,
		const OutputPin &	pin )

Converts the provided pin into a json object.

Parameters

[out]	j	Json object which gets filled with the info
[in]	pin	Node to convert into json