jmri.jmrix.cmri.serial.sim
Class SimDriverAdapter

java.lang.Object
  jmri.jmrix.AbstractPortController
      jmri.jmrix.AbstractSerialPortController
          jmri.jmrix.cmri.serial.SerialPortController
              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.

Author:

Bob Jacobsen Copyright (C) 2002, 2008, 2011

Field Summary

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

selectedSpeed, validSpeeds, validSpeedValues

Fields inherited from class jmri.jmrix.AbstractSerialPortController

mBaudRate, mPort

Fields inherited from class jmri.jmrix.AbstractPortController

mDisabled, mManufacturer, mOpt1, mOpt2

Constructor Summary

SimDriverAdapter()

Method Summary

void	configure() set up all of the other objects to operate connected to this port
void	configureBaudRate(String rate) Set the baud rate.
void	configureOption1(String value) The first port option isn't used, so just ignore this call.
DataInputStream	getInputStream()
DataOutputStream	getOutputStream()
static SerialDriverAdapter	instance()
boolean	okToSend() Can the port accept additional characters?
String	openPort(String portName, String appName) Open a specified port.
String	option1Name() Option 1 not used, so return a null string.
String	option2Name() Get a String that says what Option 2 represents May be an empty string, but will not be null
protected void	setSerialPort() Local method to do specific port configuration
boolean	status() Query the status of this connection.
String[]	validBaudRates() Get an array of valid baud rates.
String[]	validOption1() Option 1 is not used for anything
String[]	validOption2() Get an array of valid values for "option 2"; used to display valid options.

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

getManufacturer, setManufacturer

Methods inherited from class jmri.jmrix.AbstractSerialPortController

currentBaudNumber, dispose, getCurrentBaudRate, getCurrentPortName, getPortNames, getSystemConnectionMemo, handlePortBusy, handlePortNotFound, setDisabled, setPort, validBaudNumber

Methods inherited from class jmri.jmrix.AbstractPortController

configureOption2, getCurrentOption1Setting, getCurrentOption2Setting, getDisabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.jmrix.SerialPortAdapter

configureOption2, getCurrentBaudRate, getCurrentOption1Setting, getCurrentOption2Setting, getCurrentPortName, getPortNames, handlePortBusy, setPort

Methods inherited from interface jmri.jmrix.PortAdapter

dispose, getDisabled, getSystemConnectionMemo, setDisabled

Constructor Detail

SimDriverAdapter

public SimDriverAdapter()

Method Detail

openPort

public String openPort(String portName,
                       String appName)

Description copied from interface: SerialPortAdapter

Open a specified port. The appname argument is to be provided to the underlying OS during startup so that it can show on status displays, etc

Specified by:

openPort in interface SerialPortAdapter

Overrides:

openPort in class SerialDriverAdapter

okToSend

public boolean okToSend()

Can the port accept additional characters? Yes, always

Overrides:

okToSend in class SerialDriverAdapter

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

Specified by:

getInputStream in interface PortAdapter

Overrides:

getInputStream in class SerialDriverAdapter

getOutputStream

public DataOutputStream getOutputStream()

Specified by:

getOutputStream in interface PortAdapter

Overrides:

getOutputStream in class SerialDriverAdapter

status

public boolean status()

Description copied from interface: PortAdapter

Query the status of this connection. If all OK, at least as far as is known, return true

Specified by:

status in interface PortAdapter

Specified by:

status in interface SerialPortAdapter

Overrides:

status in class SerialDriverAdapter

setSerialPort

protected void setSerialPort()
                      throws UnsupportedCommOperationException

Local method to do specific port configuration

Overrides:

setSerialPort in class SerialDriverAdapter

Throws:

UnsupportedCommOperationException

validBaudRates

public String[] validBaudRates()

Get an array of valid baud rates.

Specified by:

validBaudRates in interface SerialPortAdapter

Overrides:

validBaudRates in class SerialDriverAdapter

configureBaudRate

public void configureBaudRate(String rate)

Set the baud rate.

Specified by:

configureBaudRate in interface SerialPortAdapter

Overrides:

configureBaudRate in class SerialDriverAdapter

validOption1

public String[] validOption1()

Option 1 is not used for anything

Specified by:

validOption1 in interface PortAdapter

Specified by:

validOption1 in interface SerialPortAdapter

Overrides:

validOption1 in class SerialDriverAdapter

option1Name

public String option1Name()

Option 1 not used, so return a null string.

Specified by:

option1Name in interface PortAdapter

Specified by:

option1Name in interface SerialPortAdapter

Overrides:

option1Name in class SerialDriverAdapter

configureOption1

public void configureOption1(String value)

The first port option isn't used, so just ignore this call.

Specified by:

configureOption1 in interface PortAdapter

Specified by:

configureOption1 in interface SerialPortAdapter

Overrides:

configureOption1 in class SerialDriverAdapter

validOption2

public String[] validOption2()

Get an array of valid values for "option 2"; used to display valid options. May not be null, but may have zero entries

Specified by:

validOption2 in interface PortAdapter

Specified by:

validOption2 in interface SerialPortAdapter

Overrides:

validOption2 in class SerialDriverAdapter

option2Name

public String option2Name()

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

Specified by:

option2Name in interface PortAdapter

Specified by:

option2Name in interface SerialPortAdapter

Overrides:

option2Name in class SerialDriverAdapter

instance

public static SerialDriverAdapter instance()