Class VerifyWriteProgrammerFacade
- All Implemented Interfaces:
EventListener
,ProgListener
,Programmer
public class VerifyWriteProgrammerFacade extends AbstractProgrammerFacade implements ProgListener
If the underlying programmer (1) can read and (2) is not already doing a read verify, each write operation is followed by a readback. If the value doesn't match, an error is signaled.
State Diagram for read and write operations (click to magnify):
- See Also:
ProgrammerFacadeSelector
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) static class
VerifyWriteProgrammerFacade.ProgState
-
Field Summary
Fields Modifier and Type Field Description (package private) String
_cv
(package private) int
_val
(package private) VerifyWriteProgrammerFacade.ProgState
state
Fields inherited from interface jmri.ProgListener
CommError, ConfirmFailed, FailedTimeout, NoAck, NoLocoDetected, NotImplemented, OK, ProgrammerBusy, ProgrammingShort, SequenceError, UnknownError, UserAborted
-
Constructor Summary
Constructors Constructor Description VerifyWriteProgrammerFacade(Programmer prog)
-
Method Summary
Modifier and Type Method Description Programmer.WriteConfirmMode
getWriteConfirmMode(String addr)
This facade ensures thatProgrammer.WriteConfirmMode.ReadAfterWrite
is done, so long as it has permission to read the CV after writing.void
programmingOpReply(int value, int status)
Receive a callback at the end of a programming operation.void
readCV(String CV, ProgListener p)
Perform a CV read in the system-specific manner, and using the specified programming mode.protected void
useProgrammer(ProgListener p)
void
writeCV(String CV, 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.AbstractProgrammerFacade
addPropertyChangeListener, confirmCV, decodeErrorCode, getCanRead, getCanRead, getCanWrite, getCanWrite, getMode, getSupportedModes, removePropertyChangeListener, setMode
-
Field Details
-
Constructor Details
-
VerifyWriteProgrammerFacade
- Parameters:
prog
- the programmer to which this facade is attached
-
-
Method Details
-
writeCV
Description copied from class:AbstractProgrammerFacade
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
- Overrides:
writeCV
in classAbstractProgrammerFacade
- Parameters:
CV
- the CV to writeval
- the value to writep
- the listener that will be notified of the write- Throws:
ProgrammerException
- if unable to communicate
-
readCV
Description copied from class:AbstractProgrammerFacade
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
- Overrides:
readCV
in classAbstractProgrammerFacade
- Parameters:
CV
- the CV to readp
- the listener that will be notified of the read- Throws:
ProgrammerException
- if unable to communicate
-
getWriteConfirmMode
This facade ensures thatProgrammer.WriteConfirmMode.ReadAfterWrite
is done, so long as it has permission to read the CV after writing.- Specified by:
getWriteConfirmMode
in interfaceProgrammer
- Overrides:
getWriteConfirmMode
in classAbstractProgrammerFacade
- Parameters:
addr
- A CV address to check (in case this varies with CV range) or null for any- Returns:
- The confirmation behavior that can be counted on (might be better in some cases)
-
useProgrammer
- Throws:
ProgrammerException
-
programmingOpReply
Description copied from interface:ProgListener
Receive a callback at the end of a programming operation.- Specified by:
programmingOpReply
in interfaceProgListener
- Parameters:
value
- Value from a read operation, or value written on a writestatus
- Denotes the completion code. Note that this is a bitwise combination of the various status coded defined in this interface.
-