Package jmri.jmrix.maple.simulator

Class SimulatorAdapter

java.lang.Object

jmri.jmrix.AbstractPortController

jmri.jmrix.AbstractSerialPortController

jmri.jmrix.maple.SerialPortController

jmri.jmrix.maple.simulator.SimulatorAdapter

All Implemented Interfaces:

Runnable, PortAdapter, SerialPortAdapter

public class SimulatorAdapter
extends SerialPortController
implements Runnable

Provide access to a simulated Maple system.

Currently, the Maple SimulatorAdapter reacts to the following commands sent from the user interface with an appropriate reply generateReply(SerialMessage):

• RC Read Coils (poll), all coil bits 0
• WC Write Coils (ACK)

Based on jmri.jmrix.lenz.xnetsimulator.XNetSimulatorAdapter / GrapevineSimulatorAdapter 2017

NOTE: Some material in this file was modified from other portions of the support infrastructure.

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) int	sensorBankSize
(package private) int	signalBankSize
(package private) Timer	timer

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
SimulatorAdapter()	Create a new SimulatorAdapter.

Method Summary

Modifier and Type	Method	Description
void	configure()	Set up all of the other objects to operate with a MapleSimulator connected to this port.
void	connect()	Open the connection.
String	getCurrentBaudRate()
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.
void	run()
SerialReply	setChecksum(SerialReply r, int index)	Set checksum on simulated Maple Node reply.
void	setOutputBufferEmpty(boolean s)	Set if the output buffer is empty or full.
boolean	status()	Query the status of this connection.
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.

Methods inherited from class jmri.jmrix.AbstractSerialPortController

activatePort, activatePort, activatePort, closeConnection, closeSerialPort, configureBaudRate, configureBaudRateFromIndex, configureBaudRateFromNumber, configureLeads, configureLeadsAndFlowControl, configureLeadsAndFlowControl, currentBaudNumber, defaultBaudIndex, getActualPortNames, getCurrentBaudIndex, getCurrentBaudNumber, 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

Field Details

signalBankSize

int signalBankSize

sensorBankSize

int sensorBankSize

timer

Timer timer

Constructor Details

SimulatorAdapter

public SimulatorAdapter()

Create a new SimulatorAdapter.

Method Details

openPort

public String openPort(String portName,
 String appName)

Open a specified port. Simulated input/output pipes.

Specified by:

openPort in interface SerialPortAdapter

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.

setOutputBufferEmpty

public void setOutputBufferEmpty(boolean s)

Set if the output buffer is empty or full. This should only be set to false by external processes.

Parameters:

s - true if output buffer is empty; false otherwise

okToSend

public boolean okToSend()

Can the port accept additional characters? The state of CTS determines this, as there seems to be no way to check the number of queued bytes and buffer length. This might go false for short intervals, but it might also stick off if something goes wrong.

Returns:

true if port can accept additional characters; false otherwise

configure

public void configure()

Set up all of the other objects to operate with a MapleSimulator connected to this port.

Specified by:

configure in interface PortAdapter

Specified by:

configure in interface SerialPortAdapter

connect

public void connect()
             throws IOException

Open the connection.

Specified by:

connect in interface PortAdapter

Overrides:

connect in class AbstractSerialPortController

Throws:

IOException - if unable to connect

getInputStream

public DataInputStream getInputStream()

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()

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()

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 AbstractPortController

Returns:

always true, given this SimulatorAdapter is running

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 AbstractSerialPortController

Returns:

null

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()

getCurrentBaudRate

public String getCurrentBaudRate()

Description copied from class: AbstractSerialPortController

Specified by:

getCurrentBaudRate in interface SerialPortAdapter

Overrides:

getCurrentBaudRate in class AbstractSerialPortController

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

run

public void run()

Specified by:

run in interface Runnable

setChecksum

public SerialReply setChecksum(SerialReply r,
 int index)

Set checksum on simulated Maple Node reply. Code copied from SerialMessage#setChecksum(int)

Parameters:

r - the SerialReply to complete

index - element index to place 2 checksum bytes

Returns:

SerialReply with parity set