jmri.jmrix.can.adapters.gridconnect
Class GcSerialDriverAdapter

java.lang.Object
  jmri.jmrix.AbstractPortController
      jmri.jmrix.can.adapters.gridconnect.GcPortController
          jmri.jmrix.can.adapters.gridconnect.GcSerialDriverAdapter

All Implemented Interfaces:

PortAdapter, SerialPortAdapter

Direct Known Subclasses:

SerialDriverAdapter, SerialDriverAdapter

public class GcSerialDriverAdapter
extends GcPortController
implements SerialPortAdapter

Implements SerialPortAdapter for the GridConnect protocol.

Author:

Bob Jacobsen Copyright (C) 2001, 2002, Andrew Crosland Copyright (C) 2008

Field Summary

protected String	mOpt1
protected String[]	validSpeeds
protected int[]	validSpeedValues

Fields inherited from class jmri.jmrix.AbstractPortController

mBaudRate, mOpt2, mPort

Constructor Summary

GcSerialDriverAdapter()

Method Summary

void	configure() set up all of the other objects to operate with a CAN RS adapter connected to this port
void	configureOption1(String value) Set the CAN protocol option.
String	getCurrentOption1Setting()
DataInputStream	getInputStream()
DataOutputStream	getOutputStream()
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.
int[]	validBaudValues() And the corresponding values.
String[]	validOption1() Option 1 is CAN-based protocol

Methods inherited from class jmri.jmrix.AbstractPortController

configureBaudRate, configureOption2, currentBaudNumber, getCurrentBaudRate, getCurrentOption2Setting, getCurrentPortName, getPortNames, handlePortBusy, handlePortNotFound, option2Name, reloadDriver, setPort, validBaudNumber, 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

configureBaudRate, configureOption2, getCurrentBaudRate, getCurrentOption2Setting, getCurrentPortName, getPortNames, handlePortBusy, option2Name, setPort, validOption2

Field Detail

validSpeeds

protected String[] validSpeeds

validSpeedValues

protected int[] validSpeedValues

mOpt1

protected String mOpt1

Constructor Detail

GcSerialDriverAdapter

public GcSerialDriverAdapter()

Method Detail

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

configure

public void configure()

set up all of the other objects to operate with a CAN RS adapter connected to this port

Specified by:

configure in interface PortAdapter

Specified by:

configure in interface SerialPortAdapter

getInputStream

public DataInputStream getInputStream()

Specified by:

getInputStream in interface PortAdapter

Specified by:

getInputStream in class GcPortController

getOutputStream

public DataOutputStream getOutputStream()

Specified by:

getOutputStream in interface PortAdapter

Specified by:

getOutputStream in class GcPortController

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

Specified by:

status in class GcPortController

validBaudRates

public String[] validBaudRates()

Get an array of valid baud rates.

Specified by:

validBaudRates in interface SerialPortAdapter

validBaudValues

public int[] validBaudValues()

And the corresponding values.

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