Package jmri.jmrix.openlcb

Class OlcbSensor

java.lang.Object
jmri.implementation.AbstractNamedBean
jmri.implementation.AbstractSensor
jmri.jmrix.openlcb.OlcbSensor
All Implemented Interfaces:
Comparable<NamedBean>, PropertyChangeProvider, DigitalIO, NamedBean, Sensor
public final class OlcbSensor extends AbstractSensor
Extend jmri.AbstractSensor for OpenLCB controls.

  • Field Details

  • Constructor Details

  • Method Details

    • finishLoad

      void finishLoad()
      Helper function that will be invoked after construction once the properties have been loaded. Used specifically for preventing double initialization when loading sensors from XML.

    • getEventName

      public String getEventName(boolean isActive)
      Computes the display name of a given event to be entered into the Event Table.
      Parameters:
      isActive - true for sensor active, false for inactive.
      Returns:
      user-visible string to represent this event.

    • getEventID

      public EventID getEventID(boolean isActive)

    • getRecommendedToolTip

      @CheckReturnValue @Nonnull public String getRecommendedToolTip()
      Description copied from interface: NamedBean
      Get a recommended text for a tooltip when displaying the NamedBean, e.g. in a list or table. By default, this is the comment from the NamedBean, on the theory that the system name and/or user name are being displayed directly. Specific system implementations may override that.
      Returns:
      empty String if no recommendation.

    • setUserName

      @OverridingMethodsMustInvokeSuper public void setUserName(String s) throws NamedBean.BadUserNameException
      Updates event table entries when the user name changes.
      Specified by:
      setUserName in interface NamedBean
      Overrides:
      setUserName in class AbstractNamedBean
      Parameters:
      s - new user name
      Throws:
      NamedBean.BadUserNameException - see NamedBean

    • requestUpdateFromLayout

      public void requestUpdateFromLayout()
      Request an update on status by sending an OpenLCB message.

    • setKnownState

      public void setKnownState(int s)
      User request to set the state, which means that we broadcast that to all listeners by putting it out on CBUS. In turn, the code in this class should use setOwnState to handle internal sets and bean notifies.
      Specified by:
      setKnownState in interface Sensor
      Overrides:
      setKnownState in class AbstractSensor
      Parameters:
      s - the state to set

    • setTimeout

      void setTimeout()
      Have sensor return to inactive after delay, used if no inactive event was specified

    • setAuthoritative

      public void setAuthoritative(boolean authoritative)
      Changes how the sensor reacts to inquire state events. With authoritative == false the state will always be reported as UNKNOWN to the layout when queried.
      Parameters:
      authoritative - whether we should respond true state or unknown to the layout event state inquiries.

    • isAuthoritative

      public boolean isAuthoritative()
      Returns:
      whether this producer/consumer is enabled to return state to the layout upon queries.

    • setProperty

      public void setProperty(@Nonnull String key, Object value)
      Description copied from class: AbstractNamedBean
      Attach a key/value pair to the NamedBean, which can be retrieved later. These are not bound properties as yet, and don't throw events on modification. Key must not be null.

      The key is constrained to String to make these behave like normal Java Beans.

      Specified by:
      setProperty in interface NamedBean
      Overrides:
      setProperty in class AbstractNamedBean
      Parameters:
      key - the property to set
      value - the value of the property

    • isListeningToStateMessages

      public boolean isListeningToStateMessages()
      Returns:
      whether this producer/consumer is always listening to state declaration messages.

    • setListeningToStateMessages

      public void setListeningToStateMessages(boolean listen)
      Changes how the sensor reacts to state declaration messages. With listen == true state declarations will update local state at all times. With listen == false state declarations will update local state only if local state is unknown.
      Parameters:
      listen - whether we should always listen to state declaration messages.

    • canInvert

      public boolean canInvert()
      Description copied from class: AbstractSensor
      By default, all implementations based on this can invert
      Specified by:
      canInvert in interface Sensor
      Overrides:
      canInvert in class AbstractSensor
      Returns:
      true if can be inverted; false otherwise

    • dispose

      public void dispose()
      Description copied from class: AbstractNamedBean
      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
      Specified by:
      dispose in interface Sensor
      Overrides:
      dispose in class AbstractSensor

    • compareSystemNameSuffix

      @CheckReturnValue public int compareSystemNameSuffix(@Nonnull String suffix1, @Nonnull String suffix2, @Nonnull NamedBean n)
      Compare the suffix of this NamedBean's name with the suffix of the argument NamedBean's name for the NamedBean.compareTo(jmri.NamedBean) operation. This is intended to be a system-specific comparison that understands the various formats, etc. By default, does an alphanumeric-by-chunks comparison. Sorts by decoded EventID(s)
      Specified by:
      compareSystemNameSuffix in interface NamedBean
      Overrides:
      compareSystemNameSuffix in class AbstractNamedBean
      Parameters:
      suffix1 - The suffix for the 1st bean in the comparison
      suffix2 - The suffix for the 2nd bean in the comparison
      n - The other (second) NamedBean in the comparison
      Returns:
      -1,0,+1 for ordering if the names are well-formed; may not provide proper ordering if the names are not well-formed.