Package jmri.jmrix.dccpp

Class DCCppProgrammer

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.jmrix.AbstractProgrammer

jmri.jmrix.dccpp.DCCppProgrammer

All Implemented Interfaces:

EventListener, PropertyChangeFirer, PropertyChangeProvider, Disposable, AbstractMRListener, DCCppListener, Programmer

public class DCCppProgrammer
extends AbstractProgrammer
implements DCCppListener

Programmer support for DCC++.

The read operation state sequence is:

• Send Register Mode / Paged mode /Direct Mode read request
• Wait for results reply, interpret

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.Programmer

Programmer.Configurator, Programmer.WriteConfirmMode

Field Summary

Fields

Modifier and Type	Field	Description
protected int	_cv
protected boolean	_progRead
protected boolean	_service_mode
protected int	_val
protected static final int	DCCppProgrammerTimeout
protected static final int	INQUIRESENT
protected static final int	LISTENER_MASK
protected static final int	NOTPROGRAMMING
protected int	progState
protected static final int	REQUESTSENT

Fields inherited from class jmri.jmrix.AbstractProgrammer

LONG_TIMEOUT, SHORT_TIMEOUT

Fields inherited from class jmri.beans.PropertyChangeSupport

propertyChangeSupport

Constructor Summary

Constructors

Constructor	Description
DCCppProgrammer(DCCppTrafficController tc)

Method Summary

