Package jmri.jmrix.dccpp

Interface DCCppPortController

All Superinterfaces:

PortAdapter

All Known Implementing Classes:

DCCppAdapter, DCCppEthernetAdapter, DCCppNetworkPortController, DCCppSerialPortController, DCCppSimulatorAdapter, DCCppSimulatorPortController, DCCppStreamPortController, DCCppTcpDriverAdapter

public interface DCCppPortController
extends PortAdapter

interface for DCCppPortController objects.

Method Summary

Modifier and Type	Method	Description
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 not
boolean	status()	Check that this object is ready to operate.

Methods inherited from interface jmri.jmrix.PortAdapter

configure, configureOption1, configureOption2, configureOption3, configureOption4, connect, dispose, getCurrentPortName, getDisabled, getInputStream, getManufacturer, getOption1Name, getOption2Name, getOption3Name, getOption4Name, getOptionChoices, getOptionDisplayName, getOptions, getOptionState, getOutputStream, getReconnectMaxAttempts, getReconnectMaxInterval, getSystemConnectionMemo, getSystemPrefix, getUserName, isDirty, isOptionAdvanced, isOptionTypePassword, isOptionTypeText, isRestartRequired, recover, setDisabled, setManufacturer, setOptionState, setReconnectMaxAttempts, setReconnectMaxInterval, setSystemConnectionMemo, setSystemPrefix, setUserName

Method Detail

status

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

Returns:

true if OK, at least as far as known

okToSend

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.

Returns:

true if OK to send, else false.

setOutputBufferEmpty

void setOutputBufferEmpty(boolean s)

We need a way to say if the output buffer is empty or not

Parameters:

s - true to set buffer empty, else false.