Package jmri

Interface Programmer

All Superinterfaces:
Disposable
All Known Subinterfaces:
AddressedProgrammer
All Known Implementing Classes:
AbstractProgrammer, AbstractProgrammerFacade, AccessoryOpsModeProgrammerFacade, AddressedHighCvProgrammerFacade, BiDiBOpsModeProgrammer, BiDiBProgrammer, CbusDccOpsModeProgrammer, CbusDccProgrammer, Dcc4PcOpsModeProgrammer, DCCppOpsModeProgrammer, DCCppProgrammer, EasyDccOpsModeProgrammer, EasyDccProgrammer, EcosOpsModeProgrammer, EcosProgrammer, EliteXNetProgrammer, LI100XNetProgrammer, LnDeferProgrammer, LnOpsModeProgrammer, MrcOpsModeProgrammer, MrcProgrammer, MultiIndexProgrammerFacade, Mx1OpsModeProgrammer, Mx1Programmer, NceOpsModeProgrammer, NceProgrammer, OffsetHighCvProgrammerFacade, OlcbProgrammer, OpsModeDelayedProgrammerFacade, PermissionAddressedProgrammer, PermissionProgrammer, ProgDebugger, QsiProgrammer, ResettingOffsetHighCvProgrammerFacade, SlotManager, SprogOpsModeProgrammer, SprogProgrammer, SRCPProgrammer, TamsOpsModeProgrammer, TamsProgrammer, TmccOpsModeProgrammer, TmccProgrammer, TwoIndexTcsProgrammerFacade, UhlenbrockSlotManager, VerifyWriteProgrammerFacade, XNetOpsModeProgrammer, XNetProgrammer, Z21XNetOpsModeProgrammer, Z21XNetProgrammer
public interface Programmer extends Disposable
Provide access to the hardware DCC decoder programming capability.

Programmers come in multiple types:

  • Global, previously "Service Mode" or on a programming track
  • Addressed, previously "Ops Mode" also known as "programming on the main"
Different equipment may also require different programmers:
  • DCC CV programming, on service mode track or on the main
  • CBUS Node Variable programmers
  • LocoNet System Variable programmers
  • LocoNet Op Switch programmers
  • etc
Depending on which type you have, only certain modes can be set. Valid modes are specified by the class static constants.

You get a Programmer object from a GlobalProgrammerManager or an AddressedProgrammerManager, which in turn can be located from the InstanceManager.

Starting in JMRI 3.5.5, the CV addresses are Strings for generality. The methods that use ints for CV addresses will later be deprecated.

Added possibility to supply CV value hint to the system

This file is part of JMRI.

JMRI is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License as published by the Free Software Foundation. See the "COPYING" file for a copy of this license.

JMRI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

See Also:

  • Method Details

    • getConfigurator

      @CheckForNull default Programmer.Configurator getConfigurator()
      Get the configurator of this programmer.
      Returns:
      the configurator if it exists, otherwise null

    • writeCV

      void writeCV(String CV, 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)

      Parameters:
      CV - 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

    • readCV

      void readCV(String CV, 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)

      Parameters:
      CV - the CV to read
      p - the listener that will be notified of the read
      Throws:
      ProgrammerException - if unable to communicate

    • readCV

      default void readCV(String CV, 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)

      Parameters:
      CV - 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

    • confirmCV

      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)

      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

    • getSupportedModes

      @Nonnull List<ProgrammingMode> getSupportedModes()
      Get the list of ProgrammingMode supported by this Programmer. If the order is significant, earlier modes are better.
      Returns:
      the list of supported modes or an empty list

    • setMode

      void setMode(ProgrammingMode p)
      Set the programmer to a particular mode.

      Mode is a bound parameter; mode changes fire listeners.

      Only modes returned by getSupportedModes() are supported. If an invalid mode is requested, the active mode is unchanged.

      Parameters:
      p - a valid node returned by getSupportedModes() or null; null is ignored if getSupportedModes() is not empty

    • getMode

      ProgrammingMode getMode()
      Get the current programming mode
      Returns:
      the current mode or null if none is defined and no default mode is defined

    • getCanRead

      boolean getCanRead()
      Checks the general read capability, regardless of mode
      Returns:
      true if the programmer is capable of reading; false otherwise

    • getCanRead

      boolean getCanRead(String addr)
      Checks the general read capability, regardless of mode, for a specific address
      Parameters:
      addr - the address to read
      Returns:
      true if the address can be read; false otherwise

    • getCanWrite

      boolean getCanWrite()
      Checks the general write capability, regardless of mode
      Returns:
      true if the programmer is capable of writing; false otherwise

    • getCanWrite

      boolean getCanWrite(String addr)
      Checks the general write capability, regardless of mode, for a specific address
      Parameters:
      addr - the address to write to
      Returns:
      true if the address can be written to; false otherwise

    • getWriteConfirmMode

      @Nonnull Programmer.WriteConfirmMode getWriteConfirmMode(String addr)
      Learn about whether the programmer does any kind of verification of write operations
      Parameters:
      addr - A CV address to check (in case this varies with CV range) or null for any
      Returns:
      The confirmation behavior that can be counted on (might be better in some cases)

    • notifyProgListenerEnd

      default void notifyProgListenerEnd(ProgListener p, int value, int status)
      wrapper to call ProgListener.programmingOpReply(int, int) that verifies the specified progListener is not null.
      Parameters:
      p - listener to notify
      value - result value
      status - code from jmri.ProgListener

    • addPropertyChangeListener

      void addPropertyChangeListener(PropertyChangeListener p)

    • removePropertyChangeListener

      void removePropertyChangeListener(PropertyChangeListener p)

    • decodeErrorCode

      @Nonnull String decodeErrorCode(int i)

    • dispose

      default void dispose()
      Free up system resources. Overriding classes should be capable of this being called multiple times as per the Disposable interface. Called when disposing of a disposable.

      Note there are no assurances this method will not be called multiple times against a single instance of this Disposable. It is the responsibility of this Disposable to protect itself and the application from ensuring that calling this method multiple times has no unwanted side effects.

      Specified by:
      dispose in interface Disposable