Package jmri.jmrix.tams

Class TamsTurnout

    • Constructor Detail

      • TamsTurnout

        public TamsTurnout​(int number,
                   java.lang.String prefix,
                   TamsTrafficController etc)
        Tams turnouts use the NMRA number (0-2040) as their numerical identification in the system name.
        Parameters:
        number - DCC address of the turnout
        prefix - system prefix
        etc - Tams system connection traffic controller

    • Method Detail

      • forwardCommandChangeToLayout

        protected void forwardCommandChangeToLayout​(int newState)
        Handle a request to change state, typically by sending a message to the layout in some child class. Public version (used by TurnoutOperator) sends the current commanded state without changing it. Implementing classes will typically check the value of s and send a system specific sendMessage command.
        Specified by:
        forwardCommandChangeToLayout in class AbstractTurnout
        Parameters:
        newState - new state value

      • setCommandedStateFromCS

        void setCommandedStateFromCS​(int state)
        Set the turnout known state to reflect what's been observed from the command station messages. A change there means that somebody commanded a state change (by using a throttle), and that command has already taken effect. Hence we use "newCommandedState" to indicate it's taken place. Must be followed by "newKnownState" to complete the turnout action.
        Parameters:
        state - Observed state, updated state from command station

      • setKnownStateFromCS

        void setKnownStateFromCS​(int state)
        Set the turnout known state to reflect what's been observed from the command station messages. A change there means that somebody commanded a state change (by using a throttle), and that command has already taken effect. Hence we use "newKnownState" to indicate it's taken place.
        Parameters:
        state - Observed state, updated state from command station

      • sendMessage

        protected void sendMessage​(boolean closed)
        Tell the layout to go to new state.
        Parameters:
        closed - State of the turnout to be sent to the command station

      • setFeedbackMode

        public void setFeedbackMode​(int mode)
                     throws java.lang.IllegalArgumentException
        Description copied from class: AbstractTurnout
        On change, fires Property Change "feedbackchange". Set the feedback mode from a integer. This must be one of the bit values defined in a previous Turnout.getValidFeedbackTypes() call. Having more than one bit set is an error.
        Specified by:
        setFeedbackMode in interface Turnout
        Overrides:
        setFeedbackMode in class AbstractTurnout
        Parameters:
        mode - the feedback type to set
        Throws:
        java.lang.IllegalArgumentException - if mode is not valid

      • dispose

        public void dispose()
        Description copied from class: AbstractTurnout
        Deactivate this object, so that it releases as many resources as possible and no longer effects others.

        For example, if this object has listeners, after a call to this method it should no longer notify those listeners. Any native or system-wide resources it maintains should be released, including threads, files, etc.

        It is an error to invoke any other methods on this object once dispose() has been called. Note, however, that there is no guarantee about behavior in that case.

        Afterwards, references to this object may still exist elsewhere, preventing its garbage collection. But it's formally dead, and shouldn't be keeping any other objects alive. Therefore, this method should null out any references to other objects that this NamedBean contained.

        Specified by:
        dispose in interface NamedBean
        Overrides:
        dispose in class AbstractTurnout