0.2.0
Loading...
Searching...
No Matches
NAV::Node::Kind Struct Reference

Kind information class. More...

Public Types

enum  Value : uint8_t {
  Blueprint ,
  Simple ,
  GroupBox
}
 Possible kinds of Nodes. More...
 

Public Member Functions

 Kind ()=default
 Default Constructor.
 
 Kind (const std::string &string)
 Constructor from std::string.
 
constexpr Kind (Value kind)
 Implicit Constructor from Value type.
 
 operator bool ()=delete
 Prevent usage: if(node)
 
 operator std::string () const
 std::string conversion operator
 
 operator Value () const
 Allow switch(Node::Value(kind)) and comparisons.
 
Kindoperator= (Value v)
 Assignment operator from Value type.
 

Detailed Description

Kind information class.

Member Enumeration Documentation

◆ Value

enum NAV::Node::Kind::Value : uint8_t

Possible kinds of Nodes.

Enumerator
Blueprint 

Node with header.

Simple 

Node without header, which displays its name in the center of the content.

GroupBox 

Group box which can group other nodes and drag them together.

Constructor & Destructor Documentation

◆ Kind() [1/2]

constexpr NAV::Node::Kind::Kind ( Value kind)
inlineconstexpr

Implicit Constructor from Value type.

Parameters
[in]kindValue type to construct from

◆ Kind() [2/2]

NAV::Node::Kind::Kind ( const std::string & string)
inlineexplicit

Constructor from std::string.

Parameters
[in]stringString representation of the type

Member Function Documentation

◆ operator std::string()

NAV::Node::Kind::operator std::string ( ) const
inlineexplicit

std::string conversion operator

Returns
A std::string representation of the node kind

◆ operator=()

Kind & NAV::Node::Kind::operator= ( Value v)
inline

Assignment operator from Value type.

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

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