Package jmri.jmrix.serialsensor

Class SerialSensorAdapter

java.lang.Object

jmri.jmrix.AbstractPortController

jmri.jmrix.AbstractSerialPortController

jmri.jmrix.serialsensor.SerialSensorAdapter

All Implemented Interfaces:

PortAdapter, SerialPortAdapter

public class SerialSensorAdapter
extends AbstractSerialPortController

Implements SerialPortAdapter for connecting to two sensors via the serial port. Sensor "1" will be via DCD, and sensor "2" via DSR

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	SerialSensorAdapter.SerialNotifier	Internal class to remember the Message object and destination listener when a message is queued for notification.

Nested classes/interfaces inherited from class jmri.jmrix.AbstractSerialPortController

AbstractSerialPortController.FlowControl, AbstractSerialPortController.Parity

Nested classes/interfaces inherited from class jmri.jmrix.AbstractPortController

AbstractPortController.Option

Field Summary

Fields

Modifier and Type	Field	Description
(package private) purejavacomm.SerialPort	activeSerialPort
(package private) java.io.InputStream	serialStream

Fields inherited from class jmri.jmrix.AbstractSerialPortController

currentSerialPort, mBaudRate, mPort

Fields inherited from class jmri.jmrix.AbstractPortController

allowConnectionRecovery, manufacturerName, option1Name, option2Name, option3Name, option4Name, options, reconnectinterval, reconnectMaxAttempts, reconnectMaxInterval

Constructor Summary

Constructors

Constructor	Description
SerialSensorAdapter()

Method Summary

Modifier and Type	Method	Description
void	configure()	Configure all of the other jmrix widgets needed to work with this adapter.
int	defaultBaudIndex()	Get the index of the default port speed for this adapter from the validSpeeds and validRates arrays.
java.io.DataInputStream	getInputStream()	Get the InputStream from the port.
java.io.DataOutputStream	getOutputStream()	Get the outputStream to the port.
void	notify(java.lang.String sensor, boolean value)	Do a sensor change on the event queue.
java.lang.String	openPort(java.lang.String portName, java.lang.String appName)	Open a specified port.
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.

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, handlePortBusy, handlePortNotFound, handlePortNotFound, reconnectFromLoop, reportPortStatus, resetupConnection, setBaudRate, setDataListener, setFlowControl, setParity, setPort, setPortEventLogging

Methods inherited from class jmri.jmrix.AbstractPortController

configureOption1, configureOption2, configureOption3, configureOption4, dispose, getDisabled, getManufacturer, getOption1Name, getOption2Name, getOption3Name, getOption4Name, getOptionChoices, getOptionDisplayName, getOptions, getOptionState, getReconnectMaxAttempts, getReconnectMaxInterval, getSystemConnectionMemo, getSystemPrefix, getUserName, isDirty, isOptionAdvanced, isOptionTypePassword, isOptionTypeText, isRestartRequired, purgeStream, reconnect, 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

dispose, getDisabled, getOption1Name, getOption2Name, getOption3Name, getOption4Name, getOptionChoices, getOptionDisplayName, getOptions, getOptionState, getReconnectMaxAttempts, getReconnectMaxInterval, getSystemConnectionMemo, 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

activeSerialPort

purejavacomm.SerialPort activeSerialPort

serialStream

java.io.InputStream serialStream

Constructor Detail

SerialSensorAdapter

public SerialSensorAdapter()

Method Detail

configure

public void configure()

Description copied from interface: SerialPortAdapter

Configure all of the other jmrix widgets needed to work with this adapter.

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.

getInputStream

public java.io.DataInputStream getInputStream()

Description copied from class: AbstractPortController

Get the InputStream from the port.

Specified by:

getInputStream in interface PortAdapter

Overrides:

getInputStream in class AbstractSerialPortController

Returns:

the InputStream from the port

getOutputStream

public java.io.DataOutputStream getOutputStream()

Description copied from class: AbstractPortController

Get the outputStream to the port.

Specified by:

getOutputStream in interface PortAdapter

Overrides:

getOutputStream in class AbstractSerialPortController

Returns:

the outputStream to the 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

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. Currently only 19,200 bps.

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

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

notify

public void notify(java.lang.String sensor,
                   boolean value)

Do a sensor change on the event queue.

Parameters:

sensor - sensor

value - true if sensor changes on, else false.