Class DCCppProgrammer

All Implemented Interfaces:
EventListener, PropertyChangeFirer, PropertyChangeProvider, AbstractMRListener, DCCppListener, Programmer

public class DCCppProgrammer
extends AbstractProgrammer
implements DCCppListener
Programmer support for DCC++.

The read operation state sequence is:

  • Send Register Mode / Paged mode /Direct Mode read request
  • Wait for results reply, interpret
  • Field Details

  • Constructor Details

  • Method Details

    • getSupportedModes

      Get the list of ProgrammingMode supported by this Programmer. If the order is significant, earlier modes are better.
      Specified by:
      getSupportedModes in interface Programmer
      Specified by:
      getSupportedModes in class AbstractProgrammer
      Returns:
      the list of supported modes or an empty list
    • getCanRead

      public boolean getCanRead​(String addr)
      Checks the general read capability, regardless of mode, for a specific address Checks using the current default programming mode Can we read from a specific CV in the specified mode? Answer may not be correct if the command station type and version sent by the command station mimics one of the known command stations.
      Specified by:
      getCanRead in interface Programmer
      Overrides:
      getCanRead in class AbstractProgrammer
      Parameters:
      addr - the address to read
      Returns:
      true if the address can be read; false otherwise
    • getCanWrite

      public boolean getCanWrite​(String addr)
      Checks the general write capability, regardless of mode, for a specific address Checks using the current default programming mode. Can we write to a specific CV in the specified mode? Answer may not be correct if the command station type and version sent by the command station mimics one of the known command stations.
      Specified by:
      getCanWrite in interface Programmer
      Overrides:
      getCanWrite in class AbstractProgrammer
      Parameters:
      addr - the address to write to
      Returns:
      true if the address can be written to; false otherwise
    • getWriteConfirmMode

      Learn about whether the programmer does any kind of verification of write operations By default, say that no verification is done.
      Specified by:
      getWriteConfirmMode in interface Programmer
      Overrides:
      getWriteConfirmMode in class AbstractProgrammer
      Parameters:
      addr - A CV address to check (in case this varies with CV range) or null for any
      Returns:
      Always WriteConfirmMode.NotVerified
    • writeCV

      public void writeCV​(String CVname, int val, ProgListener p) throws ProgrammerException
      Perform a CV write in the system-specific manner, and using the specified programming mode.

      Handles a general address space through a String address. Each programmer defines the acceptable formats.

      Note that this returns before the write is complete; you have to provide a ProgListener to hear about completion. For simplicity, expect the return to be on the GUI thread.

      Exceptions will only be thrown at the start, not during the actual programming sequence. A typical exception would be due to an invalid mode (though that should be prevented earlier)

      Specified by:
      writeCV in interface Programmer
      Specified by:
      writeCV in class AbstractProgrammer
      Parameters:
      CVname - the CV to write
      val - the value to write
      p - the listener that will be notified of the write
      Throws:
      ProgrammerException - if unable to communicate
    • confirmCV

      public void confirmCV​(String CV, int val, ProgListener p) throws ProgrammerException
      Confirm the value of a CV using the specified programming mode. On some systems, this is faster than a read.

      Handles a general address space through a String address. Each programmer defines the acceptable formats.

      Note that this returns before the write is complete; you have to provide a ProgListener to hear about completion. For simplicity, expect the return to be on the GUI thread.

      Exceptions will only be thrown at the start, not during the actual programming sequence. A typical exception would be due to an invalid mode (though that should be prevented earlier)

      Specified by:
      confirmCV in interface Programmer
      Specified by:
      confirmCV in class AbstractProgrammer
      Parameters:
      CV - the CV to confirm
      val - the value to confirm
      p - the listener that will be notified of the confirmation
      Throws:
      ProgrammerException - if unable to communicate
    • readCV

      public void readCV​(String CVname, ProgListener p) throws ProgrammerException
      Perform a CV read in the system-specific manner, and using the specified programming mode.

      Handles a general address space through a String address. Each programmer defines the acceptable formats.

      Note that this returns before the write is complete; you have to provide a ProgListener to hear about completion. For simplicity, expect the return to be on the GUI thread.

      Exceptions will only be thrown at the start, not during the actual programming sequence. A typical exception would be due to an invalid mode (though that should be prevented earlier)

      Specified by:
      readCV in interface Programmer
      Specified by:
      readCV in class AbstractProgrammer
      Parameters:
      CVname - the CV to read
      p - the listener that will be notified of the read
      Throws:
      ProgrammerException - if unable to communicate
    • readCV

      public void readCV​(String CVname, ProgListener p, int startVal) throws ProgrammerException
      Perform a CV read in the system-specific manner, and using the specified programming mode, possibly using a hint of the current value to speed up programming.

      Handles a general address space through a String address. Each programmer defines the acceptable formats.

      On systems that support it, the startVal is a hint as to what the current value of the CV might be (e.g. the value from the roster). This could be verified immediately in direct byte mode to speed up the read process.

      Note that this returns before the write is complete; you have to provide a ProgListener to hear about completion. For simplicity, expect the return to be on the GUI thread.

      Defaults to the normal read method if not overridden in a specific implementation.

      Exceptions will only be thrown at the start, not during the actual programming sequence. A typical exception would be due to an invalid mode (though that should be prevented earlier)

      Specified by:
      readCV in interface Programmer
      Parameters:
      CVname - the CV to read
      p - the listener that will be notified of the read
      startVal - a hint of what the current value might be, or 0
      Throws:
      ProgrammerException - if unable to communicate
    • useProgrammer

      protected void useProgrammer​(ProgListener p) throws ProgrammerException
      Throws:
      ProgrammerException
    • message

      public void message​(DCCppReply m)
      Member function that will be invoked by a DCCppInterface implementation to forward a DCC++ message from the layout.
      Specified by:
      message in interface DCCppListener
      Parameters:
      m - The received DCC++ message. Note that this same object may be presented to multiple users. It should not be modified here.
    • message

      public void message​(DCCppMessage l)
      Member function that will be invoked by a DCCppInterface implementation to forward a DCC++ message sent to the layout. Normally, this function will do nothing.
      Specified by:
      message in interface DCCppListener
      Parameters:
      l - The received DCC++ message. Note that this same object may be presented to multiple users. It should not be modified here.
    • notifyTimeout

      public void notifyTimeout​(DCCppMessage msg)
      Description copied from interface: DCCppListener
      Member function invoked by an DCCppInterface implementation to notify a sender that an outgoing message timed out and was dropped from the queue.
      Specified by:
      notifyTimeout in interface DCCppListener
      Parameters:
      msg - the message that timed out.
    • programmerBusy

      public boolean programmerBusy()
    • timeout

      protected void timeout()
      Internal routine to handle a timeout, should be synchronized!
      Specified by:
      timeout in class AbstractProgrammer
    • notifyProgListenerEnd

      protected void notifyProgListenerEnd​(int value, int status)
    • controller