Class AccessoryOpsModeProgrammerFacade
- java.lang.Object
-
- jmri.jmrix.AbstractProgrammerFacade
-
- jmri.implementation.AccessoryOpsModeProgrammerFacade
-
- All Implemented Interfaces:
java.util.EventListener
,Disposable
,ProgListener
,Programmer
public class AccessoryOpsModeProgrammerFacade extends AbstractProgrammerFacade implements ProgListener
Programmer facade for access to Accessory Decoder Ops Mode programming(Eventually implements four modes, passing all others to underlying programmer:
- OPSACCBYTEMODE
- OPSACCBITMODE
- OPSACCEXTBYTEMODE
- OPSACCEXTBITMODE
Used through the String write/read/confirm interface. Accepts integers as addresses, but then emits NMRA DCC packets through the default CommandStation interface (which must be present)
- See Also:
ProgrammerFacadeSelector
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) static class
AccessoryOpsModeProgrammerFacade.ProgState
-
Nested classes/interfaces inherited from interface jmri.Programmer
Programmer.WriteConfirmMode
-
-
Field Summary
Fields Modifier and Type Field Description (package private) java.lang.String
_addrType
(package private) AddressedProgrammer
_baseProg
(package private) java.lang.String
_cv
(package private) int
_delay
(package private) int
_val
(package private) Programmer
aprog
(package private) ProgrammingMode
mode
(package private) AccessoryOpsModeProgrammerFacade.ProgState
state
-
Fields inherited from class jmri.jmrix.AbstractProgrammerFacade
prog
-
Fields inherited from interface jmri.ProgListener
CommError, ConfirmFailed, FailedTimeout, NoAck, NoLocoDetected, NotImplemented, OK, ProgrammerBusy, ProgrammingShort, SequenceError, UnknownError, UserAborted
-
-
Constructor Summary
Constructors Constructor Description AccessoryOpsModeProgrammerFacade(Programmer prog, java.lang.String addrType, int delay, AddressedProgrammer baseProg)
Programmer facade for access to Accessory Decoder Ops Mode programming.
-
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.boolean
getCanRead()
Checks the general read capability, regardless of modeboolean
getCanRead(java.lang.String addr)
Checks the general read capability, regardless of mode, for a specific addressboolean
getCanWrite()
Checks the general write capability, regardless of modeboolean
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
programmingOpReply(int value, int status)
Receive a callback at the end of a programming operation.void
readCV(java.lang.String cv, ProgListener p)
Perform a CV read in the system-specific manner, and using the specified programming mode.void
readCV(java.lang.String cv, 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
setMode(ProgrammingMode p)
Don't pass this mode through, as the underlying doesn't have it (although we should check).protected void
useProgrammer(ProgListener p)
Internal method to remember who's using the programmer.void
writeCV(java.lang.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, decodeErrorCode, getMode, getWriteConfirmMode, 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
dispose, notifyProgListenerEnd
-
-
-
-
Field Detail
-
mode
ProgrammingMode mode
-
aprog
Programmer aprog
-
_val
int _val
-
_cv
java.lang.String _cv
-
_addrType
java.lang.String _addrType
-
_delay
int _delay
-
_baseProg
AddressedProgrammer _baseProg
-
-
Constructor Detail
-
AccessoryOpsModeProgrammerFacade
public AccessoryOpsModeProgrammerFacade(Programmer prog, @Nonnull java.lang.String addrType, int delay, AddressedProgrammer baseProg)
Programmer facade for access to Accessory Decoder Ops Mode programming.- Parameters:
prog
- The (possibly already decorated) programmer we are piggybacking on.addrType
- A string. "accessory" or "output" causes the address to be interpreted as an 11 bit accessory output address. "decoder" causes the address to be interpreted as a 9 bit accessory decoder address "signal" causes the address to be interpreted as an 11 bit signal decoder address.delay
- A string representing the desired delay between programming operations, in milliseconds.baseProg
- The underlying undecorated Ops Mode Programmer we are piggybacking on.
-
-
Method Detail
-
getSupportedModes
@Nonnull public java.util.List<ProgrammingMode> getSupportedModes()
Description copied from class:AbstractProgrammerFacade
Get the list ofProgrammingMode
supported by this Programmer. If the order is significant, earlier modes are better.- Specified by:
getSupportedModes
in interfaceProgrammer
- Overrides:
getSupportedModes
in classAbstractProgrammerFacade
- Returns:
- the list of supported modes or an empty list
-
setMode
public void setMode(ProgrammingMode p)
Don't pass this mode through, as the underlying doesn't have it (although we should check).- Specified by:
setMode
in interfaceProgrammer
- Overrides:
setMode
in classAbstractProgrammerFacade
- Parameters:
p
- The desired programming mode
-
getCanRead
public boolean getCanRead()
Description copied from class:AbstractProgrammerFacade
Checks the general read capability, regardless of mode- Specified by:
getCanRead
in interfaceProgrammer
- Overrides:
getCanRead
in classAbstractProgrammerFacade
- Returns:
- true if the programmer is capable of reading; false otherwise
-
getCanRead
public boolean getCanRead(java.lang.String addr)
Description copied from class:AbstractProgrammerFacade
Checks the general read capability, regardless of mode, for a specific address- Specified by:
getCanRead
in interfaceProgrammer
- Overrides:
getCanRead
in classAbstractProgrammerFacade
- Parameters:
addr
- the address to read- Returns:
- true if the address can be read; false otherwise
-
getCanWrite
public boolean getCanWrite()
Description copied from class:AbstractProgrammerFacade
Checks the general write capability, regardless of mode- Specified by:
getCanWrite
in interfaceProgrammer
- Overrides:
getCanWrite
in classAbstractProgrammerFacade
- Returns:
- true if the programmer is capable of writing; false otherwise
-
getCanWrite
public boolean getCanWrite(java.lang.String addr)
Description copied from class:AbstractProgrammerFacade
Checks the general write capability, regardless of mode, for a specific address- Specified by:
getCanWrite
in interfaceProgrammer
- Overrides:
getCanWrite
in classAbstractProgrammerFacade
- 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 cv, int val, ProgListener p) throws ProgrammerException
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
public void readCV(java.lang.String cv, ProgListener p) throws ProgrammerException
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
-
readCV
public void readCV(java.lang.String cv, ProgListener p, int startVal) throws ProgrammerException
Description copied from interface:Programmer
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:
cv
- 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
-
confirmCV
public void confirmCV(java.lang.String cv, int val, ProgListener p) throws ProgrammerException
Description copied from class:AbstractProgrammerFacade
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
- Overrides:
confirmCV
in classAbstractProgrammerFacade
- 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
-
useProgrammer
protected void useProgrammer(ProgListener p) throws ProgrammerException
Internal method to remember who's using the programmer.- Parameters:
p
- the programmer- Throws:
ProgrammerException
- if p is already in use
-
programmingOpReply
public void programmingOpReply(int value, int status)
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.
-
-