point_one::fusion_engine::messages::InterfaceID Struct Reference

Detailed Description

Identifies an I/O interface.

For example, serial port 1 or TCP server 2.

Note

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

Definition at line 1342 of file configuration.h.

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

Public Member Functions
P1_CONSTEXPR_FUNC	InterfaceID ()=default
P1_CONSTEXPR_FUNC	InterfaceID (TransportType type, uint8_t index=0)
P1_CONSTEXPR_FUNC bool	operator!= (const InterfaceID &other) const
P1_CONSTEXPR_FUNC bool	operator== (const InterfaceID &other) const

Public Attributes
uint8_t	index = 0
	An identifier for the instance of this transport. More...
TransportType	type = TransportType::INVALID
	The interface's transport type. More...

Constructor & Destructor Documentation

InterfaceID() [1/2]

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

default

InterfaceID() [2/2]

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

inlineexplicit

Definition at line 1351 of file configuration.h.

Member Function Documentation

operator!=()

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

inline

Definition at line 1358 of file configuration.h.

operator==()

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

inline

Definition at line 1354 of file configuration.h.

Member Data Documentation

index

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

An identifier for the instance of this transport.

Definition at line 1346 of file configuration.h.

type

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

The interface's transport type.

Definition at line 1344 of file configuration.h.

---

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

• src/point_one/fusion_engine/messages/configuration.h