Class SprogProgrammer
- java.lang.Object
-
- jmri.beans.PropertyChangeSupport
-
- jmri.jmrix.AbstractProgrammer
-
- jmri.jmrix.sprog.SprogProgrammer
-
- All Implemented Interfaces:
java.util.EventListener
,PropertyChangeFirer
,PropertyChangeProvider
,Disposable
,SprogListener
,SprogVersionListener
,Programmer
- Direct Known Subclasses:
SprogOpsModeProgrammer
public class SprogProgrammer extends AbstractProgrammer implements SprogListener, SprogVersionListener
Implement the jmri.Programmer interface via commands for the Sprog programmer. This provides a service mode programmer.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface jmri.Programmer
Programmer.WriteConfirmMode
-
-
Field Summary
Fields Modifier and Type Field Description (package private) SprogTrafficController
_controller
(package private) java.lang.String
_cv
(package private) ProgListener
_progListener
(package private) int
_startVal
(package private) int
_val
(package private) static int
COMMANDSENT
(package private) static 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 SprogProgrammer(SprogSystemConnectionMemo memo)
-
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 SprogTrafficController
controller()
boolean
getCanRead()
Checks the general read capability, regardless of modejava.util.List<ProgrammingMode>
getSupportedModes()
Get the list ofProgrammingMode
supported by this Programmer.void
notifyMessage(SprogMessage m)
protected void
notifyProgListenerEnd(int value, int status)
void
notifyReply(SprogReply reply)
void
notifyVersion(SprogVersion v)
Handle a SprogVersion notification.protected SprogMessage
progTaskStart(ProgrammingMode mode, int val, int cvnum, int startVal)
Internal method to create the SprogMessage for programmer task start.void
readCV(java.lang.String CVname, ProgListener p)
Perform a CV read in the system-specific manner, and using the specified programming mode.void
readCV(java.lang.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.void
readCVWithDefault(java.lang.String CVname, ProgListener p, int startVal)
Internal method to read a CV with a possible default valueprotected void
timeout()
Internal routine to handle a timeout, should be synchronized!protected void
useProgrammer(ProgListener p)
Internal method to remember who's using the programmer.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, 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, removePropertyChangeListener
-
-
-
-
Field Detail
-
progState
int progState
-
NOTPROGRAMMING
static final int NOTPROGRAMMING
- See Also:
- Constant Field Values
-
COMMANDSENT
static final int COMMANDSENT
- See Also:
- Constant Field Values
-
_val
int _val
-
_cv
java.lang.String _cv
-
_startVal
int _startVal
-
_progListener
ProgListener _progListener
-
_controller
SprogTrafficController _controller
-
-
Constructor Detail
-
SprogProgrammer
public SprogProgrammer(SprogSystemConnectionMemo memo)
-
-
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. Implemented Types.- Specified by:
getSupportedModes
in interfaceProgrammer
- Specified by:
getSupportedModes
in classAbstractProgrammer
- 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.- Specified by:
getCanRead
in interfaceProgrammer
- Overrides:
getCanRead
in classAbstractProgrammer
- Returns:
- true if the programmer is capable of reading; 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
-
readCV
public void readCV(java.lang.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 interfaceProgrammer
- Parameters:
CVname
- the CV to readp
- the listener that will be notified of the readstartVal
- a hint of what the current value might be, or 0- Throws:
ProgrammerException
- if unable to communicate
-
readCVWithDefault
public void readCVWithDefault(java.lang.String CVname, ProgListener p, int startVal) throws ProgrammerException
Internal method to read a CV with a possible default value- Parameters:
CVname
- Index of CV to readp
- Programming listenerstartVal
- CV default value, Use 0 if no default available- Throws:
ProgrammerException
- if programming operation fails
-
useProgrammer
protected void useProgrammer(ProgListener p) throws ProgrammerException
Internal method to remember who's using the programmer.- Parameters:
p
- Who gets reply- Throws:
ProgrammerException
- when programmer in invalid state
-
progTaskStart
protected SprogMessage progTaskStart(ProgrammingMode mode, int val, int cvnum, int startVal)
Internal method to create the SprogMessage for programmer task start.- Parameters:
mode
- Mode to be usedval
- value to be writtencvnum
- CV address to write tostartVal
- Hint of what the CV may contain, or 0- Returns:
- formatted message to do programming operation
-
notifyMessage
public void notifyMessage(SprogMessage m)
- Specified by:
notifyMessage
in interfaceSprogListener
-
notifyReply
public void notifyReply(SprogReply reply)
- Specified by:
notifyReply
in interfaceSprogListener
-
notifyVersion
public void notifyVersion(SprogVersion v) throws ProgrammerException
Handle a SprogVersion notification.Decode the SPROG version and decode the programming capabilities.
- Specified by:
notifyVersion
in interfaceSprogVersionListener
- Parameters:
v
- The SprogVersion being handled- Throws:
ProgrammerException
-
timeout
protected void timeout()
Internal routine to handle a timeout, should be synchronized! Internal routine to handle a timeout- Specified by:
timeout
in classAbstractProgrammer
-
notifyProgListenerEnd
protected void notifyProgListenerEnd(int value, int status)
-
controller
protected SprogTrafficController controller()
-
-