jmri.jmrix.can.adapters.gridconnect.net
Class NetworkDriverAdapter

java.lang.Object
  jmri.jmrix.AbstractPortController
      jmri.jmrix.AbstractSerialPortController
          jmri.jmrix.can.adapters.gridconnect.net.NetworkDriverAdapter

All Implemented Interfaces:

PortAdapter, SerialPortAdapter

public class NetworkDriverAdapter
extends AbstractSerialPortController

Implements SerialPortAdapter for the OpenLCB system network connection.

This connects via a telnet connection. Normally controlled by the NetworkDriverFrame class.

Author:

Bob Jacobsen Copyright (C) 2010

Field Summary

Fields inherited from class jmri.jmrix.AbstractSerialPortController

mBaudRate, mPort

Fields inherited from class jmri.jmrix.AbstractPortController

mDisabled, mManufacturer, mOpt1, mOpt2

Constructor Summary

NetworkDriverAdapter()

Method Summary

void	configure() set up all of the other objects to operate with an NCE command station connected to this port
void	configureOption2(String value) Set the binary vs ASCII command set option.
void	connect(String host, int port)
String	getCurrentOption2Setting() Get current option 2 value
DataInputStream	getInputStream()
String	getManufacturer() Get and set of the Manufacturer for network (TCP/IP) based connections is handled by the ConnectionConfig code in each connector.
DataOutputStream	getOutputStream()
Vector<String>	getPortNames() Provide a vector of valid port names, each a String.
static NetworkDriverAdapter	instance()
String	openPort(String portName, String appName) Open a specified port.
String	option2Name() Get a String that says what Option 2 represents May be an empty string, but will not be null
void	setHostName(String hostName)
void	setManufacturer(String manu) Set the System Manufacturers Name
boolean	status() Query the status of this connection.
String[]	validBaudRates() Get an array of valid baud rates; used to display valid options.
String[]	validOption2() Option 2 is various filters

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

configureOption1, getCurrentOption1Setting, getDisabled, option1Name, validOption1

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

configureOption1, getCurrentOption1Setting, option1Name, validOption1

Methods inherited from interface jmri.jmrix.PortAdapter

getDisabled

Constructor Detail

NetworkDriverAdapter

public NetworkDriverAdapter()

Method Detail

configure

public void configure()

set up all of the other objects to operate with an NCE command station connected to this port

getInputStream

public DataInputStream getInputStream()

Specified by:

getInputStream in interface PortAdapter

Specified by:

getInputStream in class AbstractPortController

connect

public void connect(String host,
                    int port)

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

validOption2

public String[] validOption2()

Option 2 is various filters

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 binary vs ASCII command set option.

Specified by:

configureOption2 in interface PortAdapter

Specified by:

configureOption2 in interface SerialPortAdapter

Overrides:

configureOption2 in class AbstractPortController

getCurrentOption2Setting

public String getCurrentOption2Setting()

Description copied from interface: PortAdapter

Get current option 2 value

Specified by:

getCurrentOption2Setting in interface PortAdapter

Specified by:

getCurrentOption2Setting in interface SerialPortAdapter

Overrides:

getCurrentOption2Setting in class AbstractPortController

instance

public static NetworkDriverAdapter instance()

setHostName

public void setHostName(String hostName)

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

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

validBaudRates

public String[] validBaudRates()

Description copied from interface: SerialPortAdapter

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

getManufacturer

public String getManufacturer()

Description copied from class: AbstractPortController

Get and set of the Manufacturer for network (TCP/IP) based connections is handled by the ConnectionConfig code in each connector. this is here as we implement the serialdriveradpter.

Specified by:

getManufacturer in interface PortAdapter

Specified by:

getManufacturer in interface SerialPortAdapter

Overrides:

getManufacturer in class AbstractPortController

setManufacturer

public void setManufacturer(String manu)

Description copied from interface: PortAdapter

Set the System Manufacturers Name

Specified by:

setManufacturer in interface PortAdapter

Specified by:

setManufacturer in interface SerialPortAdapter

Overrides:

setManufacturer in class AbstractPortController