jmri.jmrix.loconet

Class LnPortController

Show UML class diagram

java.lang.Object

jmri.jmrix.AbstractPortController

jmri.jmrix.AbstractSerialPortController

jmri.jmrix.loconet.LnPortController

All Implemented Interfaces:

PortAdapter, SerialPortAdapter

Direct Known Subclasses:

LnHexFilePort, LocoBufferAdapter, LocoNetBluetoothAdapter, MS100Adapter

public abstract class LnPortController
extends AbstractSerialPortController

Base for classes representing a LocoNet communications port.

Method Summary

Modifier and Type	Method and Description
abstract DataInputStream	getInputStream() Get the InputStream from the port.
abstract DataOutputStream	getOutputStream() Get the outputStream to the port.
LocoNetSystemConnectionMemo	getSystemConnectionMemo() Get the SystemConnectionMemo associated with this object.
boolean	okToSend() Can the port accept additional characters?
void	setCommandStationType(LnCommandStationType value) Set config info from the command station type enum.
void	setCommandStationType(String name) Set config info from a name, which needs to be one of the valid ones.
void	setTranspondingAvailable(String value)
void	setTurnoutHandling(String value)
abstract boolean	status() Check that this object is ready to operate.

Methods inherited from class jmri.jmrix.AbstractSerialPortController

configureBaudRate, configureBaudRateFromIndex, configureBaudRateFromNumber, connect, currentBaudNumber, defaultBaudIndex, dispose, getCurrentBaudIndex, getCurrentBaudNumber, getCurrentBaudRate, getCurrentPortName, getPortNames, handlePortBusy, handlePortNotFound, reconnect, recover, setPort, validBaudNumbers, validBaudRates

Methods inherited from class jmri.jmrix.AbstractPortController

configureOption1, configureOption2, configureOption3, configureOption4, getDisabled, getManufacturer, getOption1Name, getOption2Name, getOption3Name, getOption4Name, getOptionChoices, getOptionDisplayName, getOptions, getOptionState, getSystemPrefix, getUserName, isDirty, isOptionAdvanced, isRestartRequired, setDisabled, setManufacturer, setOptionState, setSystemConnectionMemo, setSystemPrefix, setUserName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jmri.jmrix.SerialPortAdapter

configure, configureOption1, configureOption2, configureOption3, configureOption4, getManufacturer, openPort, setManufacturer

Methods inherited from interface jmri.jmrix.PortAdapter

getDisabled, getOption1Name, getOption2Name, getOption3Name, getOption4Name, getOptionChoices, getOptionDisplayName, getOptions, getOptionState, getSystemPrefix, getUserName, isDirty, isOptionAdvanced, isRestartRequired, setDisabled, setOptionState, setSystemConnectionMemo, setSystemPrefix, setUserName

Method Detail

getInputStream

public abstract DataInputStream getInputStream()

Description copied from class: AbstractPortController

Get the InputStream from the port.

Specified by:

getInputStream in interface PortAdapter

Specified by:

getInputStream in class AbstractPortController

Returns:

the InputStream from the port

getOutputStream

public abstract DataOutputStream getOutputStream()

Description copied from class: AbstractPortController

Get the outputStream to the port.

Specified by:

getOutputStream in interface PortAdapter

Specified by:

getOutputStream in class AbstractPortController

Returns:

the outputStream to the port

status

public abstract boolean status()

Check that this object is ready to operate. This is a question of configuration, not transient hardware status.

Specified by:

status in interface PortAdapter

Specified by:

status in interface SerialPortAdapter

Overrides:

status in class AbstractPortController

Returns:

true if OK, at least as far as known

okToSend

public boolean okToSend()

Can the port accept additional characters? This might go false for short intervals, but it might also stick off if something goes wrong.

Provide a default implementation for the MS100, etc.

Returns:

_always_ true, as we rely on the queueing in the port itself

setCommandStationType

public void setCommandStationType(String name)

Set config info from a name, which needs to be one of the valid ones.

Parameters:

name - the name of the command station type

setCommandStationType

public void setCommandStationType(LnCommandStationType value)

Set config info from the command station type enum.

Parameters:

value - the LnCommandStationType

setTurnoutHandling

public void setTurnoutHandling(String value)

setTranspondingAvailable

public void setTranspondingAvailable(String value)

getSystemConnectionMemo

public LocoNetSystemConnectionMemo getSystemConnectionMemo()

Description copied from class: AbstractPortController

Get the SystemConnectionMemo associated with this object.

This method should only be overridden to ensure that a specific subclass of SystemConnectionMemo is returned. The recommended pattern is: public MySystemConnectionMemo getSystemConnectionMemo() { return (MySystemConnectionMemo) super.getSystemConnectionMemo(); }

Specified by:

getSystemConnectionMemo in interface PortAdapter

Overrides:

getSystemConnectionMemo in class AbstractPortController

Returns:

the currently associated SystemConnectionMemo