Package jmri.jmrix.lenz.li100f

Class LI100fAdapter

java.lang.Object

jmri.jmrix.AbstractPortController

jmri.jmrix.AbstractSerialPortController

jmri.jmrix.lenz.XNetSerialPortController

jmri.jmrix.lenz.li100f.LI100fAdapter

All Implemented Interfaces:

XNetPortController, PortAdapter, SerialPortAdapter

public class LI100fAdapter
extends XNetSerialPortController

Provide access to XpressNet via a LI100F on an attached serial com port. Normally controlled by the lenz.li100.LI100Frame class.

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 java.lang.String[]	validOption1
protected java.lang.String[]	validSpeeds
protected int[]	validSpeedValues

Fields inherited from class jmri.jmrix.lenz.XNetSerialPortController

validOption2

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

Method Summary

Modifier and Type	Method	Description
void	configure()	Set up all of the other objects to operate with a LI100 connected to this port.
int	defaultBaudIndex()	Get the index of the default port speed for this adapter from the validSpeeds and validRates arrays.
java.lang.String	openPort(java.lang.String portName, java.lang.String appName)	Open a specified port.
java.lang.String	option1Name()	option1 controls flow control option.
boolean	status()	Query the status of this connection.
int[]	validBaudNumbers()	Get an array of valid baud rate numbers; used to store/load adapter speed option.
java.lang.String[]	validBaudRates()	Get an array of valid baud rate strings; used to display valid options in Connections Preferences.
java.lang.String[]	validOption1()

Methods inherited from class jmri.jmrix.lenz.XNetSerialPortController

getSystemConnectionMemo, hasTimeSlot, okToSend, setCheckBuffer, setOutputBufferEmpty, setTimeSlot

Methods inherited from class jmri.jmrix.AbstractSerialPortController

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

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, isDirty, isOptionAdvanced, isOptionTypePassword, isOptionTypeText, isRestartRequired, 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, getInputStream, getOption1Name, getOption2Name, getOption3Name, getOption4Name, getOptionChoices, getOptionDisplayName, getOptions, getOptionState, getOutputStream, getReconnectMaxAttempts, getReconnectMaxInterval, getSystemPrefix, getUserName, isDirty, isOptionAdvanced, isOptionTypePassword, isOptionTypeText, isRestartRequired, recover, setDisabled, setOptionState, setReconnectMaxAttempts, setReconnectMaxInterval, setSystemConnectionMemo, setSystemPrefix, setUserName

Methods inherited from interface jmri.jmrix.SerialPortAdapter

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

Field Detail

validSpeeds

protected final java.lang.String[] validSpeeds

validSpeedValues

protected final int[] validSpeedValues

validOption1

protected final java.lang.String[] validOption1

Constructor Detail

LI100fAdapter

public LI100fAdapter()

Method Detail

openPort

public java.lang.String openPort(java.lang.String portName,
                                 java.lang.String appName)

Description copied from interface: SerialPortAdapter

Open a specified port.

Parameters:

portName - name tu use for this port

appName - provided to the underlying OS during startup so that it can show on status displays, etc.

Returns:

null indicates OK return, else error message.

configure

public void configure()

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

status

public boolean status()

Description copied from class: AbstractPortController

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

Specified by:

status in interface XNetPortController

Overrides:

status in class AbstractPortController

Returns:

true if OK, at least as far as known

validBaudRates

public java.lang.String[] validBaudRates()

Get an array of valid baud rate strings; used to display valid options in Connections Preferences.

Specified by:

validBaudRates in interface SerialPortAdapter

Overrides:

validBaudRates in class AbstractSerialPortController

Returns:

array of I18N display strings of port speed settings valid for this serial adapter, must match order and values from SerialPortAdapter.validBaudNumbers()

validBaudNumbers

public int[] validBaudNumbers()

Get an array of valid baud rate numbers; used to store/load adapter speed option.

Specified by:

validBaudNumbers in interface SerialPortAdapter

Overrides:

validBaudNumbers in class AbstractSerialPortController

Returns:

integer array of speeds, must match order and values from SerialPortAdapter.validBaudRates()

option1Name

public java.lang.String option1Name()

option1 controls flow control option.

Returns:

human readable string, uses IFTypeLI100F .

validOption1

public java.lang.String[] validOption1()

defaultBaudIndex

public int defaultBaudIndex()

Description copied from interface: SerialPortAdapter

Get the index of the default port speed for this adapter from the validSpeeds and validRates arrays.

Specified by:

defaultBaudIndex in interface SerialPortAdapter

Overrides:

defaultBaudIndex in class AbstractSerialPortController

Returns:

-1 to indicate not supported, unless overridden in adapter