Package jmri.jmrix.dccpp
Class DCCppStreamPortController
- java.lang.Object
-
- jmri.jmrix.AbstractPortController
-
- jmri.jmrix.AbstractStreamPortController
-
- jmri.jmrix.dccpp.DCCppStreamPortController
-
- All Implemented Interfaces:
DCCppPortController
,PortAdapter
public class DCCppStreamPortController extends AbstractStreamPortController implements DCCppPortController
Abstract base for classes representing a DCCpp communications port
-
-
Nested Class Summary
-
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 DCCppStreamPortController()
DCCppStreamPortController(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
configure()
Configure all of the other jmrix widgets needed to work with this adapter.DCCppSystemConnectionMemo
getSystemConnectionMemo()
Get theSystemConnectionMemo
associated with this object.boolean
okToSend()
Can the port accept additional characters?void
setOutputBufferEmpty(boolean s)
we need a way to say if the output buffer is empty or full this should only be set to false by external processesboolean
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
-
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
configureOption1, configureOption2, configureOption3, configureOption4, connect, dispose, getCurrentPortName, getDisabled, getInputStream, getManufacturer, getOption1Name, getOption2Name, getOption3Name, getOption4Name, getOptionChoices, getOptionDisplayName, getOptions, getOptionState, getOutputStream, getReconnectMaxAttempts, getReconnectMaxInterval, getSystemPrefix, getUserName, isDirty, isOptionAdvanced, isOptionTypePassword, isOptionTypeText, isRestartRequired, recover, setDisabled, setManufacturer, setOptionState, setReconnectMaxAttempts, setReconnectMaxInterval, setSystemConnectionMemo, setSystemPrefix, setUserName
-
-
-
-
Constructor Detail
-
DCCppStreamPortController
public DCCppStreamPortController(java.io.DataInputStream in, java.io.DataOutputStream out, java.lang.String pname)
-
DCCppStreamPortController
public DCCppStreamPortController()
-
-
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
-
getSystemConnectionMemo
public DCCppSystemConnectionMemo 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
-
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 interfaceDCCppPortController
- Specified by:
status
in interfacePortAdapter
- Overrides:
status
in classAbstractPortController
- Returns:
- true if OK, at least as far as known
-
okToSend
public boolean okToSend()
Can the port accept additional characters?- Specified by:
okToSend
in interfaceDCCppPortController
- Returns:
- true if OK to send, else false.
-
setOutputBufferEmpty
public void setOutputBufferEmpty(boolean s)
we need a way to say if the output buffer is empty or full this should only be set to false by external processes- Specified by:
setOutputBufferEmpty
in interfaceDCCppPortController
- Parameters:
s
- true to set buffer empty, else false.
-
-