Package jmri.jmrix.nce

Class NceOpsModeProgrammer

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.jmrix.AbstractProgrammer

jmri.jmrix.nce.NceProgrammer

jmri.jmrix.nce.NceOpsModeProgrammer

All Implemented Interfaces:

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

public class NceOpsModeProgrammer
extends NceProgrammer
implements AddressedProgrammer

Provide an Ops Mode Programmer via a wrapper what works with the NCE command station object.

Functionally, this just creates packets to send via the command station.

See Also:

Programmer

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.Programmer

Programmer.WriteConfirmMode

Field Summary

Fields

Modifier and Type	Field	Description
(package private) int	mAddress
(package private) boolean	mLongAddr

Fields inherited from class jmri.jmrix.nce.NceProgrammer

_cv, _progRead, _val, COMMANDSENT, COMMANDSENT_2, NOTPROGRAMMING, progState, 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
NceOpsModeProgrammer(NceTrafficController tc, int pAddress, boolean pLongAddr)

Method Summary

Modifier and Type	Method	Description
(package private) void	cleanup()	Ops-mode programming doesn't put the command station in programming mode, so we don't have to send an exit-programming command at end.
void	confirmCV(java.lang.String CV, int val, ProgListener p)	Confirm the value of a CV using the specified programming mode.
java.lang.String	getAddress()
int	getAddressNumber()
boolean	getCanRead()	Checks the general read capability, regardless of mode
boolean	getLongAddress()
java.util.List<ProgrammingMode>	getSupportedModes()	Get the list of ProgrammingMode supported by this Programmer.
protected void	notifyProgListenerEnd(int value, int status)	add 200mSec between commands, so NCE command station queue doesn't get overrun
void	readCV(java.lang.String CVname, ProgListener p)	Perform a CV read in the system-specific manner, and using the specified programming mode.
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.nce.NceProgrammer

getCanWrite, getCanWrite, message, progTaskStart, reply, timeout, useProgrammer

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, decodeErrorCode, dispose, getCanRead, getCanWrite, getCanWrite, getMode, getWriteConfirmMode, notifyProgListenerEnd, readCV, removePropertyChangeListener, setMode

Field Detail

mAddress

int mAddress

mLongAddr

boolean mLongAddr

Constructor Detail

NceOpsModeProgrammer

public NceOpsModeProgrammer(NceTrafficController tc,
                            int pAddress,
                            boolean pLongAddr)

Method Detail

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) Forward a write request to an ops-mode write operation

Specified by:

writeCV in interface Programmer

Overrides:

writeCV in class NceProgrammer

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

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

Overrides:

readCV in class NceProgrammer

Parameters:

CVname - the CV to read

p - the listener that will be notified of the read

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

Overrides:

confirmCV in class NceProgrammer

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

notifyProgListenerEnd

protected void notifyProgListenerEnd(int value,
                                     int status)

add 200mSec between commands, so NCE command station queue doesn't get overrun

Overrides:

notifyProgListenerEnd in class NceProgrammer

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 Types implemented here.

Specified by:

getSupportedModes in interface Programmer

Overrides:

getSupportedModes in class NceProgrammer

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. Can this ops-mode programmer read back values? For now, no, but maybe later.

Specified by:

getCanRead in interface Programmer

Overrides:

getCanRead in class NceProgrammer

Returns:

always false for now

cleanup

void cleanup()

Ops-mode programming doesn't put the command station in programming mode, so we don't have to send an exit-programming command at end. Therefore, this routine does nothing except to replace the parent routine that does something.

Overrides:

cleanup in class NceProgrammer

getLongAddress

public boolean getLongAddress()

Specified by:

getLongAddress in interface AddressedProgrammer

getAddressNumber

public int getAddressNumber()

Specified by:

getAddressNumber in interface AddressedProgrammer

getAddress

public java.lang.String getAddress()

Specified by:

getAddress in interface AddressedProgrammer