Package jmri.jmrix.can.adapters.gridconnect.can2usbino.serialdriver

Class SerialDriverAdapter

java.lang.Object

jmri.jmrix.AbstractPortController

jmri.jmrix.AbstractSerialPortController

jmri.jmrix.can.adapters.gridconnect.GcPortController

jmri.jmrix.can.adapters.gridconnect.GcSerialDriverAdapter

jmri.jmrix.can.adapters.gridconnect.can2usbino.serialdriver.SerialDriverAdapter

All Implemented Interfaces:

PortAdapter, SerialPortAdapter

public class SerialDriverAdapter
extends GcSerialDriverAdapter

Implements SerialPortAdapter for GridConnect adapters.

This connects a CAN-USB CAN adapter via a serial com port. Normally controlled by the SerialDriverFrame class. This asserts XON/XOFF flow control.

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 inherited from class jmri.jmrix.can.adapters.gridconnect.GcSerialDriverAdapter

flowControl

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
int	defaultBaudIndex()	Get the index of the default port speed for this adapter from the validSpeeds and validRates arrays.
protected GcTrafficController	makeGcTrafficController()	Make a new GC Traffic Controller.
String	openPort(String portName, String appName)	Open a specified port.
int[]	validBaudNumbers()	And the corresponding values.
String[]	validBaudRates()	Get an array of valid baud rate strings; used to display valid options in Connections Preferences.

Methods inherited from class jmri.jmrix.can.adapters.gridconnect.GcSerialDriverAdapter

closeConnection, configure, getInputStream, localSetFlowControl, resetupConnection

Methods inherited from class jmri.jmrix.can.adapters.gridconnect.GcPortController

getSystemConnectionMemo

Methods inherited from class jmri.jmrix.AbstractSerialPortController

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

Methods inherited from class jmri.jmrix.AbstractPortController

configureOption1, configureOption2, configureOption3, configureOption4, dispose, getDisabled, getManufacturer, getOption1Name, getOption2Name, getOption3Name, getOption4Name, getOptionChoices, getOptionDisplayName, getOptions, getOptionState, getReconnectMaxAttempts, getReconnectMaxInterval, getSystemPrefix, getUserName, isDirty, isOptionAdvanced, isOptionTypePassword, isOptionTypeText, isRestartRequired, purgeStream, reconnect, reconnectFromLoop, recover, safeSleep, 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, getDisabled, getOption1Name, getOption2Name, getOption3Name, getOption4Name, getOptionChoices, getOptionDisplayName, getOptions, getOptionState, getReconnectMaxAttempts, getReconnectMaxInterval, getSystemPrefix, getUserName, isDirty, isOptionAdvanced, isOptionTypePassword, isOptionTypeText, isRestartRequired, recover, setDisabled, setOptionState, setReconnectMaxAttempts, setReconnectMaxInterval, setSystemConnectionMemo, setSystemPrefix, setUserName

Methods inherited from interface jmri.jmrix.SerialPortAdapter

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

Constructor Details

SerialDriverAdapter

public SerialDriverAdapter()

Method Details

openPort

public String openPort(String portName,
 String appName)

Description copied from class: GcSerialDriverAdapter

Open a specified port.

Specified by:

openPort in interface SerialPortAdapter

Overrides:

openPort in class GcSerialDriverAdapter

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.

validBaudRates

public String[] validBaudRates()

Get an array of valid baud rate strings; used to display valid options in Connections Preferences.

Specified by:

validBaudRates in interface SerialPortAdapter

Overrides:

validBaudRates in class GcSerialDriverAdapter

Returns:

array of localized valid baud rates

validBaudNumbers

public int[] validBaudNumbers()

And the corresponding values.

Specified by:

validBaudNumbers in interface SerialPortAdapter

Overrides:

validBaudNumbers in class GcSerialDriverAdapter

Returns:

valid baud rates

defaultBaudIndex

public int defaultBaudIndex()

Description copied from class: GcSerialDriverAdapter

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 GcSerialDriverAdapter

Returns:

-1 to indicate not supported, unless overridden in adapter

makeGcTrafficController

protected GcTrafficController makeGcTrafficController()

Description copied from class: GcSerialDriverAdapter

Make a new GC Traffic Controller.

Overrides:

makeGcTrafficController in class GcSerialDriverAdapter

Returns:

new GridConnect Traffic Controller.