jmri
Interface ProgListener

Show UML class diagram

All Superinterfaces:

EventListener

All Known Implementing Classes:

AbstractIdentify, AbstractProgrammerServer, ConsistController, CvValue, Dcc4PcOpsModeProgrammer.ProxyProgList, DccConsist, DualDecoderSelectPane, EasyDccConsist, IdentifyDecoder, IdentifyLoco, JmriSRCPProgrammerServer, JsonProgrammerServer, LocoNetConsist, NceConsist, NmraConsist, PaneProgDp3Action, SimpleProgFrame, SpeedoConsoleFrame, 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.

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

static int	CommError Constant denoting that a communications error occured between the command station and the PC durring programming
static int	ConfirmFailed Constant denoting that confirm failed, likely due to another value being present
static int	FailedTimeout Constant denoting that the programming operation timed out
static 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 int	NoLocoDetected Constant denoting that no decoder was detected on the programming track
static int	NotImplemented Constant denoting that the request failed because it requested some unimplemented capability.
static int	OK Constant denoting that the request completed correctly.
static int	ProgrammerBusy Constant denoting that the request failed because the decoding hardware was already busy
static int	ProgrammingShort Constant denoting that a short circuit occured while programming
static int	SequenceError Constant denoting that there was an error with the programming sequence (e.g. early exit)
static int	UnknownError Constant denoting the request failed, but no specific reason is known
static int	UserAborted Constant denoting that the user (human or software) aborted the request before completion

Method Summary

void	programmingOpReply(int value, int status) Receive a callback at the end of a programming operation.

Field Detail

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:

Constant Field Values

UnknownError

static final int UnknownError

Constant denoting the request failed, but no specific reason is known

See Also:

Constant Field Values

NoLocoDetected

static final int NoLocoDetected

Constant denoting that no decoder was detected on the programming track

See Also:

Constant Field Values

ProgrammerBusy

static final int ProgrammerBusy

Constant denoting that the request failed because the decoding hardware was already busy

See Also:

Constant Field Values

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:

Constant Field Values

UserAborted

static final int UserAborted

Constant denoting that the user (human or software) aborted the request before completion

See Also:

Constant Field Values

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:

Constant Field Values

ConfirmFailed

static final int ConfirmFailed

Constant denoting that confirm failed, likely due to another value being present

See Also:

Constant Field Values

FailedTimeout

static final int FailedTimeout

Constant denoting that the programming operation timed out

See Also:

Constant Field Values

ProgrammingShort

static final int ProgrammingShort

Constant denoting that a short circuit occured while programming

See Also:

Constant Field Values

SequenceError

static final int SequenceError

Constant denoting that there was an error with the programming sequence (e.g. early exit)

See Also:

Constant Field Values

CommError

static final int CommError

Constant denoting that a communications error occured between the command station and the PC durring programming

See Also:

Constant Field Values

Method Detail

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.