Package org.opentcs.access.to.peripherals

Klasse PeripheralOperationCreationTO

java.lang.Object
org.opentcs.access.to.CreationTO
org.opentcs.access.to.peripherals.PeripheralOperationCreationTO
Alle implementierten Schnittstellen:
Serializable
public class PeripheralOperationCreationTO extends CreationTO implements Serializable
A transfer object describing an operation to be performed by a peripheral device.
Siehe auch:

  • Konstruktordetails

    • PeripheralOperationCreationTO

      public PeripheralOperationCreationTO(@Nonnull String operation, @Nonnull String locationName)
      Creates a new instance with executionTrigger set to PeripheralOperation.ExecutionTrigger.IMMEDIATE and completionRequired set to false.
      Parameter:
      operation - The operation to be performed by the peripheral device.
      locationName - The name of the location the peripheral device is associated with.

  • Methodendetails

    • withName

      public PeripheralOperationCreationTO withName(@Nonnull String name)
      Beschreibung aus Klasse kopiert: CreationTO
      Creates a copy of this object with the given name.
      Setzt außer Kraft:
      withName in Klasse CreationTO
      Parameter:
      name - the new name
      Gibt zurück:
      A copy of this object, differing in the given value.

    • withProperties

      public PeripheralOperationCreationTO withProperties(@Nonnull Map<String,String> properties)
      Beschreibung aus Klasse kopiert: CreationTO
      Creates a copy of this object with the given properties.
      Setzt außer Kraft:
      withProperties in Klasse CreationTO
      Parameter:
      properties - The properties.
      Gibt zurück:
      A copy of this object with the given properties.

    • withProperty

      public PeripheralOperationCreationTO withProperty(@Nonnull String key, @Nonnull String value)
      Beschreibung aus Klasse kopiert: CreationTO
      Creates a copy of this object with the given property. If value == null is true then the key-value pair is removed from the properties.
      Setzt außer Kraft:
      withProperty in Klasse CreationTO
      Parameter:
      key - the key.
      value - the value
      Gibt zurück:
      A copy of this object that includes the given property or removes the entry, if value == null.

    • getOperation

      @Nonnull public String getOperation()
      Returns the operation to be performed by the peripheral device.
      Gibt zurück:
      The operation to be performed by the peripheral device.

    • withOperation

      public PeripheralOperationCreationTO withOperation(@Nonnull String operation)
      Creates a copy of this object, with the given operation.
      Parameter:
      operation - The value to be set in the copy.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • getLocationName

      @Nonnull public String getLocationName()
      Returns the name of the location the peripheral device is associated with.
      Gibt zurück:
      The name of the location the peripheral device is associated with.

    • withLocationName

      public PeripheralOperationCreationTO withLocationName(@Nonnull String locationName)
      Creates a copy of this object, with the given location name.
      Parameter:
      locationName - The value to be set in the copy.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • getExecutionTrigger

      @Nonnull public PeripheralOperation.ExecutionTrigger getExecutionTrigger()
      Returns the moment at which this operation is to be performed.
      Gibt zurück:
      The moment at which this operation is to be performed.

    • withExecutionTrigger

      public PeripheralOperationCreationTO withExecutionTrigger(@Nonnull PeripheralOperation.ExecutionTrigger executionTrigger)
      Creates a copy of this object, with the given execution trigger.

      This method should only be used by the vehicle controller component of the baseline project.

      Parameter:
      executionTrigger - The value to be set in the copy.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • isCompletionRequired

      public boolean isCompletionRequired()
      Returns whether the completion of this operation is required to allow a vehicle to continue driving.
      Gibt zurück:
      Whether the completion of this operation is required to allow a vehicle to continue driving.

    • withCompletionRequired

      public PeripheralOperationCreationTO withCompletionRequired(boolean completionRequired)
      Creates a copy of this object, with the given completion required flag.

      This method should only be used by the vehicle controller component of the baseline project.

      Parameter:
      completionRequired - The value to be set in the copy.
      Gibt zurück:
      A copy of this object, differing in the given value.