Package jmri.implementation

Class TwoIndexTcsProgrammerFacade

  • All Implemented Interfaces:
    java.util.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

    • Method Detail

      • 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 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​(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 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​(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 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​(java.lang.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

      • 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.