Class XNetProgrammer
- java.lang.Object
-
- jmri.beans.PropertyChangeSupport
-
- jmri.jmrix.AbstractProgrammer
-
- jmri.jmrix.lenz.XNetProgrammer
-
- All Implemented Interfaces:
java.util.EventListener
,PropertyChangeFirer
,PropertyChangeProvider
,Disposable
,AbstractMRListener
,XNetListener
,Programmer
- Direct Known Subclasses:
EliteXNetProgrammer
,LI100XNetProgrammer
,Z21XNetProgrammer
public class XNetProgrammer extends AbstractProgrammer implements XNetListener
Convert the jmri.Programmer interface into commands for the Lenz XpressNetThe 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 interface jmri.Programmer
Programmer.WriteConfirmMode
-
-
Field Summary
Fields Modifier and Type Field Description (package private) XNetTrafficController
_controller
protected int
_cv
protected boolean
_progRead
protected boolean
_service_mode
protected int
_val
protected static int
INQUIRESENT
protected static int
NOTPROGRAMMING
protected int
progState
protected static int
REQUESTSENT
protected static int
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 XNetProgrammer(XNetTrafficController tc)
-
Method Summary
All Methods Instance Methods Concrete Methods 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.protected XNetTrafficController
controller()
boolean
getCanRead(java.lang.String addr)
Checks the general read capability, regardless of mode, for a specific addressboolean
getCanWrite(java.lang.String addr)
Checks the general write capability, regardless of mode, for a specific addressjava.util.List<ProgrammingMode>
getSupportedModes()
Get the list ofProgrammingMode
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 m)
Member function that will be invoked by an XNetInterface implementation to forward an XNet message from the layout.protected void
notifyProgListenerEnd(int value, int status)
Internal method to notify of the final resultvoid
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.boolean
programmerBusy()
Since the Lenz programming sequence requires several operations, we want to be able to check and see if we are currently programming before allowing the Traffic Controller to send a request to exit service mode.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!protected void
useProgrammer(ProgListener p)
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, 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
-
-
-
-
Field Detail
-
XNetProgrammerTimeout
protected static final int XNetProgrammerTimeout
- See Also:
- Constant Field Values
-
_service_mode
protected boolean _service_mode
-
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
-
_controller
XNetTrafficController _controller
-
-
Constructor Detail
-
XNetProgrammer
public XNetProgrammer(XNetTrafficController tc)
-
-
Method Detail
-
getSupportedModes
@Nonnull public java.util.List<ProgrammingMode> getSupportedModes()
Get the list ofProgrammingMode
supported by this Programmer. If the order is significant, earlier modes are better.- Specified by:
getSupportedModes
in interfaceProgrammer
- Specified by:
getSupportedModes
in classAbstractProgrammer
- Returns:
- the list of supported modes or an empty list
-
getCanRead
public boolean getCanRead(java.lang.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 interfaceProgrammer
- Overrides:
getCanRead
in classAbstractProgrammer
- Parameters:
addr
- the address to read- Returns:
- true if the address can be read; false otherwise
-
getCanWrite
public boolean getCanWrite(java.lang.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 interfaceProgrammer
- Overrides:
getCanWrite
in classAbstractProgrammer
- Parameters:
addr
- the address to write to- Returns:
- true if the address can be written to; false otherwise
-
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)
- Specified by:
writeCV
in interfaceProgrammer
- Specified by:
writeCV
in classAbstractProgrammer
- Parameters:
CVname
- the CV to writeval
- the value to writep
- the listener that will be notified of the write- 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 interfaceProgrammer
- Specified by:
confirmCV
in classAbstractProgrammer
- Parameters:
CV
- the CV to confirmval
- the value to confirmp
- the listener that will be notified of the confirmation- 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 interfaceProgrammer
- Specified by:
readCV
in classAbstractProgrammer
- Parameters:
CVname
- the CV to readp
- 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(XNetReply m)
Member function that will be invoked by an XNetInterface implementation to forward an XNet message from the layout.- Specified by:
message
in interfaceXNetListener
- Parameters:
m
- The received XNet message. Note that this same object may be presented to multiple users. It should not be modified here.
-
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 interfaceXNetListener
- 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. Log and ignore- Specified by:
notifyTimeout
in interfaceXNetListener
- Parameters:
msg
- message which has timed out.
-
programmerBusy
public boolean programmerBusy()
Since the Lenz programming sequence requires several operations, we want to be able to check and see if we are currently programming before allowing the Traffic Controller to send a request to exit service mode.- Returns:
- true if programmer busy, else false.
-
timeout
protected void timeout()
Internal routine to handle a timeout, should be synchronized!- Specified by:
timeout
in classAbstractProgrammer
-
notifyProgListenerEnd
protected void notifyProgListenerEnd(int value, int status)
Internal method to notify of the final result- Parameters:
value
- Value returnedstatus
- Status of operation
-
controller
protected XNetTrafficController controller()
-
-