Class Z21CanSensor

All Implemented Interfaces:
Comparable<NamedBean>, EventListener, PropertyChangeProvider, DigitalIO, AbstractMRListener, Z21Listener, NamedBean, Sensor

public class Z21CanSensor
extends AbstractSensor
implements Z21Listener
Z21CanSensor implements the Sensor interface for Can connected sensors on Roco Z21 systems.
  • Constructor Details

    • Z21CanSensor

      public Z21CanSensor​(String systemName, String userName, Z21SystemConnectionMemo memo)
      Create a new Z21CanSensor.
      Parameters:
      systemName - the system name of the new reporter.
      userName - the user name of the new reporter.
      memo - an instance of Z21SystemConnectionMemo this reporter is associated with.
  • Method Details

    • requestUpdateFromLayout

      public void requestUpdateFromLayout()
      request an update from the layout.
      Specified by:
      requestUpdateFromLayout in interface DigitalIO
    • reply

      public void reply​(Z21Reply msg)
      Member function that will be invoked by a z21Interface implementation to forward a z21 message from the layout.
      Specified by:
      reply in interface Z21Listener
      Parameters:
      msg - The received z21 reply. Note that this same object may be presented to multiple users. It should not be modified here.
    • message

      public void message​(Z21Message msg)
      Member function that will be invoked by a z21Interface implementation to forward a z21 message sent to the layout. Normally, this function will do nothing.
      Specified by:
      message in interface Z21Listener
      Parameters:
      msg - The received z21 message. Note that this same object may be presented to multiple users. It should not be modified here.
    • dispose

      public void dispose()
      Description copied from interface: NamedBean
      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 AbstractNamedBean