Package jmri.jmrix.sprog

Class SprogProgrammer

java.lang.Object
jmri.beans.PropertyChangeSupport
jmri.jmrix.AbstractProgrammer
jmri.jmrix.sprog.SprogProgrammer
All Implemented Interfaces:
EventListener, PropertyChangeFirer, PropertyChangeProvider, Disposable, SprogListener, SprogVersionListener, Programmer
Direct Known Subclasses:
SprogOpsModeProgrammer
public class SprogProgrammer extends AbstractProgrammer implements SprogListener, SprogVersionListener
Implement the jmri.Programmer interface via commands for the Sprog programmer. This provides a service mode programmer.

  • Field Details

  • Constructor Details

  • Method Details

    • getSupportedModes

      @Nonnull public List<ProgrammingMode> getSupportedModes()
      Get the list of ProgrammingMode supported by this Programmer. If the order is significant, earlier modes are better. Implemented Types.
      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()
      Checks the general read capability, regardless of mode Basic implementation. Override this to turn reading on and off globally.
      Specified by:
      getCanRead in interface Programmer
      Overrides:
      getCanRead in class AbstractProgrammer
      Returns:
      true if the programmer is capable of reading; false otherwise

    • 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

    • readCVWithDefault

      public void readCVWithDefault(String CVname, ProgListener p, int startVal) throws ProgrammerException
      Internal method to read a CV with a possible default value
      Parameters:
      CVname - Index of CV to read
      p - Programming listener
      startVal - CV default value, Use 0 if no default available
      Throws:
      ProgrammerException - if programming operation fails

    • useProgrammer

      protected void useProgrammer(ProgListener p) throws ProgrammerException
      Internal method to remember who's using the programmer.
      Parameters:
      p - Who gets reply
      Throws:
      ProgrammerException - when programmer in invalid state

    • progTaskStart

      protected SprogMessage progTaskStart(ProgrammingMode mode, int val, int cvnum, int startVal)
      Internal method to create the SprogMessage for programmer task start.
      Parameters:
      mode - Mode to be used
      val - value to be written
      cvnum - CV address to write to
      startVal - Hint of what the CV may contain, or 0
      Returns:
      formatted message to do programming operation

    • notifyMessage

      public void notifyMessage(SprogMessage m)
      Specified by:
      notifyMessage in interface SprogListener

    • notifyReply

      public void notifyReply(SprogReply reply)
      Specified by:
      notifyReply in interface SprogListener

    • notifyVersion

      public void notifyVersion(SprogVersion v) throws ProgrammerException
      Handle a SprogVersion notification.

      Decode the SPROG version and decode the programming capabilities.

      Specified by:
      notifyVersion in interface SprogVersionListener
      Parameters:
      v - The SprogVersion being handled
      Throws:
      ProgrammerException

    • timeout

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

    • notifyProgListenerEnd

      protected void notifyProgListenerEnd(int value, int status)

    • controller

      protected SprogTrafficController controller()