jmri.jmrix.oaktree.serialdriver
Class SerialDriverAdapter

java.lang.Object
  jmri.jmrix.AbstractPortController
      jmri.jmrix.oaktree.SerialPortController
          jmri.jmrix.oaktree.serialdriver.SerialDriverAdapter

All Implemented Interfaces:

PortAdapter, SerialPortAdapter

public class SerialDriverAdapter
extends SerialPortController
implements SerialPortAdapter

Provide access to Oak Tree via a serial comm port. Normally controlled by the oaktree.serialdriver.SerialDriverFrame class.

Author:

Bob Jacobsen Copyright (C) 2006

Field Summary

protected String	selectedSpeed
protected String[]	validSpeeds
protected int[]	validSpeedValues

Fields inherited from class jmri.jmrix.AbstractPortController

mBaudRate, mOpt1, mOpt2, mPort

Constructor Summary

SerialDriverAdapter()

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()
Vector	getPortNames() Provide a vector of valid port names, each a String.
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.AbstractPortController

configureOption2, currentBaudNumber, getCurrentBaudRate, getCurrentOption1Setting, getCurrentOption2Setting, getCurrentPortName, handlePortBusy, handlePortNotFound, setPort, validBaudNumber

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, handlePortBusy, setPort

Field Detail

validSpeeds

protected String[] validSpeeds

validSpeedValues

protected int[] validSpeedValues

selectedSpeed

protected String selectedSpeed

Constructor Detail

SerialDriverAdapter

public SerialDriverAdapter()

Method Detail

getPortNames

public Vector getPortNames()

Description copied from interface: SerialPortAdapter

Provide a vector of valid port names, each a String.

Specified by:

getPortNames in interface SerialPortAdapter

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

okToSend

public boolean okToSend()

Can the port accept additional characters? Yes, always

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

getInputStream

public DataInputStream getInputStream()

Specified by:

getInputStream in class SerialPortController

getOutputStream

public DataOutputStream getOutputStream()

Specified by:

getOutputStream in class SerialPortController

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 SerialPortController

setSerialPort

protected void setSerialPort()
                      throws javax.comm.UnsupportedCommOperationException

Local method to do specific port configuration

Throws:

javax.comm.UnsupportedCommOperationException

validBaudRates

public String[] validBaudRates()

Get an array of valid baud rates.

Specified by:

validBaudRates in interface SerialPortAdapter

configureBaudRate

public void configureBaudRate(String rate)

Set the baud rate.

Specified by:

configureBaudRate in interface SerialPortAdapter

Overrides:

configureBaudRate in class AbstractPortController

validOption1

public String[] validOption1()

Option 1 is not used for anything

Specified by:

validOption1 in interface SerialPortAdapter

Overrides:

validOption1 in class AbstractPortController

option1Name

public String option1Name()

Option 1 not used, so return a null string.

Specified by:

option1Name in interface SerialPortAdapter

Overrides:

option1Name in class AbstractPortController

configureOption1

public void configureOption1(String value)

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

Specified by:

configureOption1 in interface SerialPortAdapter

Overrides:

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

Overrides:

option2Name in class AbstractPortController

instance

public static SerialDriverAdapter instance()