jmri.jmrix.sprog
Class SprogProgrammer

java.lang.Object
  jmri.jmrix.AbstractProgrammer
      jmri.jmrix.sprog.SprogProgrammer

All Implemented Interfaces:

EventListener, SprogListener, Programmer

Direct Known Subclasses:

SprogOpsModeProgrammer

public class SprogProgrammer
extends AbstractProgrammer
implements SprogListener

Implements the jmri.Programmer interface via commands for the Sprog programmer.

Author:

Bob Jacobsen Copyright (C) 2001

Field Summary

Fields inherited from class jmri.jmrix.AbstractProgrammer

LONG_TIMEOUT, propListeners, SHORT_TIMEOUT

Fields inherited from interface jmri.Programmer

ADDRESSMODE, CBUSNODEVARMODE, DIRECTBITMODE, DIRECTBYTEMODE, NONE, OPSACCBITMODE, OPSACCBYTEMODE, OPSACCEXTBITMODE, OPSACCEXTBYTEMODE, OPSBITMODE, OPSBYTEMODE, PAGEMODE, REGISTERMODE

Constructor Summary

SprogProgrammer()

Method Summary

void	confirmCV(int CV, int val, ProgListener p) Confirm the value of a CV using the specified programming mode.
protected SprogTrafficController	controller()
boolean	getCanRead()
int	getMode() Get the current programming mode
boolean	hasMode(int mode) Signifies mode's available
static SprogProgrammer	instance()
void	notifyMessage(SprogMessage m)
protected void	notifyProgListenerEnd(int value, int status)
protected void	notifyPropertyChange(String name, int oldval, int newval)
void	notifyReply(SprogReply reply)
protected SprogMessage	progTaskStart(int mode, int val, int cvnum)
void	readCV(int CV, ProgListener p) Perform a CV read in the system-specific manner, and using the specified programming mode.
void	setMode(int mode) Switch to a new programming mode.
protected void	timeout() Internal routine to handle a timeout
protected void	useProgrammer(ProgListener p)
void	writeCV(int CV, int val, ProgListener p) Perform a CV write in the system-specific manner, and using the specified programming mode.

Methods inherited from class jmri.jmrix.AbstractProgrammer

addPropertyChangeListener, decodeErrorCode, registerFromCV, removePropertyChangeListener, restartTimer, startLongTimer, startShortTimer, stopTimer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SprogProgrammer

public SprogProgrammer()

Method Detail

instance

public static final SprogProgrammer instance()

setMode

public void setMode(int mode)

Switch to a new programming mode. SPROG currently supports bit direct and paged mode. If you attempt to switch to any others, the new mode will set & notify, then set back to the original. This lets the listeners know that a change happened, and then was undone.

Specified by:

setMode in interface Programmer

Parameters:

mode - The new mode, use values from the jmri.Programmer interface

hasMode

public boolean hasMode(int mode)

Signifies mode's available

Specified by:

hasMode in interface Programmer

Parameters:

mode -

Returns:

True if paged or direct mode

getMode

public int getMode()

Description copied from interface: Programmer

Get the current programming mode

Specified by:

getMode in interface Programmer

Returns:

one of the class constants identifying a mode

getCanRead

public boolean getCanRead()

Specified by:

getCanRead in interface Programmer

notifyPropertyChange

protected void notifyPropertyChange(String name,
                                    int oldval,
                                    int newval)

writeCV

public void writeCV(int CV,
                    int val,
                    ProgListener p)
             throws ProgrammerException

Description copied from interface: Programmer

Perform a CV write in the system-specific manner, and using the specified programming mode. Note that this returns before the write is complete; you have to provide a ProgListener to hear about completion. The 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

Throws:

ProgrammerException

confirmCV

public void confirmCV(int CV,
                      int val,
                      ProgListener p)
               throws ProgrammerException

Description copied from interface: Programmer

Confirm the value of a CV using the specified programming mode. On some systems, this is faster than a read. Note that this returns before the confirm is complete; you have to provide a ProgListener to hear about completion. The 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

Throws:

ProgrammerException

readCV

public void readCV(int CV,
                   ProgListener p)
            throws ProgrammerException

Description copied from interface: Programmer

Perform a CV read in the system-specific manner, and using the specified programming mode. Note that this returns before the read is complete; you have to provide a ProgListener to hear about completion. The 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

Throws:

ProgrammerException

useProgrammer

protected void useProgrammer(ProgListener p)
                      throws ProgrammerException

Throws:

ProgrammerException

progTaskStart

protected SprogMessage progTaskStart(int mode,
                                     int val,
                                     int cvnum)

notifyMessage

public void notifyMessage(SprogMessage m)

Specified by:

notifyMessage in interface SprogListener

notifyReply

public void notifyReply(SprogReply reply)

Specified by:

notifyReply in interface SprogListener

timeout

protected void timeout()

Internal routine to handle a timeout

Specified by:

timeout in class AbstractProgrammer

notifyProgListenerEnd

protected void notifyProgListenerEnd(int value,
                                     int status)

controller

protected SprogTrafficController controller()