Package jmri.jmrix.sprog
Class SprogCSStreamPortController
- java.lang.Object
-
- jmri.jmrix.AbstractPortController
-
- jmri.jmrix.AbstractStreamPortController
-
- jmri.jmrix.sprog.SprogCSStreamPortController
-
- All Implemented Interfaces:
PortAdapter
,SprogInterface
public class SprogCSStreamPortController extends AbstractStreamPortController implements SprogInterface
Abstract base for classes representing an SPROG Command Station communications portNOTE: This currently only supports the SPROG Command Station interfaces.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
SprogCSStreamPortController.RcvCheck
-
Nested classes/interfaces inherited from class jmri.jmrix.AbstractPortController
AbstractPortController.Option
-
-
Field Summary
-
Fields inherited from class jmri.jmrix.AbstractStreamPortController
_name, input, output
-
Fields inherited from class jmri.jmrix.AbstractPortController
allowConnectionRecovery, manufacturerName, opened, option1Name, option2Name, option3Name, option4Name, options, reconnectinterval, reconnectMaxAttempts, reconnectMaxInterval
-
-
Constructor Summary
Constructors Constructor Description SprogCSStreamPortController()
SprogCSStreamPortController(java.io.DataInputStream in, java.io.DataOutputStream out, java.lang.String pname)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addSprogListener(SprogListener l)
void
configure()
Configure all of the other jmrix widgets needed to work with this adapter.SprogSystemConnectionMemo
getSystemConnectionMemo()
Get theSystemConnectionMemo
associated with this object.boolean
okToSend()
Can the port accept additional characters?void
removeSprogListener(SprogListener l)
void
sendSprogMessage(SprogMessage m, SprogListener l)
Send a message through the interface.boolean
status()
Check that this object is ready to operate.-
Methods inherited from class jmri.jmrix.AbstractStreamPortController
connect, connect, dispose, getCurrentPortName, getInputStream, getOutputStream, recover
-
Methods inherited from class jmri.jmrix.AbstractPortController
closeConnection, configureOption1, configureOption2, configureOption3, configureOption4, getDisabled, getManufacturer, getOption1Name, getOption2Name, getOption3Name, getOption4Name, getOptionChoices, getOptionDisplayName, getOptions, getOptionState, getReconnectMaxAttempts, getReconnectMaxInterval, getSystemPrefix, getUserName, isDirty, isOptionAdvanced, isOptionTypePassword, isOptionTypeText, isRestartRequired, purgeStream, reconnect, reconnectFromLoop, resetupConnection, safeSleep, setClosed, setDisabled, setManufacturer, setOpened, setOptionState, setReconnectMaxAttempts, setReconnectMaxInterval, setSystemConnectionMemo, setSystemPrefix, setUserName
-
-
-
-
Constructor Detail
-
SprogCSStreamPortController
public SprogCSStreamPortController(java.io.DataInputStream in, java.io.DataOutputStream out, java.lang.String pname)
-
SprogCSStreamPortController
public SprogCSStreamPortController()
-
-
Method Detail
-
configure
public void configure()
Description copied from interface:PortAdapter
Configure all of the other jmrix widgets needed to work with this adapter.- Specified by:
configure
in interfacePortAdapter
-
status
public boolean status()
Check that this object is ready to operate. This is a question of configuration, not transient hardware status.- Specified by:
status
in interfacePortAdapter
- Specified by:
status
in interfaceSprogInterface
- Overrides:
status
in classAbstractPortController
- Returns:
- true if OK, at least as far as known
-
okToSend
public boolean okToSend()
Can the port accept additional characters?- Returns:
- true
-
addSprogListener
public void addSprogListener(SprogListener l)
- Specified by:
addSprogListener
in interfaceSprogInterface
-
removeSprogListener
public void removeSprogListener(SprogListener l)
- Specified by:
removeSprogListener
in interfaceSprogInterface
-
sendSprogMessage
public void sendSprogMessage(SprogMessage m, SprogListener l)
Description copied from interface:SprogInterface
Send a message through the interface.- Specified by:
sendSprogMessage
in interfaceSprogInterface
- Parameters:
m
- Message to be sent.l
- Listener to be notified of reply.
-
getSystemConnectionMemo
public SprogSystemConnectionMemo getSystemConnectionMemo()
Description copied from class:AbstractPortController
Get theSystemConnectionMemo
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 interfacePortAdapter
- Overrides:
getSystemConnectionMemo
in classAbstractPortController
- Returns:
- the currently associated SystemConnectionMemo
-
-