BakeoutController  0.1
A Controller for the Omicron vacuum chamber
Public Member Functions | List of all members
kernel.serial_ports.RXTXPortDriver Class Reference
Inheritance diagram for kernel.serial_ports.RXTXPortDriver:
Inheritance graph
[legend]
Collaboration diagram for kernel.serial_ports.RXTXPortDriver:
Collaboration graph
[legend]

Public Member Functions

 RXTXPortDriver (String applicationName, PortIdentifierGetter portWrapper)
 
String getApplicationName ()
 
List< String > getSerialPortNames ()
 
SerialPort getPortByName (String portName)
 

Detailed Description

Driver responsible for managing serial port names

Definition at line 14 of file RXTXPortDriver.java.

Constructor & Destructor Documentation

kernel.serial_ports.RXTXPortDriver.RXTXPortDriver ( String  applicationName,
PortIdentifierGetter  portWrapper 
)
Parameters
applicationNameThe name to use when signing out ports
portWrapperAn object capable of retrieving port names

Definition at line 31 of file RXTXPortDriver.java.

33  {
34  this.applicationName = applicationName;
35  this.portWrapper = portWrapper;
36  }

Member Function Documentation

String kernel.serial_ports.RXTXPortDriver.getApplicationName ( )
Returns
The name of the application

Implements kernel.serial_ports.PortDriver.

Definition at line 41 of file RXTXPortDriver.java.

41  {
42  return this.applicationName;
43  }
SerialPort kernel.serial_ports.RXTXPortDriver.getPortByName ( String  portName)
Parameters
portNameThe name of the port that needs to be retrieved. An example of a valid name is "/dev/ttyUSB0"
Returns
A wrapper for gnu.io.RXTXPort which can be used to communicate with the required port

Implements kernel.serial_ports.PortDriver.

Definition at line 66 of file RXTXPortDriver.java.

66  {
67  return new RXTXPortWrapper(portName);
68  }
List<String> kernel.serial_ports.RXTXPortDriver.getSerialPortNames ( )
Returns
The names of all serial ports accessible to the system

Implements kernel.serial_ports.PortDriver.

Definition at line 48 of file RXTXPortDriver.java.

48  {
49  Enumeration portIdentifiers = this.portWrapper.getPortIdentifiers();
50  List<CommPortIdentifier> identifierList = castPortIdentifiersToList(
51  portIdentifiers);
52 
53  List<CommPortIdentifier> serialPortList = filterForSerialPorts(
54  identifierList
55  );
56 
57  return getPortNamesForList(serialPortList);
58  }

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