Package jmri.jmrix.roco.z21

Class Z21XNetProgrammer

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.jmrix.AbstractProgrammer

jmri.jmrix.lenz.XNetProgrammer

jmri.jmrix.roco.z21.Z21XNetProgrammer

All Implemented Interfaces:

EventListener, PropertyChangeFirer, PropertyChangeProvider, Disposable, AbstractMRListener, XNetListener, Programmer

public class Z21XNetProgrammer
extends XNetProgrammer

Z21 Programmer support for Lenz XpressNet.

The read operation state sequence is:

• Send Register Mode / Paged mode /Direct Mode read request
• Wait for Broadcast Service Mode Entry message
• Send Request for Service Mode Results request
• Wait for results reply, interpret
• Send Resume Operations request
• Wait for Normal Operations Resumed broadcast

Nested Class Summary

Nested classes/interfaces inherited from class jmri.jmrix.lenz.XNetProgrammer

XNetProgrammer.XNetConfigurator

Nested classes/interfaces inherited from interface jmri.Programmer

Programmer.Configurator, Programmer.WriteConfirmMode

Field Summary

Fields inherited from class jmri.jmrix.lenz.XNetProgrammer

_cv, _progRead, _service_mode, _val, INQUIRESENT, NOTPROGRAMMING, progState, REQUESTSENT, XNetProgrammerTimeout

Fields inherited from class jmri.jmrix.AbstractProgrammer

LONG_TIMEOUT, SHORT_TIMEOUT

Fields inherited from class jmri.beans.PropertyChangeSupport

propertyChangeSupport

Constructor Summary

Constructors

Constructor	Description
Z21XNetProgrammer(XNetTrafficController tc)

Method Summary

Modifier and Type	Method	Description
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
void	message(XNetReply m)	Member function that will be invoked by an XNetInterface implementation to forward an XNet message from the layout.
void	readCV(String CVname, ProgListener p)	Perform a CV read in the system-specific manner, and using the specified programming mode.
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.lenz.XNetProgrammer

confirmCV, controller, getConfigurator, getSupportedModes, message, notifyProgListenerEnd, notifyTimeout, programmerBusy, 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, dispose, notifyProgListenerEnd, readCV, removePropertyChangeListener

Constructor Details

Z21XNetProgrammer

public Z21XNetProgrammer(XNetTrafficController tc)

Method Details

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.

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 XNetProgrammer

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.

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 XNetProgrammer

Parameters:

addr - the address to write to

Returns:

true if the address can be written to; false otherwise

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

Overrides:

writeCV in class XNetProgrammer

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

Parameters:

CVname - the CV to read

p - the listener that will be notified of the read

Throws:

ProgrammerException - if unable to communicate

message

public void message(XNetReply m)

Member function that will be invoked by an XNetInterface implementation to forward an XNet message from the layout.

Specified by:

message in interface XNetListener

Overrides:

message in class XNetProgrammer

Parameters:

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