Package jmri.jmrix

Class AbstractProgrammerFacade

java.lang.Object

jmri.jmrix.AbstractProgrammerFacade

All Implemented Interfaces:

Disposable, Programmer

Direct Known Subclasses:

AccessoryOpsModeProgrammerFacade, AddressedHighCvProgrammerFacade, MultiIndexProgrammerFacade, OffsetHighCvProgrammerFacade, OpsModeDelayedProgrammerFacade, ResettingOffsetHighCvProgrammerFacade, TwoIndexTcsProgrammerFacade, VerifyWriteProgrammerFacade

public abstract class AbstractProgrammerFacade
extends java.lang.Object
implements Programmer

Common implementations of the Programmer interface for making Programmer facade classes.

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.Programmer

Programmer.WriteConfirmMode

Field Summary

Fields

Modifier and Type	Field	Description
protected Programmer	prog

Constructor Summary

Constructors

Constructor	Description
AbstractProgrammerFacade(Programmer prog)

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener l)
void	confirmCV(java.lang.String CV, int val, ProgListener p)	Confirm the value of a CV using the specified programming mode.
java.lang.String	decodeErrorCode(int code)
boolean	getCanRead()	Checks the general read capability, regardless of mode
boolean	getCanRead(java.lang.String addr)	Checks the general read capability, regardless of mode, for a specific address
boolean	getCanWrite()	Checks the general write capability, regardless of mode
boolean	getCanWrite(java.lang.String addr)	Checks the general write capability, regardless of mode, for a specific address
ProgrammingMode	getMode()	Get the current programming mode
java.util.List<ProgrammingMode>	getSupportedModes()	Get the list of ProgrammingMode supported by this Programmer.
Programmer.WriteConfirmMode	getWriteConfirmMode(java.lang.String addr)	Learn about whether the programmer does any kind of verification of write operations
void	readCV(java.lang.String CV, ProgListener p)	Perform a CV read in the system-specific manner, and using the specified programming mode.
void	removePropertyChangeListener(java.beans.PropertyChangeListener l)
void	setMode(ProgrammingMode p)	Set the programmer to a particular mode.
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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jmri.Programmer

dispose, notifyProgListenerEnd, readCV

Field Detail

prog

protected Programmer prog

Constructor Detail

AbstractProgrammerFacade

public AbstractProgrammerFacade(Programmer prog)

Method Detail

decodeErrorCode

@Nonnull
public java.lang.String decodeErrorCode(int code)

Specified by:

decodeErrorCode in interface Programmer

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener l)

Specified by:

addPropertyChangeListener in interface Programmer

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener l)

Specified by:

removePropertyChangeListener in interface Programmer

writeCV

public void writeCV(java.lang.String CV,
                    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 interface Programmer

Parameters:

CV - 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 CV,
                   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

Parameters:

CV - 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

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

getMode

public ProgrammingMode getMode()

Get the current programming mode

Specified by:

getMode in interface Programmer

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 of ProgrammingMode supported by this Programmer. If the order is significant, earlier modes are better.

Specified by:

getSupportedModes in interface Programmer

Returns:

the list of supported modes or an empty list

setMode

public void setMode(ProgrammingMode p)

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

Parameters:

p - a valid node returned by Programmer.getSupportedModes() or null; null is ignored if Programmer.getSupportedModes() is not empty

getCanRead

public boolean getCanRead()

Checks the general read capability, regardless of mode

Specified by:

getCanRead in interface Programmer

Returns:

true if the programmer is capable of reading; false otherwise

getCanRead

public boolean getCanRead(java.lang.String addr)

Checks the general read capability, regardless of mode, for a specific address

Specified by:

getCanRead in interface Programmer

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

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

Parameters:

addr - 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

Specified by:

getWriteConfirmMode in interface Programmer

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)