0.4.1
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Private Attributes | Friends
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.

Definition at line 46 of file Pin.hpp.

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.

Definition at line 49 of file Pin.hpp.

Constructor & Destructor Documentation

◆ Type() [1/3]

NAV::Pin::Type::Type ( )
constexprdefault

Default Constructor.

◆ Type() [2/3]

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

Implicit Constructor from Value type.

Parameters
[in]typeValue type to construct from

Definition at line 67 of file Pin.hpp.

◆ Type() [3/3]

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

Constructor from std::string.

Parameters
[in]typeStringString representation of the type

Definition at line 73 of file Pin.hpp.

Member Function Documentation

◆ operator bool()

NAV::Pin::Type::operator bool ( )
explicitdelete

Prevent usage: if(pin)

◆ operator std::string()

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

std::string conversion operator

Returns
A std::string representation of the pin type

Definition at line 132 of file Pin.hpp.

◆ operator Value()

NAV::Pin::Type::operator Value ( ) const
inlineexplicit

Allow switch(Node::Value(type)) and comparisons.

Definition at line 110 of file Pin.hpp.

◆ operator=()

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

Assignment operator from Value type.

Parameters
[in]vValue type to construct from
Returns
The Type type from the value type

Definition at line 116 of file Pin.hpp.

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]lhsLeft-hand side of the operator
[in]rhsRight-hand side of the operator
Returns
Whether the comparison was successful

Definition at line 817 of file Pin.hpp.

◆ operator!= [2/3]

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

Inequal compares Pin::Type values.

Parameters
[in]lhsLeft-hand side of the operator
[in]rhsRight-hand side of the operator
Returns
Whether the comparison was successful

Definition at line 833 of file Pin.hpp.

◆ operator!= [3/3]

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

Inequal compares Pin::Type values.

Parameters
[in]lhsLeft-hand side of the operator
[in]rhsRight-hand side of the operator
Returns
Whether the comparison was successful

Definition at line 838 of file Pin.hpp.

◆ operator== [1/3]

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

Equal compares Pin::Type values.

Parameters
[in]lhsLeft-hand side of the operator
[in]rhsRight-hand side of the operator
Returns
Whether the comparison was successful

Definition at line 812 of file Pin.hpp.

◆ operator== [2/3]

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

Equal compares Pin::Type values.

Parameters
[in]lhsLeft-hand side of the operator
[in]rhsRight-hand side of the operator
Returns
Whether the comparison was successful

Definition at line 823 of file Pin.hpp.

◆ operator== [3/3]

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

Equal compares Pin::Type values.

Parameters
[in]lhsLeft-hand side of the operator
[in]rhsRight-hand side of the operator
Returns
Whether the comparison was successful

Definition at line 828 of file Pin.hpp.

Field Documentation

◆ value

Value NAV::Pin::Type::value
private

Value of the pin type.

Definition at line 160 of file Pin.hpp.

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