jmri.jmrix
Interface PortAdapter

All Known Subinterfaces:

NetworkPortAdapter, SerialPortAdapter, XNetPortController

All Known Implementing Classes:

AbstractNetworkPortAdapter, AbstractNetworkPortController, AbstractPortController, AbstractSerialPortController, AcelaPortController, CanUsbDriverAdapter, EasyDccNetworkPortController, EasyDccPortController, EcosPortController, EliteAdapter, GcPortController, GcSerialDriverAdapter, IntelliboxAdapter, InternalAdapter, JMRIClientPortController, LI100Adapter, LI100Adapter, LI101Adapter, LIUSBAdapter, LIUSBServerAdapter, LnHexFilePort, LnNetworkPortController, LnPortController, LnTcpDriverAdapter, LocoBufferAdapter, LocoBufferIIAdapter, LocoBufferUsbAdapter, MrcPortController, MS100Adapter, Mx1Adapter, Mx1PortController, NceNetworkPortController, NcePortController, NetworkDriverAdapter, NetworkDriverAdapter, NetworkDriverAdapter, NetworkDriverAdapter, NetworkDriverAdapter, NetworkDriverAdapter, Port, PortController, PortController, PR2Adapter, PR3Adapter, QsiPortController, RfidPortController, SerialAdapter, 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, SimDriverAdapter, SimulatorAdapter, SimulatorAdapter, SpecificDriverAdapter, SpecificDriverAdapter, SpecificDriverAdapter, SpeedoPortController, SprogCSSerialDriverAdapter, SprogPortController, SRCPPortController, UsbDriverAdapter, XNetNetworkPortController, XNetSerialPortController, XNetSimulatorAdapter, XNetSimulatorPortController, 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, 2010

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.
void	dispose()
String	getCurrentOption1Setting()
String	getCurrentOption2Setting() Get current option 2 value
String	getCurrentPortName()
boolean	getDisabled() Return the disabled state of the adapter
DataInputStream	getInputStream()
String	getManufacturer() Return the System Manufacturers Name
DataOutputStream	getOutputStream()
SystemConnectionMemo	getSystemConnectionMemo()
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
void	setDisabled(boolean disabled) Sets whether the connection is disabled
void	setManufacturer(String Manufacturer) Set the System Manufacturers Name
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

getCurrentPortName

String getCurrentPortName()

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

getManufacturer

String getManufacturer()

Return the System Manufacturers Name

setManufacturer

void setManufacturer(String Manufacturer)

Set the System Manufacturers Name

getDisabled

boolean getDisabled()

Return the disabled state of the adapter

setDisabled

void setDisabled(boolean disabled)

Sets whether the connection is disabled

getSystemConnectionMemo

SystemConnectionMemo getSystemConnectionMemo()

dispose

void dispose()