jmri.jmrix
Interface PortAdapter

All Known Subinterfaces:

SerialPortAdapter

All Known Implementing Classes:

AbstractPortController, AcelaPortController, EasyDccPortController, EcosPortController, EliteAdapter, GcPortController, GcSerialDriverAdapter, IntelliboxAdapter, LI100Adapter, LI100Adapter, LI101Adapter, LIUSBAdapter, LIUSBServerAdapter, LnHexFilePort, LnPortController, LnTcpDriverAdapter, LocoBufferAdapter, LocoBufferIIAdapter, LocoBufferUsbAdapter, MrcPortController, MS100Adapter, Mx1Adapter, Mx1PortController, NcePortController, NetworkDriverAdapter, NetworkDriverAdapter, NetworkDriverAdapter, NetworkDriverAdapter, NetworkPortAdapter, Port, PortController, PortController, PR2Adapter, PR3Adapter, QsiPortController, SerialAdapter, SerialDriverAdapter, SerialDriverAdapter, SerialDriverAdapter, SerialDriverAdapter, SerialDriverAdapter, SerialDriverAdapter, SerialDriverAdapter, SerialDriverAdapter, SerialDriverAdapter, SerialDriverAdapter, SerialDriverAdapter, SerialDriverAdapter, SerialDriverAdapter, SerialDriverAdapter, SerialDriverAdapter, SerialDriverAdapter, SerialDriverAdapter, SerialDriverAdapter, SerialDriverAdapter, SerialDriverAdapter, SerialDriverAdapter, SerialDriverAdapter, SerialDriverAdapter, SerialPortController, SerialPortController, SerialPortController, SerialPortController, SerialPortController, SerialPortController, SerialPortController, SerialSensorAdapter, SprogPortController, SRCPPortController, UsbDriverAdapter, XNetPortController, XNetSimulatorAdapter, XnTcpAdapter, XpaPortController, ZTC640Adapter

public interface PortAdapter

Enables basic setup of a interface for a jmrix implementation.

This has no e.g. serial-specific information.

Since:

2.3.1

Author:

Bob Jacobsen Copyright (C) 2001, 2003, 2008

See Also:

SerialConfigException

Method Summary

void	configure() Configure all of the other jmrix widgets needed to work with this adapter
void	configureOption1(String value) * Set the first port option.
void	configureOption2(String value) * Set the second port option.
String	getCurrentOption1Setting()
String	getCurrentOption2Setting() * Get current option 2 value
DataInputStream	getInputStream()
DataOutputStream	getOutputStream()
String	option1Name() * Get a String that says what Option 1 represents * May be an empty string, but will not be null
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[]	validOption1() Get an array of valid values for "option 1"; used to display valid options
String[]	validOption2() Get an array of valid values for "option 2"; used to display valid options

Method Detail

configure

void configure()

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

status

boolean status()

Query the status of this connection. If all OK, at least as far as is known, return true

getInputStream

DataInputStream getInputStream()

getOutputStream

DataOutputStream getOutputStream()

validOption1

String[] validOption1()

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

option1Name

String option1Name()

* Get a String that says what Option 1 represents * May be an empty string, but will not be null

configureOption1

void configureOption1(String value)

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

getCurrentOption1Setting

String getCurrentOption1Setting()

validOption2

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

option2Name

String option2Name()

* Get a String that says what Option 2 represents * May be an empty string, but will not be null

configureOption2

void configureOption2(String value)

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

getCurrentOption2Setting

String getCurrentOption2Setting()

* Get current option 2 value