Class BiDiBProgrammer
- java.lang.Object
-
- jmri.beans.PropertyChangeSupport
-
- jmri.jmrix.AbstractProgrammer
-
- jmri.jmrix.bidib.BiDiBProgrammer
-
- All Implemented Interfaces:
PropertyChangeFirer
,PropertyChangeProvider
,Disposable
,Programmer
public class BiDiBProgrammer extends AbstractProgrammer
Convert the jmri.Programmer interface into BiDiB.This has two states: NOTPROGRAMMING, and COMMANDSENT. The transitions to and from programming mode are now handled in the TrafficController code.
-
-
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) boolean
_progRead
(package private) int
_val
(package private) static int
COMMANDSENT
(package private) static int
COMMANDSENT_2
(package private) static int
NOTPROGRAMMING
protected org.bidib.jbidibc.messages.Node
progNode
(package private) int
progState
protected BiDiBTrafficController
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 BiDiBProgrammer(BiDiBTrafficController tc)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description (package private) void
cleanup()
void
confirmCV(java.lang.String CV, int val, ProgListener p)
Confirm the value of a CV using the specified programming mode.boolean
getCanWrite(java.lang.String cv)
Checks the general write capability, regardless of mode, for a specific addressjava.util.List<ProgrammingMode>
getSupportedModes()
Get the list ofProgrammingMode
supported by this Programmer.Programmer.WriteConfirmMode
getWriteConfirmMode(java.lang.String addr)
Learn about whether the programmer does any kind of verification of write operationsprotected 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.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, getCanRead, getCanWrite, getMode, 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
-
tc
protected BiDiBTrafficController tc
-
progNode
protected org.bidib.jbidibc.messages.Node progNode
-
progState
int progState
-
NOTPROGRAMMING
static final int NOTPROGRAMMING
- See Also:
- Constant Field Values
-
COMMANDSENT
static final int COMMANDSENT
- See Also:
- Constant Field Values
-
COMMANDSENT_2
static final int COMMANDSENT_2
- See Also:
- Constant Field Values
-
_progRead
boolean _progRead
-
_val
int _val
-
_cv
int _cv
-
-
Constructor Detail
-
BiDiBProgrammer
public BiDiBProgrammer(BiDiBTrafficController 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. BiDiB programming modes available depend on settings- Specified by:
getSupportedModes
in interfaceProgrammer
- Specified by:
getSupportedModes
in classAbstractProgrammer
- Returns:
- the list of supported modes or an empty list
-
getCanWrite
public boolean getCanWrite(java.lang.String cv)
Checks the general write capability, regardless of mode, for a specific address Checks using the current default programming mode. The default implementation does not check for cv > 1024 - not neccessary? We do it here anywhere- Specified by:
getCanWrite
in interfaceProgrammer
- Overrides:
getCanWrite
in classAbstractProgrammer
- Parameters:
cv
- the address to write to- Returns:
- true if the address can be written to; false otherwise
-
getWriteConfirmMode
@Nonnull public Programmer.WriteConfirmMode getWriteConfirmMode(java.lang.String addr)
Learn about whether the programmer does any kind of verification of write operations By default, say that no verification is done.- Specified by:
getWriteConfirmMode
in interfaceProgrammer
- Overrides:
getWriteConfirmMode
in classAbstractProgrammer
- Parameters:
addr
- A CV address to check (in case this varies with CV range) or null for any- Returns:
- Always WriteConfirmMode.NotVerified
-
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
-
timeout
protected void timeout()
Internal routine to handle a timeout, should be synchronized! Internal routine to handle a timeout- Specified by:
timeout
in classAbstractProgrammer
-
cleanup
void cleanup()
-
notifyProgListenerEnd
protected void notifyProgListenerEnd(int value, int status)
-
-