Class XNetOpsModeProgrammer

    • Method Detail

      • writeCV

        public void writeCV​(java.lang.String CVname,
                            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) Send an ops-mode write request to the Xpressnet.

        Specified by:
        writeCV in interface Programmer
        Specified by:
        writeCV in class AbstractProgrammer
        Parameters:
        CVname - 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 CVname,
                           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
        Specified by:
        readCV in class AbstractProgrammer
        Parameters:
        CVname - 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 CVname,
                              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
        Specified by:
        confirmCV in class AbstractProgrammer
        Parameters:
        CVname - 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
      • getCanRead

        public boolean getCanRead()
        Checks the general read capability, regardless of mode Basic implementation. Override this to turn reading on and off globally. Can this ops-mode programmer read back values? Indirectly we can, though this requires an external display (a Lenz LRC120) and enabling railcom.
        Specified by:
        getCanRead in interface Programmer
        Overrides:
        getCanRead in class AbstractProgrammer
        Returns:
        true to allow us to trigger an ops mode read
      • message

        public void message​(XNetReply l)
        Member function that will be invoked by an XNetInterface implementation to forward an XNet message from the layout.
        Specified by:
        message in interface XNetListener
        Parameters:
        l - The received XNet message. Note that this same object may be presented to multiple users. It should not be modified here.
      • message

        public void message​(XNetMessage l)
        Member function that will be invoked by an XNetInterface implementation to forward an XNet message sent to the layout. Normally, this function will do nothing.
        Specified by:
        message in interface XNetListener
        Parameters:
        l - The received XNet message. Note that this same object may be presented to multiple users. It should not be modified here.
      • notifyTimeout

        public void notifyTimeout​(XNetMessage msg)
        Member function invoked by an XNetInterface implementation to notify a sender that an outgoing message timed out and was dropped from the queue. Handle a timeout notification
        Specified by:
        notifyTimeout in interface XNetListener
        Parameters:
        msg - message which has timed out.