Class LnOpsModeProgrammer
- java.lang.Object
-
- jmri.beans.PropertyChangeSupport
-
- jmri.jmrix.loconet.LnOpsModeProgrammer
-
- All Implemented Interfaces:
java.util.EventListener
,AddressedProgrammer
,PropertyChangeFirer
,PropertyChangeProvider
,Disposable
,LocoNetListener
,Programmer
public class LnOpsModeProgrammer extends PropertyChangeSupport implements AddressedProgrammer, LocoNetListener
Provide an Ops Mode Programmer via a wrapper that works with the LocoNet SlotManager object. Specific handling for message formats:- LOCONETOPSBOARD
- LOCONETSV1MODE
- LOCONETSV2MODE
- LOCONETLNCVMODE
- LOCONETBDOPSWMODE
- LOCONETBD7OPSWMODE
- LOCONETCSOPSWMODE
LnProgrammerManager
Note that running a simulated LocoNet connection,HexFileFrame.configure()
will substitute theProgDebugger
for theLnOpsModeProgrammer
, overridingreadCV(String, ProgListener)
andwriteCV(String, int, ProgListener)
.- See Also:
Programmer
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface jmri.Programmer
Programmer.WriteConfirmMode
-
-
Field Summary
Fields Modifier and Type Field Description (package private) boolean
boardOpSwWriteVal
(package private) boolean
doingWrite
(package private) int
mAddress
(package private) LocoNetSystemConnectionMemo
memo
(package private) boolean
mLongAddr
protected ProgrammingMode
mode
(package private) ProgListener
p
-
Fields inherited from class jmri.beans.PropertyChangeSupport
propertyChangeSupport
-
-
Constructor Summary
Constructors Constructor Description LnOpsModeProgrammer(LocoNetSystemConnectionMemo memo, int pAddress, boolean pLongAddr)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
confirmCV(java.lang.String CV, int val, ProgListener pL)
Confirm the value of a CV using the specified programming mode.(package private) int
decodeCvNum(java.lang.String CV)
java.lang.String
decodeErrorCode(int i)
void
dispose()
Free up system resources.java.lang.String
getAddress()
int
getAddressNumber()
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 addressboolean
getLongAddress()
ProgrammingMode
getMode()
Get the current programming modejava.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 operations(package private) void
initializeBdOpsAccessTimer()
(package private) void
initializeLncvAccessTimer()
(package private) void
initializeSV2AccessTimer()
(package private) void
loadSV2MessageFormat(LocoNetMessage m, int mAddress, int cvAddr, int data)
Fill in an SV2 format LocoNet message from parameters provided.void
message(LocoNetMessage m)
Member function that will be invoked by a LocoNetInterface implementation to forward a LocoNet message from the layout.void
readCV(java.lang.String CV, ProgListener pL)
Perform a CV read in the system-specific manner, and using the specified programming mode.void
setMode(ProgrammingMode m)
Set the programmer to a particular mode.void
writeCV(java.lang.String CV, int val, ProgListener pL)
Perform a CV write in the system-specific manner, and using the specified programming mode.-
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, notifyProgListenerEnd, readCV, removePropertyChangeListener
-
-
-
-
Field Detail
-
mAddress
int mAddress
-
mLongAddr
boolean mLongAddr
-
doingWrite
boolean doingWrite
-
boardOpSwWriteVal
boolean boardOpSwWriteVal
-
mode
protected ProgrammingMode mode
-
-
Constructor Detail
-
LnOpsModeProgrammer
public LnOpsModeProgrammer(LocoNetSystemConnectionMemo memo, int pAddress, boolean pLongAddr)
-
-
Method Detail
-
writeCV
public void writeCV(java.lang.String CV, int val, ProgListener pL) 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
- Parameters:
CV
- the CV to writeval
- the value to writepL
- the listener that will be notified of the write- Throws:
ProgrammerException
- if unable to communicate
-
readCV
public void readCV(java.lang.String CV, ProgListener pL) 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
- Parameters:
CV
- the CV to read, could be a composite string that is split in this method te pass eg. the module typepL
- the listener that will be notified of the read- Throws:
ProgrammerException
- if unable to communicate
-
confirmCV
public void confirmCV(java.lang.String CV, int val, ProgListener pL) 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
- Parameters:
CV
- the CV to confirmval
- the value to confirmpL
- the listener that will be notified of the confirmation- Throws:
ProgrammerException
- if unable to communicate
-
message
public void message(LocoNetMessage m)
Member function that will be invoked by a LocoNetInterface implementation to forward a LocoNet message from the layout.- Specified by:
message
in interfaceLocoNetListener
- Parameters:
m
- The received LocoNet message. Note that this same object may be presented to multiple users. It should not be modified here.
-
decodeCvNum
int decodeCvNum(java.lang.String CV)
-
loadSV2MessageFormat
void loadSV2MessageFormat(LocoNetMessage m, int mAddress, int cvAddr, int data)
Fill in an SV2 format LocoNet message from parameters provided. Compare to SV2 message handler inLnSv2MessageContents.createSv2Message(int, int, int, int, int, int, int, int)
- Parameters:
m
- Base LocoNet message to fillmAddress
- Destination board addresscvAddr
- Dest. board CV numberdata
- Value to put into CV
-
setMode
public final void setMode(ProgrammingMode m)
Set the programmer to a particular mode.Mode is a bound parameter; mode changes fire listeners.
Only modes returned by
Programmer.getSupportedModes()
are supported. If an invalid mode is requested, the active mode is unchanged.- Specified by:
setMode
in interfaceProgrammer
- Parameters:
m
- a valid node returned byProgrammer.getSupportedModes()
or null; null is ignored ifProgrammer.getSupportedModes()
is not empty
-
getMode
public final ProgrammingMode getMode()
Get the current programming mode- Specified by:
getMode
in interfaceProgrammer
- Returns:
- the current mode or null if none is defined and no default mode is defined
-
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.- Specified by:
getSupportedModes
in interfaceProgrammer
- Returns:
- the list of supported modes or an empty list
-
getWriteConfirmMode
@Nonnull public Programmer.WriteConfirmMode getWriteConfirmMode(java.lang.String addr)
Learn about whether the programmer does any kind of verification of write operations Confirmation mode by programming mode; not that this doesn't yet know whether BDL168 hardware is present to allow DecoderReply to function; that should be a preference eventually. See also DCS240...- Specified by:
getWriteConfirmMode
in interfaceProgrammer
- Parameters:
addr
- CV address ignored, as there's no variance with this in LocoNet- Returns:
- depends on programming mode
-
getCanRead
public boolean getCanRead()
Checks the general read capability, regardless of mode Can this ops-mode programmer read back values? Yes, if transponding hardware is present and regular ops mode, or if in any other mode.- Specified by:
getCanRead
in interfaceProgrammer
- Returns:
- always true
-
getCanRead
public boolean getCanRead(java.lang.String addr)
Checks the general read capability, regardless of mode, for a specific address- Specified by:
getCanRead
in interfaceProgrammer
- Parameters:
addr
- the address to read- Returns:
- true if the address can be read; false otherwise
-
getCanWrite
public boolean getCanWrite()
Checks the general write capability, regardless of mode- Specified by:
getCanWrite
in interfaceProgrammer
- Returns:
- true if the programmer is capable of writing; false otherwise
-
getCanWrite
public boolean getCanWrite(java.lang.String addr)
Checks the general write capability, regardless of mode, for a specific address- Specified by:
getCanWrite
in interfaceProgrammer
- Parameters:
addr
- the address to write to- Returns:
- true if the address can be written to; false otherwise
-
decodeErrorCode
@Nonnull public java.lang.String decodeErrorCode(int i)
- Specified by:
decodeErrorCode
in interfaceProgrammer
-
getLongAddress
public boolean getLongAddress()
- Specified by:
getLongAddress
in interfaceAddressedProgrammer
-
getAddressNumber
public int getAddressNumber()
- Specified by:
getAddressNumber
in interfaceAddressedProgrammer
-
getAddress
public java.lang.String getAddress()
- Specified by:
getAddress
in interfaceAddressedProgrammer
-
initializeBdOpsAccessTimer
void initializeBdOpsAccessTimer()
-
initializeSV2AccessTimer
void initializeSV2AccessTimer()
-
initializeLncvAccessTimer
void initializeLncvAccessTimer()
-
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
-
-