Class CbusDccProgrammer
- java.lang.Object
-
- jmri.beans.PropertyChangeSupport
-
- jmri.jmrix.AbstractProgrammer
-
- jmri.jmrix.can.cbus.CbusDccProgrammer
-
- All Implemented Interfaces:
java.util.EventListener
,PropertyChangeFirer
,PropertyChangeProvider
,Disposable
,AbstractMRListener
,CanListener
,Programmer
- Direct Known Subclasses:
CbusDccOpsModeProgrammer
public class CbusDccProgrammer extends AbstractProgrammer implements CanListener
Implements the jmri.Programmer interface via commands for the CBUS programmer.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface jmri.Programmer
Programmer.WriteConfirmMode
-
-
Field Summary
Fields Modifier and Type Field Description (package private) int
_cv
(package private) static int
_nvOffset
(package private) boolean
_progRead
(package private) int
_val
(package private) static int
COMMANDSENT
(package private) static int
MODESENT
(package private) static int
NOTPROGRAMMING
(package private) static int
NVCOMMANDSENT
(package private) int
progState
(package private) static int
RETURNSENT
(package private) TrafficController
tc
-
Fields inherited from class jmri.jmrix.AbstractProgrammer
LONG_TIMEOUT, SHORT_TIMEOUT
-
Fields inherited from class jmri.beans.PropertyChangeSupport
propertyChangeSupport
-
-
Constructor Summary
Constructors Constructor Description CbusDccProgrammer(CanSystemConnectionMemo m)
CbusDccProgrammer(TrafficController 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.void
dispose()
Free up system resources.java.util.List<ProgrammingMode>
getSupportedModes()
Get the list ofProgrammingMode
supported by this Programmer.void
message(CanMessage m)
Called when an outgoing message is sent to the CAN Network.protected void
notifyProgListenerEnd(int value, int status)
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
reply(CanReply m)
Called when an incoming CanFrame is received from the CAN Network.void
setNodeOfInterest(CbusNode n)
Set the CBUS Node to be used for NV programmingprotected 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, 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.jmrix.can.CanListener
addTc, addTc, removeTc, removeTc
-
Methods inherited from interface jmri.Programmer
addPropertyChangeListener, notifyProgListenerEnd, removePropertyChangeListener
-
-
-
-
Field Detail
-
progState
int progState
-
NOTPROGRAMMING
static final int NOTPROGRAMMING
- See Also:
- Constant Field Values
-
MODESENT
static final int MODESENT
- See Also:
- Constant Field Values
-
COMMANDSENT
static final int COMMANDSENT
- See Also:
- Constant Field Values
-
RETURNSENT
static final int RETURNSENT
- See Also:
- Constant Field Values
-
NVCOMMANDSENT
static final int NVCOMMANDSENT
- See Also:
- Constant Field Values
-
_progRead
boolean _progRead
-
_val
int _val
-
_cv
int _cv
-
_nvOffset
static final int _nvOffset
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CbusDccProgrammer
public CbusDccProgrammer(TrafficController tc)
-
CbusDccProgrammer
public CbusDccProgrammer(CanSystemConnectionMemo m)
-
-
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. Types implemented here.- Specified by:
getSupportedModes
in interfaceProgrammer
- Specified by:
getSupportedModes
in classAbstractProgrammer
- Returns:
- the list of supported modes or an empty list
-
setNodeOfInterest
public void setNodeOfInterest(CbusNode n)
Set the CBUS Node to be used for NV programming- Parameters:
n
- a CBUS node
-
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
-
useProgrammer
protected void useProgrammer(ProgListener p) throws ProgrammerException
- Throws:
ProgrammerException
-
message
public void message(CanMessage m)
Called when an outgoing message is sent to the CAN Network. Only listening for frames coming in to JMRI, see CanReply- Specified by:
message
in interfaceCanListener
- Parameters:
m
- the CanMessage being sent.
-
reply
public void reply(CanReply m)
Called when an incoming CanFrame is received from the CAN Network.- Specified by:
reply
in interfaceCanListener
- Parameters:
m
- the CanReply being received.
-
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)
-
dispose
public void dispose()
Description copied from interface:Programmer
Free up system resources. Overriding classes should be capable of this being called multiple times as per theDisposable
interface. Called when disposing of a disposable.Note there are no assurances this method will not be called multiple times against a single instance of this Disposable. It is the responsibility of this Disposable to protect itself and the application from ensuring that calling this method multiple times has no unwanted side effects.
- Specified by:
dispose
in interfaceDisposable
- Specified by:
dispose
in interfaceProgrammer
-
-