jmri.jmrix.lenz.li100f
Class LI100Adapter

java.lang.Object
  jmri.jmrix.AbstractPortController
      jmri.jmrix.lenz.XNetPortController
          jmri.jmrix.lenz.li100f.LI100Adapter

All Implemented Interfaces:

PortAdapter, SerialPortAdapter

public class LI100Adapter
extends XNetPortController
implements SerialPortAdapter

Provide access to XPressNet via a LI100 on an attached serial comm port. Normally controlled by the lenz.li100.LI100Frame class.

Author:

Bob Jacobsen Copyright (C) 2002, Portions by Paul Bender, Copyright (C) 2003

Field Summary

protected String[]	validOption1
protected String[]	validSpeeds
protected int[]	validSpeedValues

Fields inherited from class jmri.jmrix.lenz.XNetPortController

validOption2

Fields inherited from class jmri.jmrix.AbstractPortController

mBaudRate, mOpt1, mOpt2, mPort

Constructor Summary

LI100Adapter()

Method Summary

void	configure() set up all of the other objects to operate with a LI100 connected to this port
DataInputStream	getInputStream()
DataOutputStream	getOutputStream()
static LI100Adapter	instance()
boolean	okToSend() Can the port accept additional characters?
String	openPort(String portName, String appName) Open a specified port.
String	option1Name() Option 1 controls flow control option
void	setOutputBufferEmpty(boolean s) we need a way to say if the output buffer is empty or full this should only be set to false by external processes
protected void	setSerialPort() Local method to do specific configuration
boolean	status() Check that this object is ready to operate.
String[]	validBaudRates() Get an array of valid baud rates.
String[]	validOption1() Get an array of valid values for "option 1"; used to display valid options.

Methods inherited from class jmri.jmrix.lenz.XNetPortController

option2Name, validOption2

Methods inherited from class jmri.jmrix.AbstractPortController

configureBaudRate, configureOption1, configureOption2, currentBaudNumber, getCurrentBaudRate, getCurrentOption1Setting, getCurrentOption2Setting, getCurrentPortName, getPortNames, handlePortBusy, handlePortNotFound, reloadDriver, 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

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

Field Detail

validSpeeds

protected String[] validSpeeds

validSpeedValues

protected int[] validSpeedValues

validOption1

protected String[] validOption1

Constructor Detail

LI100Adapter

public LI100Adapter()

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

setOutputBufferEmpty

public void setOutputBufferEmpty(boolean s)

we need a way to say if the output buffer is empty or full this should only be set to false by external processes

Specified by:

setOutputBufferEmpty in class XNetPortController

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.

Specified by:

okToSend in class XNetPortController

configure

public void configure()

set up all of the other objects to operate with a LI100 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 XNetPortController

getOutputStream

public DataOutputStream getOutputStream()

Specified by:

getOutputStream in interface PortAdapter

Specified by:

getOutputStream in class XNetPortController

status

public boolean status()

Description copied from class: XNetPortController

Check that this object is ready to operate. This is a question of configuration, not transient hardware status.

Specified by:

status in interface PortAdapter

Specified by:

status in interface SerialPortAdapter

Specified by:

status in class XNetPortController

setSerialPort

protected void setSerialPort()
                      throws UnsupportedCommOperationException

Local method to do specific configuration

Throws:

UnsupportedCommOperationException

validBaudRates

public String[] validBaudRates()

Get an array of valid baud rates. This is currently just a message saying its fixed

Specified by:

validBaudRates in interface SerialPortAdapter

option1Name

public String option1Name()

Option 1 controls flow control option

Specified by:

option1Name in interface PortAdapter

Specified by:

option1Name in interface SerialPortAdapter

Overrides:

option1Name in class AbstractPortController

validOption1

public String[] validOption1()

Description copied from class: AbstractPortController

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

Specified by:

validOption1 in interface PortAdapter

Specified by:

validOption1 in interface SerialPortAdapter

Overrides:

validOption1 in class AbstractPortController

instance

public static LI100Adapter instance()