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 port
NOTE: This currently only supports the SPROG Command Station interfaces.
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class jmri.jmrix.AbstractPortController
AbstractPortController.Option -
Field Summary
Fields inherited from class jmri.jmrix.AbstractStreamPortController
_name, input, outputFields inherited from class jmri.jmrix.AbstractPortController
allowConnectionRecovery, manufacturerName, opened, option1Name, option2Name, option3Name, option4Name, options, reconnectinterval, reconnectMaxAttempts, reconnectMaxInterval -
Constructor Summary
ConstructorsConstructorDescriptionSprogCSStreamPortController(DataInputStream in, DataOutputStream out, String pname) -
Method Summary
Modifier and TypeMethodDescriptionvoidvoidConfigure all of the other jmrix widgets needed to work with this adapter.Get theSystemConnectionMemoassociated with this object.booleanokToSend()Can the port accept additional characters?voidvoidSend a message through the interface.booleanstatus()Check that this object is ready to operate.Methods inherited from class jmri.jmrix.AbstractStreamPortController
connect, connect, dispose, getCurrentPortName, getInputStream, getOutputStream, recoverMethods 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 Details
-
SprogCSStreamPortController
-
SprogCSStreamPortController
public SprogCSStreamPortController()
-
-
Method Details
-
configure
Description copied from interface:PortAdapterConfigure all of the other jmrix widgets needed to work with this adapter.- Specified by:
configurein interfacePortAdapter
-
status
Check that this object is ready to operate. This is a question of configuration, not transient hardware status.- Specified by:
statusin interfacePortAdapter- Specified by:
statusin interfaceSprogInterface- Overrides:
statusin classAbstractPortController- Returns:
- true if OK, at least as far as known
-
okToSend
Can the port accept additional characters?- Returns:
- true
-
addSprogListener
- Specified by:
addSprogListenerin interfaceSprogInterface
-
removeSprogListener
- Specified by:
removeSprogListenerin interfaceSprogInterface
-
sendSprogMessage
Description copied from interface:SprogInterfaceSend a message through the interface.- Specified by:
sendSprogMessagein interfaceSprogInterface- Parameters:
m- Message to be sent.l- Listener to be notified of reply.
-
getSystemConnectionMemo
Description copied from class:AbstractPortControllerGet theSystemConnectionMemoassociated 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:
getSystemConnectionMemoin interfacePortAdapter- Overrides:
getSystemConnectionMemoin classAbstractPortController- Returns:
- the currently associated SystemConnectionMemo
-