Package jmri.jmrix.nce

Class NceProgrammer

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.jmrix.AbstractProgrammer

jmri.jmrix.nce.NceProgrammer

All Implemented Interfaces:

java.util.EventListener, PropertyChangeFirer, PropertyChangeProvider, Disposable, AbstractMRListener, NceListener, Programmer

Direct Known Subclasses:

NceOpsModeProgrammer

public class NceProgrammer
extends AbstractProgrammer
implements NceListener

Convert the jmri.Programmer interface into commands for the NCE power house.

This has two states: NOTPROGRAMMING, and COMMANDSENT. The transitions to and from programming mode are now handled in the TrafficController code.

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.Programmer

Programmer.WriteConfirmMode

Field Summary

Fields

Modifier and Type	Field	Description
(package private) int	_cv
(package private) boolean	_progRead
(package private) int	_val
(package private) static int	COMMANDSENT
(package private) static int	COMMANDSENT_2
(package private) static int	NOTPROGRAMMING
(package private) int	progState
protected NceTrafficController	tc

Fields inherited from class jmri.jmrix.AbstractProgrammer

LONG_TIMEOUT, SHORT_TIMEOUT

Fields inherited from class jmri.beans.PropertyChangeSupport

propertyChangeSupport

Constructor Summary

Constructors

Constructor	Description
NceProgrammer(NceTrafficController tc)

Method Summary

Modifier and Type	Method	Description
(package private) void	cleanup()
void	confirmCV(java.lang.String CV, int val, ProgListener p)	Confirm the value of a CV using the specified programming mode.
boolean	getCanRead()	Checks the general read capability, regardless of mode
(package private) boolean	getCanWrite(int cv)
boolean	getCanWrite(java.lang.String cv)	Checks the general write capability, regardless of mode, for a specific address
java.util.List<ProgrammingMode>	getSupportedModes()	Get the list of ProgrammingMode supported by this Programmer.
void	message(NceMessage m)
protected void	notifyProgListenerEnd(int value, int status)
protected NceMessage	progTaskStart(ProgrammingMode mode, int val, int cvnum)
void	readCV(java.lang.String CVname, ProgListener p)	Perform a CV read in the system-specific manner, and using the specified programming mode.
void	reply(NceReply m)
protected void	timeout()	Internal routine to handle a timeout, should be synchronized!
protected void	useProgrammer(ProgListener p)
void	writeCV(java.lang.String CVname, 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

decodeErrorCode, getBestMode, getCanRead, getCanWrite, getMode, getWriteConfirmMode, registerFromCV, restartTimer, setMode, startLongTimer, startShortTimer, stopTimer

Methods inherited from class jmri.beans.PropertyChangeSupport

addPropertyChangeListener, addPropertyChangeListener, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.Programmer

addPropertyChangeListener, dispose, notifyProgListenerEnd, readCV, removePropertyChangeListener

Field Detail

tc

protected NceTrafficController tc

progState

int progState

NOTPROGRAMMING

static final int NOTPROGRAMMING

See Also:

Constant Field Values

COMMANDSENT

static final int COMMANDSENT

See Also:

Constant Field Values

COMMANDSENT_2

static final int COMMANDSENT_2

See Also:

Constant Field Values

_progRead

boolean _progRead

_val

int _val

_cv

int _cv

Constructor Detail

NceProgrammer

public NceProgrammer(NceTrafficController tc)

Method Detail

getSupportedModes

@Nonnull
public java.util.List<ProgrammingMode> getSupportedModes()

Get the list of ProgrammingMode supported by this Programmer. If the order is significant, earlier modes are better.

NCE programming modes available depend on settings

Specified by:

getSupportedModes in interface Programmer

Specified by:

getSupportedModes in class AbstractProgrammer

Returns:

the list of supported modes or an empty list

getCanRead

public boolean getCanRead()

Checks the general read capability, regardless of mode Basic implementation. Override this to turn reading on and off globally.

Specified by:

getCanRead in interface Programmer

Overrides:

getCanRead in class AbstractProgrammer

Returns:

true if the programmer is capable of reading; false otherwise

getCanWrite

public boolean getCanWrite(java.lang.String cv)

Checks the general write capability, regardless of mode, for a specific address Checks using the current default programming mode.

Specified by:

getCanWrite in interface Programmer

Overrides:

getCanWrite in class AbstractProgrammer

Parameters:

cv - the address to write to

Returns:

true if the address can be written to; false otherwise

getCanWrite

boolean getCanWrite(int cv)

writeCV

public void writeCV(java.lang.String CVname,
                    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)

Specified by:

writeCV in interface Programmer

Specified by:

writeCV in class AbstractProgrammer

Parameters:

CVname - 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

confirmCV

public void confirmCV(java.lang.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)

Specified by:

confirmCV in interface Programmer

Specified by:

confirmCV in class AbstractProgrammer

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

readCV

public void readCV(java.lang.String CVname,
                   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)

Specified by:

readCV in interface Programmer

Specified by:

readCV in class AbstractProgrammer

Parameters:

CVname - the CV to read

p - the listener that will be notified of the read

Throws:

ProgrammerException - if unable to communicate

useProgrammer

protected void useProgrammer(ProgListener p)
                      throws ProgrammerException

Throws:

ProgrammerException

progTaskStart

protected NceMessage progTaskStart(ProgrammingMode mode,
                                   int val,
                                   int cvnum)
                            throws ProgrammerException

Throws:

ProgrammerException

message

public void message(NceMessage m)

Specified by:

message in interface NceListener

reply

public void reply(NceReply m)

Specified by:

reply in interface NceListener

timeout

protected void timeout()

Internal routine to handle a timeout, should be synchronized!

Internal routine to handle a timeout

Specified by:

timeout in class AbstractProgrammer

cleanup

void cleanup()

notifyProgListenerEnd

protected void notifyProgListenerEnd(int value,
                                     int status)