Dashel::SerialPortEnumerator Class Reference

Serial port enumerator class. More...

#include <dashel.h>

List of all members.

Static Public Member Functions

static std::map< int,
std::pair< std::string,
std::string > > 
getPorts ()
 Retrieve list of all serial ports available on system.
static std::map< int,
std::pair< std::string,
std::string > > 
getPorts ()
 Retrieve list of all serial ports available on system.

Detailed Description

Serial port enumerator class.

This class is just a package for one static method.

Definition at line 179 of file dashel.h.


Member Function Documentation

static std::map<int, std::pair<std::string, std::string> > Dashel::SerialPortEnumerator::getPorts (  )  [static]

Retrieve list of all serial ports available on system.

This function queries the Operating System for all available serial ports.

Returns:
A map where the key is the port number name as passed to the ser: protocol, and the value is a pair of the system device name and a human readable description that may be displayed in a user interface. All strings are encoded in UTF-8.
std::map< int, std::pair< std::string, std::string > > Dashel::SerialPortEnumerator::getPorts (  )  [static]

Retrieve list of all serial ports available on system.

This function queries the Operating System for all available serial ports.

Returns:
A map where the key is the port number name as passed to the ser: protocol, and the value is a pair of the system device name and a human readable description that may be displayed in a user interface. All strings are encoded in UTF-8.

Definition at line 118 of file dashel-posix.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


asebaros
Author(s): $author
autogenerated on Mon Sep 5 08:42:16 2011