QextSerialEnumerator Class Reference

The QextSerialEnumerator class provides list of ports available in the system. More...

Inheritance diagram for QextSerialEnumerator:

Collaboration diagram for QextSerialEnumerator:

Signals
void	deviceDiscovered (const QextPortInfo &info)
void	deviceRemoved (const QextPortInfo &info)

Public Member Functions
	QextSerialEnumerator (QObject *parent=0)
	~QextSerialEnumerator ()
void	setUpNotifications ()

Static Public Member Functions
static QList< QextPortInfo >	getPorts ()

Detailed Description

The QextSerialEnumerator class provides list of ports available in the system.

Usage

To poll the system for a list of connected devices, simply use getPorts(). Each QextPortInfo structure will populated with information about the corresponding device.

Example

QList<QextPortInfo> ports = QextSerialEnumerator::getPorts();
foreach( QextPortInfo port, ports ) {
    // inspect port...
}

To enable event-driven notification of device connection events, first call setUpNotifications() and then connect to the deviceDiscovered() and deviceRemoved() signals. Event-driven behavior is currently available only on Windows and OS X.

Example

QextSerialEnumerator* enumerator = new QextSerialEnumerator();
connect(enumerator, SIGNAL(deviceDiscovered(const QextPortInfo &)),
           myClass, SLOT(onDeviceDiscovered(const QextPortInfo &)));
connect(enumerator, SIGNAL(deviceRemoved(const QextPortInfo &)),
           myClass, SLOT(onDeviceRemoved(const QextPortInfo &)));

Constructor & Destructor Documentation

QextSerialEnumerator::QextSerialEnumerator

(

QObject *

parent = 0

)

Constructs a QextSerialEnumerator object with the given parent.

QextSerialEnumerator::~QextSerialEnumerator

(

)

Destructs the QextSerialEnumerator object.

Member Function Documentation

void QextSerialEnumerator::deviceDiscovered ( const QextPortInfo &  info )

signal

A new device has been connected to the system.

setUpNotifications() must be called first to enable event-driven device notifications. Currently only implemented on Windows and OS X.

info The device that has been discovered.

void QextSerialEnumerator::deviceRemoved ( const QextPortInfo &  info )

signal

A device has been disconnected from the system.

setUpNotifications() must be called first to enable event-driven device notifications. Currently only implemented on Windows and OS X.

info The device that was disconnected.

QList< QextPortInfo > QextSerialEnumerator::getPorts ( )

static

Get list of ports.

return list of ports currently available in the system.

void QextSerialEnumerator::setUpNotifications

(

)

Enable event-driven notifications of board discovery/removal.

---

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

• qextserialenumerator.h
• qextserialenumerator.cxx