Package jmri.jmrix.srcp

Class SRCPProgrammer

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.jmrix.AbstractProgrammer

jmri.jmrix.srcp.SRCPProgrammer

All Implemented Interfaces:

EventListener, PropertyChangeFirer, PropertyChangeProvider, Disposable, AbstractMRListener, SRCPListener, Programmer

public class SRCPProgrammer
extends AbstractProgrammer
implements SRCPListener

Implements the jmri.Programmer interface via commands for the SRCP powerstation

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	_confirmVal
(package private) SRCPTrafficController	_controller
(package private) int	_cv
protected SRCPBusConnectionMemo	_memo
(package private) boolean	_progConfirm
(package private) boolean	_progRead
(package private) int	_val
(package private) static final int	COMMANDSENT
(package private) static final int	NOTPROGRAMMING
(package private) int	progState

Fields inherited from class jmri.jmrix.AbstractProgrammer

LONG_TIMEOUT, SHORT_TIMEOUT

Fields inherited from class jmri.beans.PropertyChangeSupport

propertyChangeSupport

Constructor Summary

Constructors

Constructor	Description
SRCPProgrammer(SRCPBusConnectionMemo memo)

Method Summary

Modifier and Type	Method	Description
(package private) void	cleanup()	Internal method to send a cleanup message (if needed) on timeout.
void	confirmCV(String CVname, int val, ProgListener p)	Confirm the value of a CV using the specified programming mode.
protected SRCPTrafficController	controller()
List<ProgrammingMode>	getSupportedModes()	Get the list of ProgrammingMode supported by this Programmer.
void	message(SRCPMessage m)
protected void	notifyProgListenerEnd(int value, int status)
void	readCV(String CVname, ProgListener p)	Perform a CV read in the system-specific manner, and using the specified programming mode.
void	reply(SimpleNode n)
void	reply(SRCPReply m)
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, 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, dispose, getConfigurator, notifyProgListenerEnd, readCV, removePropertyChangeListener

Field Details

_memo

protected SRCPBusConnectionMemo _memo

progState

int progState

NOTPROGRAMMING

static final int NOTPROGRAMMING

See Also:

• Constant Field Values

COMMANDSENT

static final int COMMANDSENT

See Also:

• Constant Field Values

_progRead

boolean _progRead

_progConfirm

boolean _progConfirm

_confirmVal

int _confirmVal

_val

int _val

_cv

int _cv

_controller

SRCPTrafficController _controller

Constructor Details

SRCPProgrammer

public SRCPProgrammer(SRCPBusConnectionMemo memo)

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

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

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

useProgrammer

protected void useProgrammer(ProgListener p)
                      throws ProgrammerException

Throws:

ProgrammerException

message

public void message(SRCPMessage m)

Specified by:

message in interface SRCPListener

reply

public void reply(SRCPReply m)

Specified by:

reply in interface SRCPListener

reply

public void reply(SimpleNode n)

Specified by:

reply in interface SRCPListener

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

Internal method to send a cleanup message (if needed) on timeout.

Here, it sends a request to exit from programming mode. But subclasses may redefine that.

notifyProgListenerEnd

protected void notifyProgListenerEnd(int value,
 int status)

controller

protected SRCPTrafficController controller()