Public Member Functions | Public Attributes | List of all members
dai::DeviceInfo Struct Reference

#include <XLinkConnection.hpp>

Public Member Functions

 DeviceInfo ()=default
 
 DeviceInfo (const deviceDesc_t &desc)
 
 DeviceInfo (std::string mxidOrName)
 
 DeviceInfo (std::string name, std::string mxid, XLinkDeviceState_t state, XLinkProtocol_t protocol, XLinkPlatform_t platform, XLinkError_t status)
 
std::string getMxId () const
 
deviceDesc_t getXLinkDeviceDesc () const
 
std::string toString () const
 

Public Attributes

std::string mxid = ""
 
std::string name = ""
 
XLinkPlatform_t platform = X_LINK_ANY_PLATFORM
 
XLinkProtocol_t protocol = X_LINK_ANY_PROTOCOL
 
XLinkDeviceState_t state = X_LINK_ANY_STATE
 
XLinkError_t status = X_LINK_SUCCESS
 

Detailed Description

Describes a connected device

Definition at line 27 of file XLinkConnection.hpp.

Constructor & Destructor Documentation

◆ DeviceInfo() [1/4]

dai::DeviceInfo::DeviceInfo ( )
default

◆ DeviceInfo() [2/4]

dai::DeviceInfo::DeviceInfo ( std::string  name,
std::string  mxid,
XLinkDeviceState_t  state,
XLinkProtocol_t  protocol,
XLinkPlatform_t  platform,
XLinkError_t  status 
)

Definition at line 39 of file XLinkConnection.cpp.

◆ DeviceInfo() [3/4]

dai::DeviceInfo::DeviceInfo ( std::string  mxidOrName)
explicit

Creates a DeviceInfo by checking whether supplied parameter is a MXID or IP/USB name

Parameters
mxidOrNameEither MXID, IP Address or USB port name

Definition at line 42 of file XLinkConnection.cpp.

◆ DeviceInfo() [4/4]

dai::DeviceInfo::DeviceInfo ( const deviceDesc_t &  desc)
explicit

Definition at line 30 of file XLinkConnection.cpp.

Member Function Documentation

◆ getMxId()

std::string dai::DeviceInfo::getMxId ( ) const

Definition at line 75 of file XLinkConnection.cpp.

◆ getXLinkDeviceDesc()

deviceDesc_t dai::DeviceInfo::getXLinkDeviceDesc ( ) const

Definition at line 56 of file XLinkConnection.cpp.

◆ toString()

std::string dai::DeviceInfo::toString ( ) const

Definition at line 79 of file XLinkConnection.cpp.

Member Data Documentation

◆ mxid

std::string dai::DeviceInfo::mxid = ""

Definition at line 41 of file XLinkConnection.hpp.

◆ name

std::string dai::DeviceInfo::name = ""

Definition at line 40 of file XLinkConnection.hpp.

◆ platform

XLinkPlatform_t dai::DeviceInfo::platform = X_LINK_ANY_PLATFORM

Definition at line 44 of file XLinkConnection.hpp.

◆ protocol

XLinkProtocol_t dai::DeviceInfo::protocol = X_LINK_ANY_PROTOCOL

Definition at line 43 of file XLinkConnection.hpp.

◆ state

XLinkDeviceState_t dai::DeviceInfo::state = X_LINK_ANY_STATE

Definition at line 42 of file XLinkConnection.hpp.

◆ status

XLinkError_t dai::DeviceInfo::status = X_LINK_SUCCESS

Definition at line 45 of file XLinkConnection.hpp.


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


depthai
Author(s): Martin Peterlin
autogenerated on Sat Mar 22 2025 02:58:20