Package jmri

Interface ProgListener

All Superinterfaces:
EventListener
All Known Implementing Classes:
AbstractIdentify, AbstractProgrammerServer, AccessoryOpsModeProgrammerFacade, AddressedHighCvProgrammerFacade, BasicESUTableSpeedMatcher, BasicSimpleCVSpeedMatcher, BasicSpeedMatcher, BasicSpeedTableSpeedMatcher, ConsistController, CvValue, Dcc4PcOpsModeProgrammer.ProxyProgList, DccConsist, DualDecoderSelectPane, EasyDccConsist, IdentifyDecoder, IdentifyLoco, JmriSRCPProgrammerServer, LocoNetConsist, MqttConsist, MultiIndexProgrammerFacade, NceConsist, NmraConsist, OffsetHighCvProgrammerFacade, OpsModeDelayedProgrammerFacade, PaneProgDp3Action, ResettingOffsetHighCvProgrammerFacade, SimpleProgFrame, SpeedMatcher, SpeedoConsoleFrame, SpeedStepScaleESUTableSpeedMatcher, SpeedStepScaleSpeedMatcher, SpeedStepScaleSpeedTableSpeedMatcher, TmccConsist, TwoIndexTcsProgrammerFacade, VerifyWriteProgrammerFacade, WiFiConsist, XNetConsist
public interface ProgListener extends EventListener
Allow notification of the completion of programming operations.

This allows a Programmer object to return delayed status, including the CV value from a read operation. For simplicity, expect these to be returned to be on the GUI thread. See the discussion in the Programmer.readCV(...), Programmer.writeCV(...) and Programmer.confirmCV(...) methods.

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.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CommError
    Constant denoting that a communications error occurred between the command station and the PC during programming
    static final int
    ConfirmFailed
    Constant denoting that confirm failed, likely due to another value being present
    static final int
    FailedTimeout
    Constant denoting that the programming operation timed out
    static final int
    NoAck
    Constant denoting there was no acknowledge from the locomotive, so the CV may or may not have been written on a write.
    static final int
    NoLocoDetected
    Constant denoting that no decoder was detected on the programming track
    static final int
    NotImplemented
    Constant denoting that the request failed because it requested some unimplemented capability.
    static final int
    OK
    Constant denoting that the request completed correctly.
    static final int
    ProgrammerBusy
    Constant denoting that the request failed because the decoding hardware was already busy
    static final int
    ProgrammingShort
    Constant denoting that a short circuit occurred while programming
    static final int
    SequenceError
    Constant denoting that there was an error with the programming sequence (such as early exit)
    static final int
    UnknownError
    Constant denoting the request failed, but no specific reason is known
    static final int
    UserAborted
    Constant denoting that the user (human or software) aborted the request before completion

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    programmingOpReply(int value, int status)
    Receive a callback at the end of a programming operation.

  • Field Details

    • OK

      static final int OK
      Constant denoting that the request completed correctly. Note this is a specific value; all others are bitwise combinations
      See Also:

    • UnknownError

      static final int UnknownError
      Constant denoting the request failed, but no specific reason is known
      See Also:

    • NoLocoDetected

      static final int NoLocoDetected
      Constant denoting that no decoder was detected on the programming track
      See Also:

    • ProgrammerBusy

      static final int ProgrammerBusy
      Constant denoting that the request failed because the decoding hardware was already busy
      See Also:

    • NotImplemented

      static final int NotImplemented
      Constant denoting that the request failed because it requested some unimplemented capability. Note that this can also result in an exception during the original request; which happens is implementation dependent
      See Also:

    • UserAborted

      static final int UserAborted
      Constant denoting that the user (human or software) aborted the request before completion
      See Also:

    • NoAck

      static final int NoAck
      Constant denoting there was no acknowledge from the locomotive, so the CV may or may not have been written on a write. No value was read.
      See Also:

    • ConfirmFailed

      static final int ConfirmFailed
      Constant denoting that confirm failed, likely due to another value being present
      See Also:

    • FailedTimeout

      static final int FailedTimeout
      Constant denoting that the programming operation timed out
      See Also:

    • ProgrammingShort

      static final int ProgrammingShort
      Constant denoting that a short circuit occurred while programming
      See Also:

    • SequenceError

      static final int SequenceError
      Constant denoting that there was an error with the programming sequence (such as early exit)
      See Also:

    • CommError

      static final int CommError
      Constant denoting that a communications error occurred between the command station and the PC during programming
      See Also:

  • Method Details

    • programmingOpReply

      void programmingOpReply(int value, int status)
      Receive a callback at the end of a programming operation.
      Parameters:
      value - Value from a read operation, or value written on a write
      status - Denotes the completion code. Note that this is a bitwise combination of the various status coded defined in this interface.