Package org.opentcs.drivers.peripherals

Klasse PeripheralProcessModel

java.lang.Object
org.opentcs.drivers.peripherals.PeripheralProcessModel
Alle implementierten Schnittstellen:
Serializable
public class PeripheralProcessModel extends Object implements Serializable
A model of a peripheral device's and its communication adapter's attributes.
Siehe auch:

  • Konstruktordetails

    • PeripheralProcessModel

      public PeripheralProcessModel(TCSResourceReference<Location> location)
      Creates a new instance.
      Parameter:
      location - The reference to the location that is attached to this model.

    • PeripheralProcessModel

      protected PeripheralProcessModel(@Nonnull TCSResourceReference<Location> location, boolean commAdapterEnabled, boolean commAdapterConnected, @Nonnull PeripheralInformation.State state)

  • Methodendetails

    • getLocation

      @Nonnull public TCSResourceReference<Location> getLocation()
      Returns the reference to the location that is attached to this model.
      Gibt zurück:
      The reference to the location that is attached to this model.

    • withLocation

      public PeripheralProcessModel withLocation(@Nonnull TCSResourceReference<Location> location)
      Creates a copy of the object, with the given location reference.
      Parameter:
      location - The value to be set in the copy.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • isCommAdapterEnabled

      public boolean isCommAdapterEnabled()
      Returns whether the communication adapter is currently enabled.
      Gibt zurück:
      Whether the communication adapter is currently enabled.

    • withCommAdapterEnabled

      public PeripheralProcessModel withCommAdapterEnabled(boolean commAdapterEnabled)
      Creates a copy of the object, with the given enabled state.
      Parameter:
      commAdapterEnabled - The value to be set in the copy.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • isCommAdapterConnected

      public boolean isCommAdapterConnected()
      Returns whether the communication adapter is currently connected to the peripheral device.
      Gibt zurück:
      Whether the communication adapter is currently connected to the peripheral device.

    • withCommAdapterConnected

      public PeripheralProcessModel withCommAdapterConnected(boolean commAdapterConnected)
      Creates a copy of the object, with the given connected state.
      Parameter:
      commAdapterConnected - The value to be set in the copy.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • getState

      public PeripheralInformation.State getState()
      Returns the peripheral device's current state.
      Gibt zurück:
      The peripheral device's current state.

    • withState

      public PeripheralProcessModel withState(PeripheralInformation.State state)
      Creates a copy of the object, with the given state.
      Parameter:
      state - The value to be set in the copy.
      Gibt zurück:
      A copy of this object, differing in the given value.