Package jmri.jmrix.dccpp

Class DCCppOpsModeProgrammer

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.jmrix.AbstractProgrammer

jmri.jmrix.dccpp.DCCppOpsModeProgrammer

All Implemented Interfaces:

AddressedProgrammer, PropertyChangeFirer, PropertyChangeProvider, Disposable, Programmer

public class DCCppOpsModeProgrammer
extends AbstractProgrammer
implements AddressedProgrammer

Provides an Ops mode programming interface for DCC++. Currently only Byte mode is implemented, though DCC++ also supports bit mode writes for POM

See Also:

Programmer

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.Programmer

Programmer.Configurator, Programmer.WriteConfirmMode

Field Summary

Fields

Modifier and Type	Field	Description
(package private) int	mAddress
(package private) int	mAddressHigh
(package private) int	mAddressLow
(package private) ProgListener	progListener
(package private) int	progState
protected DCCppTrafficController	tc
(package private) int	value

Fields inherited from class jmri.jmrix.AbstractProgrammer

LONG_TIMEOUT, SHORT_TIMEOUT

Fields inherited from class jmri.beans.PropertyChangeSupport

propertyChangeSupport

Constructor Summary

Constructors

Constructor	Description
DCCppOpsModeProgrammer(int pAddress, DCCppTrafficController controller)

Method Summary

Modifier and Type	Method	Description
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	getLongAddress()
java.util.List<ProgrammingMode>	getSupportedModes()	Get the list of ProgrammingMode supported by this Programmer.
void	readCV(java.lang.String CVname, ProgListener p)	Perform a CV read in the system-specific manner, and using the specified programming mode.
protected void	timeout()	Internal routine to handle a timeout, should be synchronized!
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, getCanRead, getCanWrite, 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, getCanRead, getCanWrite, getCanWrite, getConfigurator, getMode, getWriteConfirmMode, notifyProgListenerEnd, readCV, removePropertyChangeListener, setMode

Field Detail

mAddressHigh

int mAddressHigh

mAddressLow

int mAddressLow

mAddress

int mAddress

progState

int progState

value

int value

progListener

ProgListener progListener

tc

protected DCCppTrafficController tc

Constructor Detail

DCCppOpsModeProgrammer

public DCCppOpsModeProgrammer(int pAddress,
                              DCCppTrafficController controller)

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) Send an ops-mode write request to the DCC++.

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

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

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

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

Specified by:

getSupportedModes in interface Programmer

Specified by:

getSupportedModes in class AbstractProgrammer

Returns:

the list of supported modes or an empty list

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

timeout

protected void timeout()

Internal routine to handle a timeout, should be synchronized!

Specified by:

timeout in class AbstractProgrammer