Package jmri.jmrix.can.cbus

Class CbusDccOpsModeProgrammer

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.jmrix.AbstractProgrammer

jmri.jmrix.can.cbus.CbusDccProgrammer

jmri.jmrix.can.cbus.CbusDccOpsModeProgrammer

All Implemented Interfaces:

java.util.EventListener, AddressedProgrammer, PropertyChangeFirer, PropertyChangeProvider, Disposable, AbstractMRListener, CanListener, Programmer

public class CbusDccOpsModeProgrammer
extends CbusDccProgrammer
implements AddressedProgrammer

Provide an Ops Mode Programmer via a wrapper what works with the CBUS command station object.

Functionally, this just creates packets to send via the command station.

See Also:

Programmer

Nested Class Summary

Nested classes/interfaces inherited from class jmri.jmrix.can.cbus.CbusDccProgrammer

CbusDccProgrammer.CbusDccProgrammerConfigurator

Nested classes/interfaces inherited from interface jmri.Programmer

Programmer.Configurator, Programmer.WriteConfirmMode

Field Summary

Fields

Modifier and Type	Field	Description
(package private) int	mAddress
(package private) boolean	mLongAddr

Fields inherited from class jmri.jmrix.can.cbus.CbusDccProgrammer

_cv, _nvOffset, _progRead, _val, COMMANDSENT, MODESENT, NOTPROGRAMMING, NVCOMMANDSENT, progState, RETURNSENT, 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
CbusDccOpsModeProgrammer(int pAddress, boolean pLongAddr, TrafficController tc)

Method Summary

Modifier and Type	Method	Description
(package private) void	cleanup()	Ops-mode programming doesn't put the command station in programming mode, so we don't have to send an exit-programming command at end.
void	confirmCV(java.lang.String CV, int val, ProgListener p)	Confirm the value of a CV using the specified programming mode.
java.lang.String	getAddress()
int	getAddressNumber()
boolean	getCanRead()	Checks the general read capability, regardless of mode
boolean	getLongAddress()
java.util.List<ProgrammingMode>	getSupportedModes()	Get the list of ProgrammingMode supported by this Programmer.
void	readCV(java.lang.String CVname, ProgListener p)	Perform a CV read in the system-specific manner, and using the specified programming mode.
void	reply(CanReply m)	Called when an incoming CanFrame is received from the CAN Network.
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.can.cbus.CbusDccProgrammer

dispose, getConfigurator, message, notifyProgListenerEnd, readCV, setNodeOfInterest, timeout, useProgrammer

Methods inherited from class jmri.jmrix.AbstractProgrammer

decodeErrorCode, getBestMode, 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, decodeErrorCode, dispose, getCanRead, getCanWrite, getCanWrite, getConfigurator, getMode, getWriteConfirmMode, notifyProgListenerEnd, readCV, removePropertyChangeListener, setMode

Field Detail

mAddress

int mAddress

mLongAddr

boolean mLongAddr

Constructor Detail

CbusDccOpsModeProgrammer

public CbusDccOpsModeProgrammer(int pAddress,
                                boolean pLongAddr,
                                TrafficController tc)

Method Detail

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) Forward a write request to an ops-mode write operation

Specified by:

writeCV in interface Programmer

Overrides:

writeCV in class CbusDccProgrammer

Parameters:

CVname - the CV to write

val - the value to write

p - the listener that will be notified of the write

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 interface Programmer

Overrides:

readCV in class CbusDccProgrammer

Parameters:

CVname - the CV to read

p - 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 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 interface Programmer

Overrides:

confirmCV in class CbusDccProgrammer

Parameters:

CV - the CV to confirm

val - the value to confirm

p - the listener that will be notified of the confirmation

Throws:

ProgrammerException - if unable to communicate

getSupportedModes

@Nonnull
public java.util.List<ProgrammingMode> getSupportedModes()

Get the list of ProgrammingMode supported by this Programmer. If the order is significant, earlier modes are better. Types implemented here. Types implemented here.

Specified by:

getSupportedModes in interface Programmer

Overrides:

getSupportedModes in class CbusDccProgrammer

Returns:

the list of supported modes or an empty list

reply

public void reply(CanReply m)

Called when an incoming CanFrame is received from the CAN Network.

Specified by:

reply in interface CanListener

Overrides:

reply in class CbusDccProgrammer

Parameters:

m - the CanReply being received.

getCanRead

public boolean getCanRead()

Checks the general read capability, regardless of mode Basic implementation. Override this to turn reading on and off globally. Can this ops-mode programmer read back values?

Specified by:

getCanRead in interface Programmer

Overrides:

getCanRead in class AbstractProgrammer

Returns:

always false

getLongAddress

public boolean getLongAddress()

Specified by:

getLongAddress in interface AddressedProgrammer

getAddressNumber

public int getAddressNumber()

Specified by:

getAddressNumber in interface AddressedProgrammer

getAddress

public java.lang.String getAddress()

Specified by:

getAddress in interface AddressedProgrammer

cleanup

void cleanup()

Ops-mode programming doesn't put the command station in programming mode, so we don't have to send an exit-programming command at end. Therefore, this routine does nothing except to replace the parent routine that does something.