jmri.jmrix.xpa.serialdriver
Class SerialDriverAdapter

java.lang.Object
  jmri.jmrix.AbstractPortController
      jmri.jmrix.AbstractSerialPortController
          jmri.jmrix.xpa.XpaPortController
              jmri.jmrix.xpa.serialdriver.SerialDriverAdapter

All Implemented Interfaces:

PortAdapter, SerialPortAdapter

public class SerialDriverAdapter
extends XpaPortController
implements SerialPortAdapter

Implements SerialPortAdapter for a modem connected to an XPA.

This connects an XPA+Modem connected to an XPressNet based command station via a serial com port. Normally controlled by the SerialDriverFrame class.

The current implementation only handles the 9,600 baud rate. It uses the first configuraiont variable for the modem initilization string.

Author:

Paul Bender Copyright (C) 2004

Field Summary

Fields inherited from class jmri.jmrix.AbstractSerialPortController

mBaudRate, mPort

Fields inherited from class jmri.jmrix.AbstractPortController

mDisabled, mManufacturer, mOpt1, mOpt2

Constructor Summary

SerialDriverAdapter()

Method Summary

void	configure() set up all of the other objects to operate with an XPA+Modem Connected to an XPressNet based command station connected to this port
DataInputStream	getInputStream()
String	getManufacturer() Get and set of the Manufacturer for network (TCP/IP) based connections is handled by the ConnectionConfig code in each connector.
DataOutputStream	getOutputStream()
static SerialDriverAdapter	instance()
String	openPort(String portName, String appName) Open a specified port.
String	option1Name() Option 1 is the Initilization String
String	option2Name() Get a String that says what Option 2 represents May be an empty string, but will not be null
void	setManufacturer(String manu) Set the System Manufacturers Name
boolean	status() Query the status of this connection.
String[]	validBaudRates() Get an array of valid baud rates.
String[]	validOption1() Option 1 contains the initilization string
String[]	validOption2() Get an array of valid values for "option 2"; used to display valid options.

Methods inherited from class jmri.jmrix.AbstractSerialPortController

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

Methods inherited from class jmri.jmrix.AbstractPortController

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

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

Methods inherited from interface jmri.jmrix.PortAdapter

dispose, getDisabled, getSystemConnectionMemo, setDisabled

Constructor Detail

SerialDriverAdapter

public SerialDriverAdapter()

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

configure

public void configure()

set up all of the other objects to operate with an XPA+Modem Connected to an XPressNet based command station connected to this port

Specified by:

configure in interface PortAdapter

Specified by:

configure in interface SerialPortAdapter

getInputStream

public DataInputStream getInputStream()

Specified by:

getInputStream in interface PortAdapter

Specified by:

getInputStream in class XpaPortController

getOutputStream

public DataOutputStream getOutputStream()

Specified by:

getOutputStream in interface PortAdapter

Specified by:

getOutputStream in class XpaPortController

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

Specified by:

status in class XpaPortController

validBaudRates

public String[] validBaudRates()

Get an array of valid baud rates. This is currently only 19,200 bps

Specified by:

validBaudRates in interface SerialPortAdapter

validOption1

public String[] validOption1()

Option 1 contains the initilization string

Specified by:

validOption1 in interface PortAdapter

Specified by:

validOption1 in interface SerialPortAdapter

Overrides:

validOption1 in class AbstractPortController

option1Name

public String option1Name()

Option 1 is the Initilization String

Specified by:

option1Name in interface PortAdapter

Specified by:

option1Name in interface SerialPortAdapter

Overrides:

option1Name in class AbstractPortController

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 AbstractPortController

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 AbstractPortController

instance

public static SerialDriverAdapter instance()

getManufacturer

public String getManufacturer()

Description copied from class: AbstractPortController

Get and set of the Manufacturer for network (TCP/IP) based connections is handled by the ConnectionConfig code in each connector. this is here as we implement the serialdriveradpter.

Specified by:

getManufacturer in interface PortAdapter

Specified by:

getManufacturer in interface SerialPortAdapter

Overrides:

getManufacturer in class AbstractPortController

setManufacturer

public void setManufacturer(String manu)

Description copied from interface: PortAdapter

Set the System Manufacturers Name

Specified by:

setManufacturer in interface PortAdapter

Specified by:

setManufacturer in interface SerialPortAdapter

Overrides:

setManufacturer in class AbstractPortController