Package jmri.jmrix
Interface SerialPort
-
- All Known Implementing Classes:
FakeSerialPort,JSerialPort
public interface SerialPort
Serial port
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classSerialPort.ParityEnumerate the possible parity choices
-
Field Summary
Fields Modifier and Type Field Description static intLISTENING_EVENT_DATA_AVAILABLEstatic intNO_PARITYstatic intONE_STOP_BIT
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddDataListener(SerialPortDataListener listener)voidclearBreak()voidclearDTR()voidclearRTS()voidclosePort()intgetBaudRate()booleangetCTS()booleangetDCD()java.lang.StringgetDescriptivePortName()booleangetDSR()booleangetDTR()intgetFlowControlSettings()java.io.InputStreamgetInputStream()intgetNumDataBits()intgetNumStopBits()java.io.OutputStreamgetOutputStream()SerialPort.ParitygetParity()booleangetRI()booleangetRTS()voidsetBaudRate(int baudrate)voidsetBreak()booleansetComPortTimeouts(int newTimeoutMode, int newReadTimeout, int newWriteTimeout)voidsetDTR()voidsetFlowControl(AbstractSerialPortController.FlowControl flow)Configure the flow control settings.voidsetNumDataBits(int bits)voidsetNumStopBits(int bits)voidsetParity(SerialPort.Parity parity)voidsetRTS()java.lang.StringtoString()
-
-
-
Field Detail
-
LISTENING_EVENT_DATA_AVAILABLE
static final int LISTENING_EVENT_DATA_AVAILABLE
- See Also:
- Constant Field Values
-
ONE_STOP_BIT
static final int ONE_STOP_BIT
- See Also:
- Constant Field Values
-
NO_PARITY
static final int NO_PARITY
- See Also:
- Constant Field Values
-
-
Method Detail
-
addDataListener
void addDataListener(SerialPortDataListener listener)
-
getInputStream
java.io.InputStream getInputStream()
-
getOutputStream
java.io.OutputStream getOutputStream()
-
setRTS
void setRTS()
-
clearRTS
void clearRTS()
-
setBaudRate
void setBaudRate(int baudrate)
-
getBaudRate
int getBaudRate()
-
setNumDataBits
void setNumDataBits(int bits)
-
getNumDataBits
int getNumDataBits()
-
setNumStopBits
void setNumStopBits(int bits)
-
getNumStopBits
int getNumStopBits()
-
setParity
void setParity(SerialPort.Parity parity)
-
getParity
SerialPort.Parity getParity()
-
setDTR
void setDTR()
-
clearDTR
void clearDTR()
-
getDTR
boolean getDTR()
-
getRTS
boolean getRTS()
-
getDSR
boolean getDSR()
-
getCTS
boolean getCTS()
-
getDCD
boolean getDCD()
-
getRI
boolean getRI()
-
setFlowControl
void setFlowControl(AbstractSerialPortController.FlowControl flow)
Configure the flow control settings. Keep this in synch with the FlowControl enum.- Parameters:
flow- set which kind of flow control to use
-
setBreak
void setBreak()
-
clearBreak
void clearBreak()
-
getFlowControlSettings
int getFlowControlSettings()
-
setComPortTimeouts
boolean setComPortTimeouts(int newTimeoutMode, int newReadTimeout, int newWriteTimeout)
-
closePort
void closePort()
-
getDescriptivePortName
java.lang.String getDescriptivePortName()
-
toString
java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
-