Package jmri

Interface Programmer

    • Method Detail

      • writeCV

        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)

        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

        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)

        Parameters:
        CV - the CV to read
        p - the listener that will be notified of the read
        Throws:
        ProgrammerException - if unable to communicate

      • readCV

        default void readCV​(java.lang.String CV,
                    ProgListener p,
                    int startVal)
             throws ProgrammerException
        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)

        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

        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)

        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

        ProgrammingMode getMode()
        Get the current programming mode
        Returns:
        the current mode or null if none is defined and no default mode is defined

      • getCanRead

        boolean getCanRead()
        Checks the general read capability, regardless of mode
        Returns:
        true if the programmer is capable of reading; false otherwise

      • getCanRead

        boolean getCanRead​(java.lang.String addr)
        Checks the general read capability, regardless of mode, for a specific address
        Parameters:
        addr - the address to read
        Returns:
        true if the address can be read; false otherwise

      • getCanWrite

        boolean getCanWrite()
        Checks the general write capability, regardless of mode
        Returns:
        true if the programmer is capable of writing; false otherwise

      • getCanWrite

        boolean getCanWrite​(java.lang.String addr)
        Checks the general write capability, regardless of mode, for a specific address
        Parameters:
        addr - the address to write to
        Returns:
        true if the address can be written to; false otherwise

      • getWriteConfirmMode

        @Nonnull
Programmer.WriteConfirmMode getWriteConfirmMode​(java.lang.String addr)
        Learn about whether the programmer does any kind of verification of write operations
        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)

      • dispose

        default void dispose()
        Free up system resources. Overriding classes should be capable of this being called multiple times as per the Disposable interface. Called when disposing of a disposable.

        Note there are no assurances this method will not be called multiple times against a single instance of this Disposable. It is the responsibility of this Disposable to protect itself and the application from ensuring that calling this method multiple times has no unwanted side effects.

        Specified by:
        dispose in interface Disposable