jmri.jmrix.zimo
Class Mx1Programmer

java.lang.Object
  jmri.jmrix.AbstractProgrammer
      jmri.jmrix.zimo.Mx1Programmer

All Implemented Interfaces:

EventListener, Mx1Listener, Programmer

public class Mx1Programmer
extends AbstractProgrammer
implements Mx1Listener

Programmer support for Zimo Mx-1. Currently paged mode is implemented.

The read operation state sequence is:

• Reset Mx-1
• Send paged mode read/write request
• Wait for results reply, interpret
• Send Resume Operations request
• Wait for Normal Operations Resumed broadcast

Author:

Bob Jacobsen Copyright (c) 2002

Field Summary

protected int

_mode

Fields inherited from class jmri.jmrix.AbstractProgrammer

LONG_TIMEOUT, propListeners, SHORT_TIMEOUT

Fields inherited from interface jmri.Programmer

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

Constructor Summary

Mx1Programmer()

Method Summary

int	ascToBcd(int hex)
void	confirmCV(int CV, int val, ProgListener p) Confirm the value of a CV using the specified programming mode.
protected Mx1TrafficController	controller()
boolean	getCanRead()
int	getMode() Get the current programming mode
boolean	hasMode(int mode) Signifies mode's available
static Mx1Programmer	instance()
void	message(Mx1Message m) Member function that will be invoked by a Mx1Interface implementation to forward a MX-1 message from the layout.
protected void	notifyProgListenerEnd(int value, int status)
protected void	notifyPropertyChange(String name, int oldval, int newval)
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) Note that zimo can now only do page 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

Field Detail

_mode

protected int _mode

Constructor Detail

Mx1Programmer

public Mx1Programmer()

Method Detail

instance

public static final Mx1Programmer instance()

setMode

public void setMode(int mode)

Note that zimo can now only do page 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

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

hasMode

public boolean hasMode(int mode)

Signifies mode's available

Specified by:

hasMode in interface Programmer

Parameters:

mode -

Returns:

True if paged 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

message

public void message(Mx1Message m)

Description copied from interface: Mx1Listener

Member function that will be invoked by a Mx1Interface implementation to forward a MX-1 message from the layout.

Specified by:

message in interface Mx1Listener

Parameters:

m - The received MX-1 message. Note that this same object may be presented to multiple users. It should not be modified here.

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 Mx1TrafficController controller()

ascToBcd

public int ascToBcd(int hex)