Package jmri.jmrix.loconet.pr4

Class PR4Adapter

java.lang.Object

jmri.jmrix.AbstractPortController

jmri.jmrix.AbstractSerialPortController

jmri.jmrix.loconet.LnPortController

jmri.jmrix.loconet.locobuffer.LocoBufferAdapter

jmri.jmrix.loconet.pr4.PR4Adapter

All Implemented Interfaces:

PortAdapter, SerialPortAdapter

public class PR4Adapter
extends LocoBufferAdapter

Override LocoBufferAdapter so that it refers to the (switch) settings on the Digitrax PR4.

Based on PR3Adapter.java

Nested Class Summary

Nested classes/interfaces inherited from class jmri.jmrix.AbstractPortController

AbstractPortController.Option

Field Summary

Fields inherited from class jmri.jmrix.loconet.locobuffer.LocoBufferAdapter

validOption1, validSpeeds, validSpeedValues

Fields inherited from class jmri.jmrix.loconet.LnPortController

commandStationNames, commandStationType, commandStationTypes, mInterrogateAtStart, mLoconetProtocolAutoDetect, mTranspondingAvailable, mTurnoutExtraSpace, mTurnoutNoRetry

Fields inherited from class jmri.jmrix.AbstractSerialPortController

mBaudRate, mPort

Fields inherited from class jmri.jmrix.AbstractPortController

allowConnectionRecovery, manufacturerName, option1Name, option2Name, option3Name, option4Name, options, reconnectinterval, reconnectMaxAttempts, reconnectMaxInterval

Constructor Summary

Constructors

Constructor	Description
PR4Adapter()

Method Summary

Modifier and Type	Method	Description
java.lang.String[]	commandStationOptions()	The PR4 can be used as a "Standalone Programmer", or with various LocoNet command stations.
void	configure()	Set up all of the other objects to operate with a PR4 connected to this port.
int	defaultBaudIndex()	Get the index of the default port speed for this adapter from the validSpeeds and validRates arrays.
PR4SystemConnectionMemo	getSystemConnectionMemo()	Get the SystemConnectionMemo associated with this object.
protected void	setSerialPort(purejavacomm.SerialPort activeSerialPort)	Sets up the serial port characteristics.
int[]	validBaudNumbers()	Get an array of valid baud rate numbers; used to store/load adapter speed option.
java.lang.String[]	validBaudRates()	Get an array of valid baud rate strings; used to display valid options in Connections Preferences.

Methods inherited from class jmri.jmrix.loconet.locobuffer.LocoBufferAdapter

getCommandStationListWithStandaloneLN, getInputStream, getOutputStream, getPacketizer, getPacketizerOption, getPortNames, okToSend, openPort, status

Methods inherited from class jmri.jmrix.loconet.LnPortController

setCommandStationType, setCommandStationType, setInterrogateOnStart, setLoconetProtocolAutoDetect, setTranspondingAvailable, setTurnoutHandling

Methods inherited from class jmri.jmrix.AbstractSerialPortController

closeConnection, configureBaudRate, configureBaudRateFromIndex, configureBaudRateFromNumber, configureLeadsAndFlowControl, configureLeadsAndFlowControl, connect, currentBaudNumber, getCurrentBaudIndex, getCurrentBaudNumber, getCurrentBaudRate, getCurrentPortName, handlePortBusy, handlePortNotFound, reconnectFromLoop, resetupConnection, setPort, setPortEventLogging

Methods inherited from class jmri.jmrix.AbstractPortController

configureOption1, configureOption2, configureOption3, configureOption4, dispose, getDisabled, getManufacturer, getOption1Name, getOption2Name, getOption3Name, getOption4Name, getOptionChoices, getOptionDisplayName, getOptions, getOptionState, getReconnectMaxAttempts, getReconnectMaxInterval, getSystemPrefix, getUserName, isDirty, isOptionAdvanced, isOptionTypePassword, isOptionTypeText, isRestartRequired, purgeStream, reconnect, recover, safeSleep, setClosed, setDisabled, setManufacturer, setOpened, setOptionState, setReconnectMaxAttempts, setReconnectMaxInterval, setSystemConnectionMemo, setSystemPrefix, setUserName

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.jmrix.PortAdapter

dispose, getDisabled, getOption1Name, getOption2Name, getOption3Name, getOption4Name, getOptionChoices, getOptionDisplayName, getOptions, getOptionState, getReconnectMaxAttempts, getReconnectMaxInterval, getSystemPrefix, getUserName, isDirty, isOptionAdvanced, isOptionTypePassword, isOptionTypeText, isRestartRequired, recover, setDisabled, setOptionState, setReconnectMaxAttempts, setReconnectMaxInterval, setSystemConnectionMemo, setSystemPrefix, setUserName

Methods inherited from interface jmri.jmrix.SerialPortAdapter

configureOption1, configureOption2, configureOption3, configureOption4, getManufacturer, setManufacturer

Constructor Detail

PR4Adapter

public PR4Adapter()

Method Detail

setSerialPort

protected void setSerialPort(purejavacomm.SerialPort activeSerialPort)
                      throws purejavacomm.UnsupportedCommOperationException

Sets up the serial port characteristics. Always uses flow control, which is not considered a user-settable option. Sets the PR4 for the appropriate operating mode, based on the selected "command station type".

Overrides:

setSerialPort in class LocoBufferAdapter

Parameters:

activeSerialPort - the port to be configured

Throws:

purejavacomm.UnsupportedCommOperationException - Usually if the hardware isn't present or capable

configure

public void configure()

Set up all of the other objects to operate with a PR4 connected to this port. This overrides the version in loconet.locobuffer, but it has to duplicate much of the functionality there, so the code is basically copied. Note that the PR4 does not support "LocoNet Data Signal termination" when in LocoNet interface mode (i.e. MS100 mode).

Specified by:

configure in interface PortAdapter

Specified by:

configure in interface SerialPortAdapter

Overrides:

configure in class LocoBufferAdapter

validBaudRates

public java.lang.String[] validBaudRates()

Get an array of valid baud rate strings; used to display valid options in Connections Preferences.

Specified by:

validBaudRates in interface SerialPortAdapter

Overrides:

validBaudRates in class LocoBufferAdapter

Returns:

String[] containing the single valid baud rate, "57,600".

validBaudNumbers

public int[] validBaudNumbers()

Get an array of valid baud rate numbers; used to store/load adapter speed option.

Specified by:

validBaudNumbers in interface SerialPortAdapter

Overrides:

validBaudNumbers in class LocoBufferAdapter

Returns:

int[] containing the single valid baud rate, 57600.

defaultBaudIndex

public int defaultBaudIndex()

Description copied from interface: SerialPortAdapter

Get the index of the default port speed for this adapter from the validSpeeds and validRates arrays.

Specified by:

defaultBaudIndex in interface SerialPortAdapter

Overrides:

defaultBaudIndex in class LocoBufferAdapter

Returns:

-1 to indicate not supported, unless overridden in adapter

commandStationOptions

public java.lang.String[] commandStationOptions()

The PR4 can be used as a "Standalone Programmer", or with various LocoNet command stations. The PR4 does not support "LocoNet Data signal termination", so that is not added as a valid option (as it would be for the PR3).

Returns:

an array of strings containing the various command station names and name(s) of modes without command stations

getSystemConnectionMemo

public PR4SystemConnectionMemo 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 LnPortController

Returns:

the currently associated SystemConnectionMemo