kernel.serial_ports.RXTXPortWrapper Class Reference

Inheritance diagram for kernel.serial_ports.RXTXPortWrapper:

Collaboration diagram for kernel.serial_ports.RXTXPortWrapper:

Public Member Functions
PortCommunicator	getCommunicator ()
InputStream	getInputStream () throws IOException
OutputStream	getOutputStream () throws IOException
PortConfiguration	getConfig ()
int	getBaudRate ()
int	getStopBits ()
int	getDataBits ()
int	getParityBits ()
void	setConfig (PortConfiguration newConfig)
void	open () throws PortInUseException, UnsupportedCommOperationException
boolean	isPortOpen ()
void	close ()

Additional Inherited Members
Public Attributes inherited from kernel.serial_ports.PortConfiguration
int	DATABITS_8 = RXTXPort.DATABITS_8
int	BAUD_RATE_9600 = 9600
int	PARITY_NONE = RXTXPort.PARITY_NONE
int	STOPBITS_1 = RXTXPort.STOPBITS_1

Detailed Description

Wraps the RXTX port

Definition at line 17 of file RXTXPortWrapper.java.

Member Function Documentation

void kernel.serial_ports.RXTXPortWrapper.close

(

)

closes the port

Implements kernel.serial_ports.SerialPort.

Definition at line 177 of file RXTXPortWrapper.java.

                                 {
        if (this.isPortOpen){
            this.port.close();
            this.isPortOpen = false;

            Runtime.getRuntime().removeShutdownHook(shutdownThread);

            writeLogEntryForPortClosed();
        }
    }

int kernel.serial_ports.RXTXPortWrapper.getBaudRate

(

)

Returns

The current baud rate set on the port

Implements kernel.serial_ports.PortConfiguration.

Definition at line 104 of file RXTXPortWrapper.java.

                                      {
        return this.port.getBaudRate();
    }

PortCommunicator kernel.serial_ports.RXTXPortWrapper.getCommunicator

(

)

Returns

Something capable of retrieving an input and output stream for communicating through the port

Implements kernel.serial_ports.SerialPort.

Definition at line 66 of file RXTXPortWrapper.java.

                                                       {
        return this;
    }

PortConfiguration kernel.serial_ports.RXTXPortWrapper.getConfig

(

)

Returns

Something capable of expressing the port's configuration

Implements kernel.serial_ports.SerialPort.

Definition at line 96 of file RXTXPortWrapper.java.

                                                  {
        return this;
    }

int kernel.serial_ports.RXTXPortWrapper.getDataBits

(

)

Returns

The number of data bits on the port

Implements kernel.serial_ports.PortConfiguration.

Definition at line 120 of file RXTXPortWrapper.java.

                                      {
        return this.port.getDataBits();
    }

InputStream kernel.serial_ports.RXTXPortWrapper.getInputStream

(

)

throws IOException

Returns

The input stream for the wrapped port

Exceptions

IOException

if the port is not open. The resulting InputStream cannot be retrieved

Implements kernel.serial_ports.PortCommunicator.

Definition at line 75 of file RXTXPortWrapper.java.

                                                                     {
        assertPortOpen();
        writeLogEntryForInputStreamRequest();
        return this.port.getInputStream();
    }

OutputStream kernel.serial_ports.RXTXPortWrapper.getOutputStream

(

)

throws IOException

Returns

The output stream for the wrapped port

Exceptions

IOException

if the port is not open. The port must be open prior to retrieving the port's OutputStream

Implements kernel.serial_ports.PortCommunicator.

Definition at line 86 of file RXTXPortWrapper.java.

                                                                       {
        assertPortOpen();
        writeLogEntryForOutputStreamRequest();
        return this.port.getOutputStream();
    }

int kernel.serial_ports.RXTXPortWrapper.getParityBits

(

)

Returns

The number of parity bits set on the port

Implements kernel.serial_ports.PortConfiguration.

Definition at line 128 of file RXTXPortWrapper.java.

                                        {
        return this.port.getParity();
    }

int kernel.serial_ports.RXTXPortWrapper.getStopBits

(

)

Returns

The current number of stop bits on the port

Implements kernel.serial_ports.PortConfiguration.

Definition at line 112 of file RXTXPortWrapper.java.

                                      {
        return this.port.getStopBits();
    }

boolean kernel.serial_ports.RXTXPortWrapper.isPortOpen

(

)

Returns

true if the port is open, otherwise false

Implements kernel.serial_ports.SerialPort.

Definition at line 170 of file RXTXPortWrapper.java.

                                         {
        return this.isPortOpen;
    }

void kernel.serial_ports.RXTXPortWrapper.open

(

)

throws PortInUseException, UnsupportedCommOperationException

Open the port

Exceptions

PortInUseException	if the port cannot be opened
UnsupportedCommOperationException	if the port can be opened, but the configuration cannot be set

Implements kernel.serial_ports.SerialPort.

Definition at line 146 of file RXTXPortWrapper.java.

                                          {
        if (!this.isPortOpen){
            this.port = new RXTXPort(this.portName);
            this.isPortOpen = true;

            shutdownThread = new PortShutdown(this);
            Runtime.getRuntime().addShutdownHook(shutdownThread);

            try {
                setConfigurationParametersForOpenPort();
            } catch (IOException error){
                throw new UnsupportedCommOperationException(
                        "Unable to set port configuration parameters"
                );
            }

            writeLogEntryForPortOpen();
        }
    }

void kernel.serial_ports.RXTXPortWrapper.setConfig

(

PortConfiguration

newConfig

)

Sets the port configuration to a new config

Parameters

newConfig

the new parameters required of the port

Implements kernel.serial_ports.SerialPort.

Definition at line 136 of file RXTXPortWrapper.java.

                                                                 {
        this.desiredPortConfiguration = newConfig;
    }

---

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

• RXTXPortWrapper.java