EduArt Sensor Ring Library 4.0.0
Loading...
Searching...
No Matches
ComInterfaceID.hpp File Reference

Interface type definition. More...

#include <ostream>
#include <string>
#include "sensorring/platform/SensorringExport.hpp"
Include dependency graph for ComInterfaceID.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  eduart::sensorring::com::ComInterfaceID
 Uniquely identifies a communication interface by type and name. More...
struct  std::hash< eduart::sensorring::com::ComInterfaceID >
 Hash specialization for ComInterfaceID to enable use in unordered containers. More...

Enumerations

enum class  eduart::sensorring::com::InterfaceType { Undefined , SocketCan , UsbTingo }
 Type of the communication interface. More...

Functions

SENSORRING_EXPORT std::string eduart::sensorring::com::toString (InterfaceType type) noexcept
 Format interface type as string.
SENSORRING_EXPORT std::ostream & eduart::sensorring::com::operator<< (std::ostream &os, const InterfaceType type) noexcept
 Stream interface type as string.

Detailed Description

Interface type definition.

Author
EduArt Robotik GmbH
Date
2026-02-19

Enumeration Type Documentation

◆ InterfaceType

Type of the communication interface.

Enumerator
Undefined 

Type not yet assigned.

SocketCan 

Linux SocketCAN interface (e.g. can0).

UsbTingo 

USBtingo CAN adapter.

Function Documentation

◆ operator<<()

SENSORRING_EXPORT std::ostream & eduart::sensorring::com::operator<< ( std::ostream & os,
const InterfaceType type )
noexcept

Stream interface type as string.

Parameters
[in]osOutput stream.
[in]typeInterface type to print.
Returns
Reference to os.

◆ toString()

SENSORRING_EXPORT std::string eduart::sensorring::com::toString ( InterfaceType type)
noexcept

Format interface type as string.

Returns
Interface type string.