Package jmri.implementation

Class TwoIndexTcsProgrammerFacade

java.lang.Object

jmri.jmrix.AbstractProgrammerFacade

jmri.implementation.TwoIndexTcsProgrammerFacade

All Implemented Interfaces:

EventListener, Disposable, ProgListener, Programmer

public class TwoIndexTcsProgrammerFacade
extends AbstractProgrammerFacade
implements ProgListener

Programmer facade for single index multi-CV access.

Used through the String write/read/confirm interface. Accepts address formats:

• T2CV.11.12
  The write operation writes 11 to the first index CV (201), 12 to the 2nd index CV (202), then writes the data to CV 203 (MSB) and 204 (LSB).
  The read operation is slightly different, writing 111 (100+11) to CV201, then 12 to the 2nd index CV (202), then writes 100 to CV204, then reads the two values from CV203 and CV204.
• T3CV.11.12.13
  The write operation writes 11 to the first index CV (201), the data to the 2nd index CV (202), then writes 12 to CV203 and 13 to CV204.
  The read operation writes 11 to CV201, then 12 to CV203, then 13 to CV204, then reads from CV202.

All others pass through to the next facade or programmer. E.g. 123 will do a write/read/confirm to 123, or some other facade can provide "normal" indexed addressing.

See Also:

• ProgrammerFacadeSelector

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static enum	TwoIndexTcsProgrammerFacade.ProgState

Nested classes/interfaces inherited from interface jmri.Programmer

Programmer.Configurator, Programmer.WriteConfirmMode

Field Summary

Fields

Modifier and Type	Field	Description
(package private) String	_cv
(package private) int	_startLSB
(package private) int	_startMSB
(package private) int	_startVal
(package private) int	_val
static int	delayInterval
(package private) static final String	format2Flag
(package private) static final String	format3Flag
(package private) static final String	indexPI
(package private) static final String	indexSI
(package private) static final int	readOffset
(package private) static final String	readStrobe
(package private) TwoIndexTcsProgrammerFacade.ProgState	state
(package private) int	upperByte
(package private) static final String	valLSB
(package private) static final String	valMSB
(package private) int	valueLSB
(package private) int	valueMSB
(package private) int	valuePI
(package private) int	valueSI

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
TwoIndexTcsProgrammerFacade(Programmer prog)

Method Summary

Modifier and Type	Method	Description
void	confirmCV(String CV, int startVal, ProgListener p)	Confirm the value of a CV using the specified programming mode.
protected void	processProgrammingOpReply(int value, int status)
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.
void	readCV(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.
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, decodeErrorCode, getCanRead, getCanRead, getCanWrite, getCanWrite, getMode, getSupportedModes, getWriteConfirmMode, removePropertyChangeListener, setMode

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, getConfigurator, notifyProgListenerEnd

Field Details

indexPI

static final String indexPI

See Also:

• Constant Field Values

indexSI

static final String indexSI

See Also:

• Constant Field Values

valMSB

static final String valMSB

See Also:

• Constant Field Values

valLSB

static final String valLSB

See Also:

• Constant Field Values

readStrobe

static final String readStrobe

See Also:

• Constant Field Values

format2Flag

static final String format2Flag

See Also:

• Constant Field Values

format3Flag

static final String format3Flag

See Also:

• Constant Field Values

readOffset

static final int readOffset

See Also:

• Constant Field Values

_val

int _val

_cv

String _cv

valuePI

int valuePI

valueSI

int valueSI

valueMSB

int valueMSB

valueLSB

int valueLSB

_startVal

int _startVal

_startMSB

int _startMSB

_startLSB

int _startLSB

state

TwoIndexTcsProgrammerFacade.ProgState state

upperByte

int upperByte

delayInterval

public static int delayInterval

Constructor Details

TwoIndexTcsProgrammerFacade

public TwoIndexTcsProgrammerFacade(Programmer prog)

Parameters:

prog - the programmer this facade is attached to

Method Details

writeCV

public void writeCV(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 interface Programmer

Overrides:

writeCV in class AbstractProgrammerFacade

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

Overrides:

readCV in class AbstractProgrammerFacade

Parameters:

CV - the CV to read

p - the listener that will be notified of the read

Throws:

ProgrammerException - if unable to communicate

readCV

public void readCV(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 interface Programmer

Parameters:

CV - the CV to read

p - the listener that will be notified of the read

startVal - a hint of what the current value might be, or 0

Throws:

ProgrammerException - if unable to communicate

confirmCV

public void confirmCV(String CV,
 int startVal,
 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 interface Programmer

Overrides:

confirmCV in class AbstractProgrammerFacade

Parameters:

CV - the CV to confirm

startVal - the value to confirm

p - the listener that will be notified of the confirmation

Throws:

ProgrammerException - if unable to communicate

useProgrammer

protected void useProgrammer(ProgListener p)
                      throws ProgrammerException

Throws:

ProgrammerException

programmingOpReply

public void programmingOpReply(int value,
 int status)

Receive a callback at the end of a programming operation. Note this assumes that there's only one phase to the operation

Specified by:

programmingOpReply in interface ProgListener

Parameters:

value - Value from a read operation, or value written on a write

status - Denotes the completion code. Note that this is a bitwise combination of the various status coded defined in this interface.

processProgrammingOpReply

protected void processProgrammingOpReply(int value,
 int status)