Package jmri.jmrix.cmri.serial.sim

Class SimDriverAdapter

java.lang.Object

jmri.jmrix.AbstractPortController

jmri.jmrix.AbstractSerialPortController

jmri.jmrix.cmri.serial.SerialPortAdapter

jmri.jmrix.cmri.serial.serialdriver.SerialDriverAdapter

jmri.jmrix.cmri.serial.sim.SimDriverAdapter

All Implemented Interfaces:

PortAdapter, SerialPortAdapter

public class SimDriverAdapter
extends SerialDriverAdapter

Extends the serialdriver.SimDriverAdapter class to act as simulated connection.

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.cmri.serial.serialdriver.SerialDriverAdapter

validSpeeds, validSpeedValues

Fields inherited from class jmri.jmrix.AbstractSerialPortController

currentSerialPort, mBaudRate, mPort

Fields inherited from class jmri.jmrix.AbstractPortController

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

Constructor Summary

Constructors

Constructor	Description
SimDriverAdapter()

Method Summary

Modifier and Type	Method	Description
void	configure()	set up all of the other objects to operate connected to this port
String	getCurrentPortName()	Overridden in simulator adapter classes to return "";
DataInputStream	getInputStream()	Get the InputStream from the port.
DataOutputStream	getOutputStream()	Get the outputStream to the port.
boolean	okToSend()	Can the port accept additional characters?
String	openPort(String portName, String appName)	Open a specified port.
boolean	status()	Query the status of this connection.

Methods inherited from class jmri.jmrix.cmri.serial.serialdriver.SerialDriverAdapter

defaultBaudIndex, validBaudNumbers, validBaudRates

Methods inherited from class jmri.jmrix.AbstractSerialPortController

activatePort, activatePort, activatePort, closeConnection, closeSerialPort, configureBaudRate, configureBaudRateFromIndex, configureBaudRateFromNumber, configureLeads, configureLeadsAndFlowControl, configureLeadsAndFlowControl, connect, currentBaudNumber, getActualPortNames, getCurrentBaudIndex, getCurrentBaudNumber, getCurrentBaudRate, getFlowControl, getPortSettingsString, handlePortBusy, handlePortNotFound, handlePortNotFound, isPortOpen, replacePortWithFakePort, reportPortStatus, resetupConnection, 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, getSystemConnectionMemo, getSystemPrefix, getUserName, isDirty, isOptionAdvanced, isOptionTypePassword, isOptionTypeText, isRestartRequired, purgeStream, reconnect, reconnectFromLoop, recover, safeSleep, setClosed, setDisabled, setManufacturer, setOpened, setOptionState, setReconnectMaxAttempts, setReconnectMaxInterval, setSystemConnectionMemo, setSystemPrefix, setUserName

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, getSystemConnectionMemo, 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

Constructor Details

SimDriverAdapter

public SimDriverAdapter()

Method Details

openPort

public String openPort(String portName,
 String appName)

Description copied from interface: SerialPortAdapter

Open a specified port.

Specified by:

openPort in interface SerialPortAdapter

Overrides:

openPort in class SerialDriverAdapter

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.

okToSend

public boolean okToSend()

Can the port accept additional characters? Yes, always

Overrides:

okToSend in class SerialDriverAdapter

Returns:

always true.

configure

public void configure()

set up all of the other objects to operate connected to this port

Specified by:

configure in interface PortAdapter

Specified by:

configure in interface SerialPortAdapter

Overrides:

configure in class SerialDriverAdapter

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

status

public boolean status()

Description copied from class: AbstractPortController

Query the status of this connection. This is a question of configuration, not transient hardware status.

Specified by:

status in interface PortAdapter

Specified by:

status in interface SerialPortAdapter

Overrides:

status in class SerialDriverAdapter

Returns:

true if OK, at least as far as known

getCurrentPortName

public String getCurrentPortName()

Description copied from class: AbstractSerialPortController

Overridden in simulator adapter classes to return "";

Specified by:

getCurrentPortName in interface PortAdapter

Specified by:

getCurrentPortName in interface SerialPortAdapter

Overrides:

getCurrentPortName in class AbstractSerialPortController