jmri.jmrix.can.adapters.loopback
Class Port

java.lang.Object
  jmri.jmrix.AbstractPortController
      jmri.jmrix.AbstractSerialPortController
          jmri.jmrix.can.adapters.loopback.Port

All Implemented Interfaces:

PortAdapter, SerialPortAdapter

public class Port
extends AbstractSerialPortController

Loopback connection to simulate a CAN link

Author:

Bob Jacobsen Copyright (C) 2008, 2010

Field Summary

Fields inherited from class jmri.jmrix.AbstractSerialPortController

mBaudRate, mPort

Fields inherited from class jmri.jmrix.AbstractPortController

mDisabled, mManufacturer, mOpt1, mOpt2, opened

Constructor Summary

Port()

Method Summary

void	configure() Configure all of the other jmrix widgets needed to work with this adapter
void	configureOption1(String value) Set the CAN protocol option.
String	getCurrentOption1Setting()
DataInputStream	getInputStream()
DataOutputStream	getOutputStream()
Vector<String>	getPortNames() Provide a vector of valid port names, each a String.
static Port	instance()
String	openPort(String portName, String appName) Open a specified port.
String	option1Name() Get a String that says what Option 1 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; used to display valid options.
String[]	validOption1() Option 1 is CAN-based protocol

Methods inherited from class jmri.jmrix.AbstractSerialPortController

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

Methods inherited from class jmri.jmrix.AbstractPortController

configureOption2, getCurrentOption2Setting, getDisabled, getManufacturer, option2Name, setManufacturer, validOption2

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

configureOption2, getCurrentOption2Setting, getManufacturer, option2Name, setManufacturer, validOption2

Methods inherited from interface jmri.jmrix.PortAdapter

getDisabled

Constructor Detail

Port

public Port()

Method Detail

configure

public void configure()

Description copied from interface: SerialPortAdapter

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

validOption1

public String[] validOption1()

Option 1 is CAN-based protocol

Specified by:

validOption1 in interface PortAdapter

Specified by:

validOption1 in interface SerialPortAdapter

Overrides:

validOption1 in class AbstractPortController

option1Name

public String option1Name()

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

Specified by:

option1Name in interface PortAdapter

Specified by:

option1Name in interface SerialPortAdapter

Overrides:

option1Name in class AbstractPortController

configureOption1

public void configureOption1(String value)

Set the CAN protocol option.

Specified by:

configureOption1 in interface PortAdapter

Specified by:

configureOption1 in interface SerialPortAdapter

Overrides:

configureOption1 in class AbstractPortController

getCurrentOption1Setting

public String getCurrentOption1Setting()

Specified by:

getCurrentOption1Setting in interface PortAdapter

Specified by:

getCurrentOption1Setting in interface SerialPortAdapter

Overrides:

getCurrentOption1Setting 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

instance

public static Port instance()

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

validBaudRates

public String[] validBaudRates()

Description copied from interface: SerialPortAdapter

Get an array of valid baud rates; used to display valid options.

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

getPortNames

public Vector<String> getPortNames()

Description copied from interface: SerialPortAdapter

Provide a vector of valid port names, each a String.

Specified by:

getPortNames in interface SerialPortAdapter

Overrides:

getPortNames in class AbstractSerialPortController