Package jmri.jmrix.lenz

Interface XNetPortController

All Superinterfaces:

PortAdapter

All Known Implementing Classes:

EliteAdapter, LI100Adapter, LI100fAdapter, LI101Adapter, LIUSBAdapter, LIUSBEthernetAdapter, LIUSBServerAdapter, LZV200Adapter, XNetNetworkPortController, XNetSerialPortController, XNetSimulatorAdapter, XNetSimulatorPortController, XNetStreamPortController, XnTcpAdapter, Z21XNetStreamPortController, ZTC611Adapter, ZTC640Adapter

public interface XNetPortController
extends PortAdapter

Interface for XNetPortController objects.

Method Summary

Modifier and Type	Method	Description
boolean	hasTimeSlot()	Indicate the command station is currently providing a timeslot to this port controller.
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.
void	setTimeSlot(boolean timeslot)	Set a variable indicating whether or not the command station is providing a timeslot.
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.

hasTimeSlot

boolean hasTimeSlot()

Indicate the command station is currently providing a timeslot to this port controller.

Returns:

true if the command station is currently providing a timeslot.

setTimeSlot

void setTimeSlot(boolean timeslot)

Set a variable indicating whether or not the command station is providing a timeslot.

This method should be called with the paramter set to false if a "Command Station No Longer Providing a timeslot for communications" (01 05 04) is received.

This method should be called with the parameter set to true if a "Command Station is providing a timeslot for communications again." (01 07 06) is received.

Parameters:

timeslot - true if a timeslot is being sent, false otherwise.