Package jmri.jmrix.lenz

Class XNetSerialPortController

java.lang.Object
jmri.jmrix.AbstractPortController
jmri.jmrix.AbstractSerialPortController
jmri.jmrix.lenz.XNetSerialPortController
All Implemented Interfaces:
XNetPortController, PortAdapter, SerialPortAdapter
Direct Known Subclasses:
EliteAdapter, LI100Adapter, LI100fAdapter, LI101Adapter, LIUSBAdapter, ZTC611Adapter, ZTC640Adapter
public abstract class XNetSerialPortController extends AbstractSerialPortController implements XNetPortController
Abstract base for classes representing an XNet communications port

  • Field Details

  • Constructor Details

  • Method Details

    • okToSend

      public boolean okToSend()
      Can the port accept additional characters? The state of CTS determines this, as there seems to be no way to check the number of queued bytes and buffer length. This might go false for short intervals, but it might also stick off if something goes wrong.
      Specified by:
      okToSend in interface XNetPortController
      Returns:
      true if OK to send, else false.

    • hasTimeSlot

      public boolean hasTimeSlot()
      Indicate whether the Command Station is currently providing a timeslot to this port controller.
      Specified by:
      hasTimeSlot in interface XNetPortController
      Returns:
      true if the command station is currently providing a timeslot.

    • setTimeSlot

      public 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.

      Specified by:
      setTimeSlot in interface XNetPortController
      Parameters:
      timeslot - true if a timeslot is being sent, false otherwise.

    • 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 interface XNetPortController
      Parameters:
      s - true to set buffer empty, else false.

    • setCheckBuffer

      protected void setCheckBuffer(boolean b)
      Allow derived classes to set the private checkBuffer value.
      Parameters:
      b - new checkBuffer value

    • getSystemConnectionMemo

      public XNetSystemConnectionMemo getSystemConnectionMemo()
      Description copied from class: AbstractPortController
      Get the SystemConnectionMemo 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 interface PortAdapter
      Overrides:
      getSystemConnectionMemo in class AbstractPortController
      Returns:
      the currently associated SystemConnectionMemo