Class TamsTurnout

All Implemented Interfaces:
PropertyChangeListener, Comparable<NamedBean>, EventListener, PropertyChangeProvider, DigitalIO, AbstractMRListener, TamsListener, NamedBean, Turnout

public class TamsTurnout
extends AbstractTurnout
implements TamsListener
Implement a Turnout via Tams communications.

This object doesn't listen to the Tams communications. This is because it should be the only object that is sending messages for this turnout; more than one Turnout object pointing to a single device is not allowed.

Based on work by Bob Jacobsen and Kevin Dickerson Copyright

  • Field Details

  • Constructor Details

    • TamsTurnout

      public TamsTurnout​(int number, 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 Details

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

      public void turnoutPushbuttonLockout​(boolean b)
      Specified by:
      turnoutPushbuttonLockout in class AbstractTurnout
    • canInvert

      public boolean canInvert()
      Tams turnouts can be inverted.
      Specified by:
      canInvert in interface Turnout
      Overrides:
      canInvert in class AbstractTurnout
      Returns:
      invert supported
    • 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
    • reply

      public void reply​(TamsReply m)
      Specified by:
      reply in interface TamsListener
    • setFeedbackMode

      public void setFeedbackMode​(int mode) throws 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:
      IllegalArgumentException - if mode is not valid
    • message

      public void message​(TamsMessage m)
      Specified by:
      message in interface TamsListener
    • 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