Class OpsModeDelayedProgrammerFacade

  • All Implemented Interfaces:
    java.util.EventListener, Disposable, ProgListener, Programmer

    public class OpsModeDelayedProgrammerFacade
    extends AbstractProgrammerFacade
    implements ProgListener
    Programmer facade for access to Accessory Decoder Ops Mode programming

    (Eventually implements four modes, passing all others to underlying programmer:

    • OPSACCBYTEMODE
    • OPSACCBITMODE
    • OPSACCEXTBYTEMODE
    • OPSACCEXTBITMODE

    Used through the String write/read/confirm interface. Accepts integers as addresses, but then emits NMRA DCC packets through the default CommandStation interface (which must be present)

    See Also:
    ProgrammerFacadeSelector
    • Constructor Detail

      • OpsModeDelayedProgrammerFacade

        public OpsModeDelayedProgrammerFacade​(Programmer prog,
                                              int writeDelay)
        Programmer facade for access to Accessory Decoder Ops Mode programming.
        Parameters:
        prog - The Ops Mode Programmer we are piggybacking on.
        writeDelay - A string representing the desired delay after a write operation, in milliseconds.
    • 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 val,
                              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
        val - 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)
        Description copied from interface: ProgListener
        Receive a callback at the end of a programming 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.