NAV::Pin::Type Struct Reference

Type of the data on the Pin. More...

Public Types
enum	Value : uint8_t {   None ,   Flow ,   Bool ,   Int ,   Float ,   String ,   Object ,   Matrix ,   Delegate }
	Type of the data on the Pin. More...

Public Member Functions
	operator bool ()=delete
	Prevent usage: if(pin)
	operator std::string () const
	std::string conversion operator
	operator Value () const
	Allow switch(Node::Value(type)) and comparisons.
Type &	operator= (Value v)
	Assignment operator from Value type.
constexpr	Type ()=default
	Default Constructor.
	Type (const std::string &typeString)
	Constructor from std::string.
constexpr	Type (Value type)
	Implicit Constructor from Value type.

Private Attributes
Value	value
	Value of the pin type.

Friends
constexpr bool	operator!= (const Pin::Type &lhs, const Pin::Type &rhs)
	Inequal compares Pin::Type values.
constexpr bool	operator!= (const Pin::Type &lhs, const Pin::Type::Value &rhs)
	Inequal compares Pin::Type values.
constexpr bool	operator!= (const Pin::Type::Value &lhs, const Pin::Type &rhs)
	Inequal compares Pin::Type values.
constexpr bool	operator== (const Pin::Type &lhs, const Pin::Type &rhs)
	Equal compares Pin::Type values.
constexpr bool	operator== (const Pin::Type &lhs, const Pin::Type::Value &rhs)
	Equal compares Pin::Type values.
constexpr bool	operator== (const Pin::Type::Value &lhs, const Pin::Type &rhs)
	Equal compares Pin::Type values.

Detailed Description

Type of the data on the Pin.

Member Enumeration Documentation

Value

enum NAV::Pin::Type::Value : uint8_t

Type of the data on the Pin.

Enumerator
None	Not initialized.
Flow	NodeData Trigger.
Bool	Boolean.
Int	Integer Number.
Float	Floating Point Number.
String	std::string
Object	Generic Object.
Matrix	Matrix Object.
Delegate	Reference to the Node object.

Constructor & Destructor Documentation

Type() [1/2]

NAV::Pin::Type::Type ( Value type )

inlineconstexpr

Implicit Constructor from Value type.

Parameters

[in]

type

Value type to construct from

Type() [2/2]

NAV::Pin::Type::Type ( const std::string & typeString )

inlineexplicit

Constructor from std::string.

Parameters

[in]

typeString

String representation of the type

Member Function Documentation

operator std::string()

NAV::Pin::Type::operator std::string ( ) const

inlineexplicit

std::string conversion operator

Returns

A std::string representation of the pin type

operator=()

Type & NAV::Pin::Type::operator= ( Value v )

inline

Assignment operator from Value type.

Parameters

[in]

v

Value type to construct from

Returns

The Type type from the value type

Friends And Related Symbol Documentation

operator!= [1/3]

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

friend

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!= [2/3]

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

friend

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!= [3/3]

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

friend

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/3]

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

friend

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== [2/3]

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

friend

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== [3/3]

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

friend

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

---

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

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