Package jmri.jmrix.bidib.simulator

Class BiDiBSimulatorAdapter

java.lang.Object

jmri.jmrix.AbstractPortController

jmri.jmrix.AbstractSerialPortController

jmri.jmrix.bidib.BiDiBSerialPortController

jmri.jmrix.bidib.simulator.BiDiBSimulatorAdapter

All Implemented Interfaces:

BiDiBPortController, PortAdapter, SerialPortAdapter

public class BiDiBSimulatorAdapter
extends BiDiBSerialPortController

Provide access to a simulated BiDiB system.

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
protected String	absoluteSimulationFile
protected String	loadedSimulationFilename
protected String	simulationFile

Fields inherited from class jmri.jmrix.bidib.BiDiBSerialPortController

bidib, context

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

Method Summary

Modifier and Type	Method	Description
void	configure()	Set up all of the other objects to operate with a BiDiBSimulator 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.
String	getRealPortName()	Get the physical port name used with jbidibc
String	getSimulationFile()
boolean	isDirty()	Determine if configuration needs to be written to disk.
boolean	isRestartRequired()	Determine if application needs to be restarted for configuration changes to be applied.
String	openPort(String fileName, String appName)	Here we do not really open something.
void	registerAllListeners(org.bidib.jbidibc.messages.ConnectionListener connectionListener, Set<org.bidib.jbidibc.core.NodeListener> nodeListeners, Set<org.bidib.jbidibc.core.MessageListener> messageListeners, Set<org.bidib.jbidibc.core.node.listener.TransferListener> transferListeners)	Register all Listeners to the specific BiDiB Object.
void	setSimulationFile(String f)
boolean	status()	Query the status of this connection.

Methods inherited from class jmri.jmrix.bidib.BiDiBSerialPortController

getContext, getSystemConnectionMemo

Methods inherited from class jmri.jmrix.AbstractSerialPortController

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

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, isOptionAdvanced, isOptionTypePassword, isOptionTypeText, 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

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

Methods inherited from interface jmri.jmrix.SerialPortAdapter

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

Field Details

simulationFile

protected String simulationFile

loadedSimulationFilename

protected String loadedSimulationFilename

absoluteSimulationFile

protected String absoluteSimulationFile

Constructor Details

BiDiBSimulatorAdapter

public BiDiBSimulatorAdapter()

Method Details

getSimulationFile

public String getSimulationFile()

setSimulationFile

public void setSimulationFile(String f)

isDirty

public boolean isDirty()

Description copied from interface: PortAdapter

Determine if configuration needs to be written to disk.

Specified by:

isDirty in interface PortAdapter

Overrides:

isDirty in class AbstractPortController

Returns:

true if configuration needs to be saved, false otherwise

isRestartRequired

public boolean isRestartRequired()

Description copied from interface: PortAdapter

Determine if application needs to be restarted for configuration changes to be applied.

Specified by:

isRestartRequired in interface PortAdapter

Overrides:

isRestartRequired in class AbstractPortController

Returns:

true if application needs to restart, false otherwise

getCurrentPortName

public String getCurrentPortName()

Overridden in simulator adapter classes to return "";

Specified by:

getCurrentPortName in interface PortAdapter

Specified by:

getCurrentPortName in interface SerialPortAdapter

Overrides:

getCurrentPortName in class AbstractSerialPortController

getRealPortName

public String getRealPortName()

Get the physical port name used with jbidibc Get the "port name" in the format which is used by jbidibc - this is absolute path to the simulation XML file

Specified by:

getRealPortName in interface BiDiBPortController

Overrides:

getRealPortName in class BiDiBSerialPortController

Returns:

real port name

openPort

public String openPort(String fileName,
 String appName)

Here we do not really open something.

Parameters:

fileName - name of simulation file

appName - not used

Returns:

error string, null if no error

configure

public void configure()

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

registerAllListeners

public void registerAllListeners(org.bidib.jbidibc.messages.ConnectionListener connectionListener,
 Set<org.bidib.jbidibc.core.NodeListener> nodeListeners,
 Set<org.bidib.jbidibc.core.MessageListener> messageListeners,
 Set<org.bidib.jbidibc.core.node.listener.TransferListener> transferListeners)

Register all Listeners to the specific BiDiB Object. We need this here since the BidibInterface does not provide this method.

Specified by:

registerAllListeners in interface BiDiBPortController

Specified by:

registerAllListeners in class BiDiBSerialPortController

Parameters:

connectionListener - where to add

nodeListeners - listeners to add

messageListeners - listeners to add

transferListeners - listeners to add

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:

true if OK, at least as far as known