Skip to main content

InterfaceID Struct

Identifier for an I/O interface. More...

Declaration​

struct point_one::fusion_engine::messages::InterfaceID { ... }

Included Headers​

#include <point_one/fusion_engine/messages/configuration.h>

Public Constructors Index​

P1_CONSTEXPR_FUNCInterfaceID ()=default
P1_CONSTEXPR_FUNCInterfaceID (TransportType type, uint8_t index=0)

Public Operators Index​

P1_CONSTEXPR_FUNC booloperator!= (const InterfaceID &other) const
P1_CONSTEXPR_FUNC booloperator< (const InterfaceID &other) const
P1_CONSTEXPR_FUNC booloperator<= (const InterfaceID &other) const
P1_CONSTEXPR_FUNC booloperator== (const InterfaceID &other) const
P1_CONSTEXPR_FUNC booloperator> (const InterfaceID &other) const
P1_CONSTEXPR_FUNC booloperator>= (const InterfaceID &other) const

Public Member Attributes Index​

uint8_tindex = 0

An identifier for the instance of this transport. More...

TransportTypetype = TransportType::INVALID

The interface's transport type. More...

Description​

Identifier for an I/O interface.

For example, serial port 1 or TCP server 2.

info

On most devices, serial ports (UARTs) use 1-based numbering: the first serial port is typically index 1 (UART1).

Definition at line 1956 of file configuration.h.

Public Constructors​

InterfaceID()​

P1_CONSTEXPR_FUNC point_one::fusion_engine::messages::InterfaceID::InterfaceID ()
 default

Definition at line 1963 of file configuration.h.

InterfaceID()​

P1_CONSTEXPR_FUNC point_one::fusion_engine::messages::InterfaceID::InterfaceID (TransportType type, uint8_t index=0)
 inline explicit

Definition at line 1965 of file configuration.h.

1965 P1_CONSTEXPR_FUNC explicit InterfaceID(TransportType type, uint8_t index = 0)
1966 : type(type), index(index) {}

Public Operators​

operator!=()​

P1_CONSTEXPR_FUNC bool point_one::fusion_engine::messages::InterfaceID::operator!= (const InterfaceID & other)
 inline

Definition at line 1972 of file configuration.h.

1972 P1_CONSTEXPR_FUNC bool operator!=(const InterfaceID& other) const {
1973 return !(*this == other);
1974 }

operator<()​

P1_CONSTEXPR_FUNC bool point_one::fusion_engine::messages::InterfaceID::operator< (const InterfaceID & other)
 inline

Definition at line 1976 of file configuration.h.

1976 P1_CONSTEXPR_FUNC bool operator<(const InterfaceID& other) const {
1977 if (type == other.type) {
1978 return index < other.index;
1979 } else {
1980 return type < other.type;
1981 }
1982 }

operator<=()​

P1_CONSTEXPR_FUNC bool point_one::fusion_engine::messages::InterfaceID::operator<= (const InterfaceID & other)
 inline

Definition at line 1992 of file configuration.h.

1992 P1_CONSTEXPR_FUNC bool operator<=(const InterfaceID& other) const {
1993 return !(*this > other);
1994 }

operator==()​

P1_CONSTEXPR_FUNC bool point_one::fusion_engine::messages::InterfaceID::operator== (const InterfaceID & other)
 inline

Definition at line 1968 of file configuration.h.

1968 P1_CONSTEXPR_FUNC bool operator==(const InterfaceID& other) const {
1969 return type == other.type && index == other.index;
1970 }

operator>()​

P1_CONSTEXPR_FUNC bool point_one::fusion_engine::messages::InterfaceID::operator> (const InterfaceID & other)
 inline

Definition at line 1984 of file configuration.h.

1984 P1_CONSTEXPR_FUNC bool operator>(const InterfaceID& other) const {
1985 return other < *this;
1986 }

operator>=()​

P1_CONSTEXPR_FUNC bool point_one::fusion_engine::messages::InterfaceID::operator>= (const InterfaceID & other)
 inline

Definition at line 1988 of file configuration.h.

1988 P1_CONSTEXPR_FUNC bool operator>=(const InterfaceID& other) const {
1989 return !(*this < other);
1990 }

Public Member Attributes​

index​

uint8_t point_one::fusion_engine::messages::InterfaceID::index = 0

An identifier for the instance of this transport.

Definition at line 1960 of file configuration.h.

1960 uint8_t index = 0;

type​

TransportType point_one::fusion_engine::messages::InterfaceID::type = TransportType::INVALID

The interface's transport type.

Definition at line 1958 of file configuration.h.

1958 TransportType type = TransportType::INVALID;

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

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.