util::serial::SerialPortInfo Class Reference

The serial port information class is an interface against a serial port and CAN devices. More...

#include <serialportinfo.h>

Public Member Functions
const std::string &	Name () const
	Returns the computer friendly name of the serial port.
const std::string &	DisplayName () const
	Returns the user friendly name of the serial port.
const std::string &	Location () const
	Returns the device location string.
const std::string &	Description () const
	Returns the description of the serial port.
const std::string &	Manufacturer () const
	Returns the manufacturer of the serial device.
const std::string &	Type () const
	Type of device ex. USB.
const std::string &	ApplicationType () const
	Device application type.

Static Public Member Functions
static SerialPortList	AvailableSerialPorts ()
	Returns a sorted list of serial ports (not USB).
static SerialPortList	AvailableUsbDevices ()
	Returns a sorted list of USB ports.

Protected Attributes
std::string	name_
	Name of port (ex. COM3).
std::string	display_name_
	Friendly name.
std::string	location_
	Device location/name.
std::string	description_
	Descriptive text.
std::string	manufacturer_
	Manufacturer.
std::string	type_
	Type of device.
std::string	address_
	Device address.
std::string	application_type_
	Device application type.

Detailed Description

The serial port information is used to fix the missing function in boost ASIO library that list all available serial ports on the computer. The ASIO only uses the name part or location part of the object. The remaining properties are not used.

---

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

• include/util/serialportinfo.h