Package jmri.jmrix.lenz

Class XNetOpsModeProgrammer

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.jmrix.AbstractProgrammer

jmri.jmrix.lenz.XNetOpsModeProgrammer

All Implemented Interfaces:

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

Direct Known Subclasses:

Z21XNetOpsModeProgrammer

public class XNetOpsModeProgrammer
extends AbstractProgrammer
implements XNetListener, AddressedProgrammer

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

See Also:

• Programmer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XNetOpsModeProgrammer.XNetOpsConfigurator	This class is used by tests.

Nested classes/interfaces inherited from interface jmri.Programmer

Programmer.Configurator, Programmer.WriteConfirmMode

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	mAddress
protected final int	mAddressHigh
protected final int	mAddressLow
protected static final int	NOTPROGRAMMING
protected ProgListener	progListener
protected int	progMethod
protected int	progState
protected static final int	READ
protected static final int	REQUESTSENT
protected static final int	RESULTREQUESTED
protected XNetTrafficController	tc
protected int	value
protected static final int	WRITE

Fields inherited from class jmri.jmrix.AbstractProgrammer

LONG_TIMEOUT, SHORT_TIMEOUT

Fields inherited from class jmri.beans.PropertyChangeSupport

propertyChangeSupport

Constructor Summary

Constructors

Constructor	Description
XNetOpsModeProgrammer(int pAddress, XNetTrafficController controller)

Method Summary

Modifier and Type	Method	Description
void	confirmCV(String CVname, int val, ProgListener p)	Confirm the value of a CV using the specified programming mode.
String	getAddress()
int	getAddressNumber()
boolean	getCanRead()	Checks the general read capability, regardless of mode
Programmer.Configurator	getConfigurator()	Get the configurator of this programmer.
boolean	getLongAddress()
List<ProgrammingMode>	getSupportedModes()	Get the list of ProgrammingMode supported by this Programmer.
void	message(XNetMessage l)	Member function that will be invoked by an XNetInterface implementation to forward an XNet message sent to the layout.
void	message(XNetReply l)	Member function that will be invoked by an XNetInterface implementation to forward an XNet message from the layout.
void	notifyTimeout(XNetMessage msg)	Member function invoked by an XNetInterface implementation to notify a sender that an outgoing message timed out and was dropped from the queue.
void	readCV(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(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, 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 Details

mAddressHigh

protected final int mAddressHigh

mAddressLow

protected final int mAddressLow

mAddress

protected final int mAddress

progState

protected int progState

progMethod

protected int progMethod

value

protected int value

progListener

protected ProgListener progListener

NOTPROGRAMMING

protected static final int NOTPROGRAMMING

See Also:

• Constant Field Values

REQUESTSENT

protected static final int REQUESTSENT

See Also:

• Constant Field Values

RESULTREQUESTED

protected static final int RESULTREQUESTED

See Also:

• Constant Field Values

WRITE

protected static final int WRITE

See Also:

• Constant Field Values

READ

protected static final int READ

See Also:

• Constant Field Values

tc

protected XNetTrafficController tc

Constructor Details

XNetOpsModeProgrammer

public XNetOpsModeProgrammer(int pAddress,
 XNetTrafficController controller)

Method Details

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

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

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

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? Indirectly we can, though this requires an external display (a Lenz LRC120) and enabling railcom.

Specified by:

getCanRead in interface Programmer

Overrides:

getCanRead in class AbstractProgrammer

Returns:

true to allow us to trigger an ops mode read

message

public void message(XNetReply l)

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

Specified by:

message in interface XNetListener

Parameters:

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

getLongAddress

public boolean getLongAddress()

Specified by:

getLongAddress in interface AddressedProgrammer

getAddressNumber

public int getAddressNumber()

Specified by:

getAddressNumber in interface AddressedProgrammer

getAddress

public String getAddress()

Specified by:

getAddress in interface AddressedProgrammer

message

public void message(XNetMessage l)

Member function that will be invoked by an XNetInterface implementation to forward an XNet message sent to the layout. Normally, this function will do nothing.

Specified by:

message in interface XNetListener

Parameters:

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

notifyTimeout

public void notifyTimeout(XNetMessage msg)

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

Specified by:

notifyTimeout in interface XNetListener

Parameters:

msg - message which has timed out.

timeout

protected void timeout()

Internal routine to handle a timeout, should be synchronized!

Specified by:

timeout in class AbstractProgrammer

getConfigurator

public Programmer.Configurator getConfigurator()

Description copied from interface: Programmer

Get the configurator of this programmer.

Specified by:

getConfigurator in interface Programmer

Returns:

the configurator if it exists, otherwise null