Package jmri.jmrix.jserialcomm

Class JSerialPort

java.lang.Object

jmri.jmrix.jserialcomm.JSerialPort

All Implemented Interfaces:

SerialPort

public class JSerialPort
extends java.lang.Object
implements SerialPort

Implementation of serial port using jSerialComm.

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.jmrix.SerialPort

SerialPort.Parity

Field Summary

Fields inherited from interface jmri.jmrix.SerialPort

LISTENING_EVENT_DATA_AVAILABLE, NO_PARITY, ONE_STOP_BIT

Method Summary

Modifier and Type	Method	Description
static JSerialPort	activatePort(java.lang.String systemPrefix, java.lang.String inputPortName, org.slf4j.Logger log, int stop_bits, SerialPort.Parity parity)	Open the port.
void	addDataListener(SerialPortDataListener listener)
void	clearBreak()
void	clearDTR()
void	clearRTS()
void	closePort()
static java.util.Vector<java.lang.String>	getActualPortNames()	Provide the actual serial port names.
int	getBaudRate()
boolean	getCTS()
boolean	getDCD()
java.lang.String	getDescriptivePortName()
boolean	getDSR()
boolean	getDTR()
int	getFlowControlSettings()
java.io.InputStream	getInputStream()
int	getNumDataBits()
int	getNumStopBits()
java.io.OutputStream	getOutputStream()
SerialPort.Parity	getParity()
boolean	getRI()
boolean	getRTS()
void	setBaudRate(int baudrate)
void	setBreak()
boolean	setComPortTimeouts(int newTimeoutMode, int newReadTimeout, int newWriteTimeout)
void	setDTR()
void	setFlowControl(AbstractSerialPortController.FlowControl flow)	Configure the flow control settings.
void	setNumDataBits(int bits)
void	setNumStopBits(int bits)
void	setParity(SerialPort.Parity parity)
void	setRTS()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

addDataListener

public void addDataListener(SerialPortDataListener listener)

Specified by:

addDataListener in interface SerialPort

getInputStream

public java.io.InputStream getInputStream()

Specified by:

getInputStream in interface SerialPort

getOutputStream

public java.io.OutputStream getOutputStream()

Specified by:

getOutputStream in interface SerialPort

setRTS

public void setRTS()

Specified by:

setRTS in interface SerialPort

clearRTS

public void clearRTS()

Specified by:

clearRTS in interface SerialPort

setBaudRate

public void setBaudRate(int baudrate)

Specified by:

setBaudRate in interface SerialPort

getBaudRate

public int getBaudRate()

Specified by:

getBaudRate in interface SerialPort

setNumDataBits

public void setNumDataBits(int bits)

Specified by:

setNumDataBits in interface SerialPort

getNumDataBits

public final int getNumDataBits()

Specified by:

getNumDataBits in interface SerialPort

setNumStopBits

public void setNumStopBits(int bits)

Specified by:

setNumStopBits in interface SerialPort

getNumStopBits

public final int getNumStopBits()

Specified by:

getNumStopBits in interface SerialPort

setParity

public void setParity(SerialPort.Parity parity)

Specified by:

setParity in interface SerialPort

getParity

public SerialPort.Parity getParity()

Specified by:

getParity in interface SerialPort

setDTR

public void setDTR()

Specified by:

setDTR in interface SerialPort

clearDTR

public void clearDTR()

Specified by:

clearDTR in interface SerialPort

getDTR

public boolean getDTR()

Specified by:

getDTR in interface SerialPort

getRTS

public boolean getRTS()

Specified by:

getRTS in interface SerialPort

getDSR

public boolean getDSR()

Specified by:

getDSR in interface SerialPort

getCTS

public boolean getCTS()

Specified by:

getCTS in interface SerialPort

getDCD

public boolean getDCD()

Specified by:

getDCD in interface SerialPort

getRI

public boolean getRI()

Specified by:

getRI in interface SerialPort

setFlowControl

public final void setFlowControl(AbstractSerialPortController.FlowControl flow)

Configure the flow control settings. Keep this in synch with the FlowControl enum.

Specified by:

setFlowControl in interface SerialPort

Parameters:

flow - set which kind of flow control to use

setBreak

public void setBreak()

Specified by:

setBreak in interface SerialPort

clearBreak

public void clearBreak()

Specified by:

clearBreak in interface SerialPort

getFlowControlSettings

public final int getFlowControlSettings()

Specified by:

getFlowControlSettings in interface SerialPort

setComPortTimeouts

public final boolean setComPortTimeouts(int newTimeoutMode,
                                        int newReadTimeout,
                                        int newWriteTimeout)

Specified by:

setComPortTimeouts in interface SerialPort

closePort

public void closePort()

Specified by:

closePort in interface SerialPort

getDescriptivePortName

public java.lang.String getDescriptivePortName()

Specified by:

getDescriptivePortName in interface SerialPort

toString

public java.lang.String toString()

Specified by:

toString in interface SerialPort

Overrides:

toString in class java.lang.Object

activatePort

public static JSerialPort activatePort(java.lang.String systemPrefix,
                                       java.lang.String inputPortName,
                                       org.slf4j.Logger log,
                                       int stop_bits,
                                       SerialPort.Parity parity)

Open the port.

Parameters:

systemPrefix - the system prefix

inputPortName - local system name for the desired port

log - Logger to use for errors, passed so that errors are logged from low-level class'

stop_bits - The number of stop bits, either 1 or 2

parity - one of the defined parity contants

Returns:

the serial port object for later use

getActualPortNames

public static java.util.Vector<java.lang.String> getActualPortNames()

Provide the actual serial port names. As a public static method, this can be accessed outside the jmri.jmrix package to get the list of names for e.g. context reports.

Returns:

the port names in the form they can later be used to open the port