Modifier and Type	Method	Description
void	confirmCV(String CV, int val, ProgListener p)	Confirm the value of a CV using the specified programming mode.
protected DCCppTrafficController	controller()
void	dispose()	Free up system resources.
boolean	getCanRead(String addr)	Checks the general read capability, regardless of mode, for a specific address
boolean	getCanWrite(String addr)	Checks the general write capability, regardless of mode, for a specific address
List<ProgrammingMode>	getSupportedModes()	Get the list of ProgrammingMode supported by this Programmer.
Programmer.WriteConfirmMode	getWriteConfirmMode(String addr)	Learn about whether the programmer does any kind of verification of write operations
void	message(DCCppMessage l)	Member function that will be invoked by a DCCppInterface implementation to forward a DCC++ message sent to the layout.
void	message(DCCppReply m)	Member function that will be invoked by a DCCppInterface implementation to forward a DCC++ message from the layout.
protected void	notifyProgListenerEnd(int value, int status)
void	notifyTimeout(DCCppMessage msg)	Member function invoked by an DCCppInterface implementation to notify a sender that an outgoing message timed out and was dropped from the queue.
boolean	programmerBusy()
void	readCV(String CVname, ProgListener p)	Perform a CV read in the system-specific manner, and using the specified programming mode.
void	readCV(String CVname, ProgListener p, int startVal)	Perform a CV read in the system-specific manner, and using the specified programming mode, possibly using a hint of the current value to speed up programming.
protected void	timeout()	Internal routine to handle a timeout, should be synchronized!
protected void	useProgrammer(ProgListener p)
void	writeCV(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, 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, getConfigurator, notifyProgListenerEnd, removePropertyChangeListener

Field Details

DCCppProgrammerTimeout

protected static final int DCCppProgrammerTimeout

See Also:

• Constant Field Values

_service_mode

protected boolean _service_mode

LISTENER_MASK

protected static final int LISTENER_MASK

See Also:

• Constant Field Values

progState

protected int progState

NOTPROGRAMMING

protected static final int NOTPROGRAMMING

See Also:

• Constant Field Values

REQUESTSENT

protected static final int REQUESTSENT

See Also:

• Constant Field Values

INQUIRESENT

protected static final int INQUIRESENT

See Also:

• Constant Field Values

_progRead

protected boolean _progRead

_val

protected int _val

_cv

protected int _cv

Constructor Details

DCCppProgrammer

public DCCppProgrammer(@Nonnull
 DCCppTrafficController tc)

Method Details

getSupportedModes

@Nonnull
public List<ProgrammingMode> getSupportedModes()

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

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(String addr)

Checks the general read capability, regardless of mode, for a specific address Checks using the current default programming mode Can we read from a specific CV in the specified mode? Answer may not be correct if the command station type and version sent by the command station mimics one of the known command stations.

Specified by:

getCanRead in interface Programmer

Overrides:

getCanRead in class AbstractProgrammer

Parameters:

addr - the address to read

Returns:

true if the address can be read; false otherwise

getCanWrite

public boolean getCanWrite(String addr)

Checks the general write capability, regardless of mode, for a specific address Checks using the current default programming mode. Can we write to a specific CV in the specified mode? Answer may not be correct if the command station type and version sent by the command station mimics one of the known command stations.

Specified by:

getCanWrite in interface Programmer

Overrides:

getCanWrite in class AbstractProgrammer

Parameters:

addr - the address to write to

Returns:

true if the address can be written to; false otherwise

getWriteConfirmMode

@Nonnull
public Programmer.WriteConfirmMode getWriteConfirmMode(String addr)

Learn about whether the programmer does any kind of verification of write operations By default, say that no verification is done.

Specified by:

getWriteConfirmMode in interface Programmer

Overrides:

getWriteConfirmMode in class AbstractProgrammer

Parameters:

addr - A CV address to check (in case this varies with CV range) or null for any

Returns:

Always WriteConfirmMode.NotVerified

writeCV

public void writeCV(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(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(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

readCV

public void readCV(String CVname,
 ProgListener p,
 int startVal)
            throws ProgrammerException

Perform a CV read in the system-specific manner, and using the specified programming mode, possibly using a hint of the current value to speed up programming.

Handles a general address space through a String address. Each programmer defines the acceptable formats.

On systems that support it, the startVal is a hint as to what the current value of the CV might be (e.g. the value from the roster). This could be verified immediately in direct byte mode to speed up the read process.

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.

Defaults to the normal read method if not overridden in a specific implementation.

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

Parameters:

CVname - the CV to read

p - the listener that will be notified of the read

startVal - a hint of what the current value might be, or 0

Throws:

ProgrammerException - if unable to communicate

useProgrammer

protected void useProgrammer(ProgListener p)
                      throws ProgrammerException

Throws:

ProgrammerException

message

public void message(DCCppReply m)

Member function that will be invoked by a DCCppInterface implementation to forward a DCC++ message from the layout.

Specified by:

message in interface DCCppListener

Parameters:

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

message

public void message(DCCppMessage l)

Member function that will be invoked by a DCCppInterface implementation to forward a DCC++ message sent to the layout. Normally, this function will do nothing.

Specified by:

message in interface DCCppListener

Parameters:

l - The received DCC++ message. Note that this same object may be presented to multiple users. It should not be modified here.

notifyTimeout

public void notifyTimeout(DCCppMessage msg)

Description copied from interface: DCCppListener

Member function invoked by an DCCppInterface implementation to notify a sender that an outgoing message timed out and was dropped from the queue.

Specified by:

notifyTimeout in interface DCCppListener

Parameters:

msg - the message that timed out.

programmerBusy

public boolean programmerBusy()

timeout

protected void timeout()

Internal routine to handle a timeout, should be synchronized!

Specified by:

timeout in class AbstractProgrammer

notifyProgListenerEnd

protected void notifyProgListenerEnd(int value,
 int status)

controller

protected DCCppTrafficController controller()

dispose

public void dispose()

Description copied from interface: Programmer

Free up system resources. Overriding classes should be capable of this being called multiple times as per the Disposable interface. Called when disposing of a disposable.

Note there are no assurances this method will not be called multiple times against a single instance of this Disposable. It is the responsibility of this Disposable to protect itself and the application from ensuring that calling this method multiple times has no unwanted side effects.

Specified by:

dispose in interface Disposable

Specified by:

dispose in interface Programmer