Package jmri.jmrix.dcc4pc.serialdriver

Class SerialDriverAdapter

java.lang.Object

jmri.jmrix.AbstractPortController

jmri.jmrix.AbstractSerialPortController

jmri.jmrix.dcc4pc.Dcc4PcPortController

jmri.jmrix.dcc4pc.serialdriver.SerialDriverAdapter

All Implemented Interfaces:

PortAdapter, SerialPortAdapter

public class SerialDriverAdapter
extends Dcc4PcPortController

Implements SerialPortAdapter for the Dcc4Pc system.

This connects an Dcc4Pc command station via a serial com port.

Nested Class Summary

Nested classes/interfaces inherited from class jmri.jmrix.AbstractSerialPortController

AbstractSerialPortController.Blocking, AbstractSerialPortController.FlowControl

Nested classes/interfaces inherited from class jmri.jmrix.AbstractPortController

AbstractPortController.Option

Field Summary

Fields

Modifier and Type	Field	Description
(package private) SerialPort	activeSerialPort
(package private) InputStream	serialStream

Fields inherited from class jmri.jmrix.AbstractSerialPortController

currentSerialPort, mBaudRate, mPort

Fields inherited from class jmri.jmrix.AbstractPortController

allowConnectionRecovery, manufacturerName, opened, option1Name, option2Name, option3Name, option4Name, options, reconnectinterval, reconnectMaxAttempts, reconnectMaxInterval

Constructor Summary

Constructors

Constructor	Description
SerialDriverAdapter()

Method Summary

Modifier and Type	Method	Description
void	closeSerialPort()	Close the port after it has failed, so it can be opened again with openPort(java.lang.String, java.lang.String).
void	configure()	set up all of the other objects to operate with an Dcc4Pc command station connected to this port
void	configureOption2(String value)	Set the second port option.
int	defaultBaudIndex()	Get the index of the default port speed for this adapter from the validSpeeds and validRates arrays.
DataInputStream	getInputStream()	Get the InputStream from the port.
String[]	getOptionChoices(String option)	Get a list of the various choices allowed with a given option.
DataOutputStream	getOutputStream()	Get the outputStream to the port.
SerialPort	getSerialPort()
boolean	isPortPresent()
String	openPort(String portName, String appName)	Open a specified port.
String	option2Name()	Get a String that says what Option 2 represents May be an empty string, but will not be null
void	setHandshake(int mode)
int[]	validBaudNumbers()	Get an array of valid baud rate numbers; used to store/load adapter speed option.
String[]	validBaudRates()	Get an array of valid baud rate strings; used to display valid options in Connections Preferences.
String[]	validOption1()	Option 1 controls the connection used for programming.

Methods inherited from class jmri.jmrix.dcc4pc.Dcc4PcPortController

getSystemConnectionMemo

Methods inherited from class jmri.jmrix.AbstractSerialPortController

activatePort, activatePort, activatePort, closeConnection, closePort, closeSerialPort, configureBaudRate, configureBaudRateFromIndex, configureBaudRateFromNumber, configureLeads, configureLeadsAndFlowControl, configureLeadsAndFlowControl, connect, currentBaudNumber, getActualPortNames, getCurrentBaudIndex, getCurrentBaudNumber, getCurrentBaudRate, getCurrentPortName, getFlowControl, getPortSettingsString, handlePortBusy, handlePortNotFound, handlePortNotFound, isPortOpen, reconnect, reconnectFromLoop, replacePortWithFakePort, reportPortStatus, resetupConnection, setBaudRate, setComPortTimeouts, setDataListener, setFlowControl, setPort

Methods inherited from class jmri.jmrix.AbstractPortController

configureOption1, configureOption3, configureOption4, dispose, getAllowConnectionRecovery, getDisabled, getManufacturer, getOption1Name, getOption2Name, getOption3Name, getOption4Name, getOptionDisplayName, getOptions, getOptionState, getReconnectMaxAttempts, getReconnectMaxInterval, getSystemPrefix, getUserName, isDirty, isOptionAdvanced, isOptionTypePassword, isOptionTypeText, isRestartRequired, purgeStream, recover, safeSleep, setAllowConnectionRecovery, setClosed, setDisabled, setManufacturer, setOpened, setOptionState, setReconnectMaxAttempts, setReconnectMaxInterval, setSystemConnectionMemo, setSystemPrefix, setUserName, status

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.jmrix.PortAdapter

