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

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

Author:

Bob Jacobsen Copyright (C) 2003

Field Summary

Fields inherited from class jmri.jmrix.AbstractSerialPortController

mBaudRate, mPort

Fields inherited from class jmri.jmrix.AbstractPortController

mDisabled, mManufacturer, mOpt1, mOpt2

Constructor Summary

SerialSensorAdapter()

Method Summary

void	configure() Configure all of the other jmrix widgets needed to work with this adapter
void	configureBaudRate(String rate) Set the baud rate.
void	configureOption1(String value) The first port option isn't used, so just ignore this call.
void	configureOption2(String value) Set the second port option.
DataInputStream	getInputStream()
DataOutputStream	getOutputStream()
void	notify(String sensor, boolean value) Do a sensor change on the event queue
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
boolean	status() Query the status of this connection.
String[]	validBaudRates() Get an array of valid baud rates.
String[]	validOption1() Since option 1 is not used for this, return an array with just a single string
String[]	validOption2() Get an array of valid values for "option 2"; used to display valid options.

Methods inherited from class jmri.jmrix.AbstractSerialPortController

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

Methods inherited from class jmri.jmrix.AbstractPortController

getCurrentOption1Setting, getCurrentOption2Setting, getDisabled, getManufacturer, setManufacturer

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

getCurrentBaudRate, getCurrentOption1Setting, getCurrentOption2Setting, getCurrentPortName, getManufacturer, getPortNames, handlePortBusy, setManufacturer, setPort

Methods inherited from interface jmri.jmrix.PortAdapter

dispose, getDisabled, getSystemConnectionMemo, setDisabled

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

Specified by:

configure in interface PortAdapter

Specified by:

configure 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

getInputStream

public DataInputStream getInputStream()

Specified by:

getInputStream in interface PortAdapter

Specified by:

getInputStream in class AbstractPortController

getOutputStream

public DataOutputStream getOutputStream()

Specified by:

getOutputStream in interface PortAdapter

Specified by:

getOutputStream in class AbstractPortController

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

Overrides:

status in class AbstractPortController

validBaudRates

public String[] validBaudRates()

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

Specified by:

validBaudRates in interface SerialPortAdapter

configureBaudRate

public void configureBaudRate(String rate)

Set the baud rate. This currently does nothing, as there's only one possible value

Specified by:

configureBaudRate in interface SerialPortAdapter

Overrides:

configureBaudRate in class AbstractSerialPortController

validOption1

public String[] validOption1()

Since option 1 is not used for this, return an array with just a single string

Specified by:

validOption1 in interface PortAdapter

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 PortAdapter

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 PortAdapter

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

configureOption2

public void configureOption2(String value)

Set the second port option. Only to be used after construction, but before the openPort call

Specified by:

configureOption2 in interface PortAdapter

Specified by:

configureOption2 in interface SerialPortAdapter

Overrides:

configureOption2 in class AbstractPortController

notify

public void notify(String sensor,
                   boolean value)

Do a sensor change on the event queue