dispose, getAllowConnectionRecovery, getDisabled, getOption1Name, getOption2Name, getOption3Name, getOption4Name, getOptionDisplayName, getOptions, getOptionState, getReconnectMaxAttempts, getReconnectMaxInterval, getSystemPrefix, getUserName, isDirty, isOptionAdvanced, isOptionTypePassword, isOptionTypeText, isRestartRequired, recover, setAllowConnectionRecovery, setDisabled, setOptionState, setReconnectMaxAttempts, setReconnectMaxInterval, setSystemConnectionMemo, setSystemPrefix, setUserName

Methods inherited from interface jmri.jmrix.SerialPortAdapter

configureOption1, configureOption3, configureOption4, getManufacturer, getPortNames, setManufacturer, status

Field Details

activeSerialPort

SerialPort activeSerialPort

serialStream

InputStream serialStream

Constructor Details

SerialDriverAdapter

public SerialDriverAdapter()

Method Details

openPort

public String openPort(String portName,
 String appName)

Description copied from interface: SerialPortAdapter

Open a specified port.

Parameters:

portName - name tu use for this port

appName - provided to the underlying OS during startup so that it can show on status displays, etc.

Returns:

null indicates OK return, else error message.

setHandshake

public void setHandshake(int mode)

getSerialPort

public SerialPort getSerialPort()

closeSerialPort

public void closeSerialPort()

Close the port after it has failed, so it can be opened again with openPort(java.lang.String, java.lang.String).

isPortPresent

public boolean isPortPresent()

Returns:

true if the operating system lists this connection's port. A USB interface's port disappears while it is unplugged.

validOption1

public String[] validOption1()

Option 1 controls the connection used for programming.

Returns:

array with options for programming.

getOptionChoices

public String[] getOptionChoices(String option)

Get a list of the various choices allowed with a given option.

The Programmer choices are worked out each time: the list made when this connection was created can't include connections that start after it, and LocoNet often does. The saved choice stays in the list even if that connection isn't running, so opening Preferences doesn't clear it.

Specified by:

getOptionChoices in interface PortAdapter

Overrides:

getOptionChoices in class AbstractPortController

Parameters:

option - the name of the option to query

Returns:

list of valid values for the option, null if none are available

option2Name

public String option2Name()

Get a String that says what Option 2 represents May be an empty string, but will not be null

Returns:

option to match detected locos to roster.

configureOption2

public void configureOption2(String value)

Set the second port option. Only to be used after construction, but before the openPort call

Specified by:

configureOption2 in interface PortAdapter

Specified by:

configureOption2 in interface SerialPortAdapter

Overrides:

configureOption2 in class AbstractPortController

Parameters:

value - to set the option to

getInputStream

public DataInputStream getInputStream()

Description copied from class: AbstractPortController

Get the InputStream from the port.

Specified by:

getInputStream in interface PortAdapter

Overrides:

getInputStream in class AbstractSerialPortController

Returns:

the InputStream from the port

getOutputStream

public DataOutputStream getOutputStream()

Description copied from class: AbstractPortController

Get the outputStream to the port.

Specified by:

getOutputStream in interface PortAdapter

Overrides:

getOutputStream in class AbstractSerialPortController

Returns:

the outputStream to the port

validBaudRates

public String[] validBaudRates()

Get an array of valid baud rate strings; used to display valid options in Connections Preferences. Currently only 115,200 bps

Specified by:

validBaudRates in interface SerialPortAdapter

Overrides:

validBaudRates in class AbstractSerialPortController

Returns:

array of I18N display strings of port speed settings valid for this serial adapter, must match order and values from SerialPortAdapter.validBaudNumbers()

validBaudNumbers

public int[] validBaudNumbers()

Get an array of valid baud rate numbers; used to store/load adapter speed option.

Specified by:

validBaudNumbers in interface SerialPortAdapter

Overrides:

validBaudNumbers in class AbstractSerialPortController

Returns:

integer array of speeds, must match order and values from SerialPortAdapter.validBaudRates()

defaultBaudIndex

public int defaultBaudIndex()

Description copied from interface: SerialPortAdapter

Get the index of the default port speed for this adapter from the validSpeeds and validRates arrays.

Specified by:

defaultBaudIndex in interface SerialPortAdapter

Overrides:

defaultBaudIndex in class AbstractSerialPortController

Returns:

-1 to indicate not supported, unless overridden in adapter

configure

public void configure()

set up all of the other objects to operate with an Dcc4Pc command station connected to this port