Package org.opentcs.data.peripherals
Class PeripheralOperation
java.lang.Object
org.opentcs.data.peripherals.PeripheralOperation
- All Implemented Interfaces:
Serializable
Describes an operation that is to be executed by a peripheral device.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
Defines the various moments at which an operation may be executed. -
Constructor Summary
ConstructorsConstructorDescriptionPeripheralOperation
(TCSResourceReference<Location> location, String operation, PeripheralOperation.ExecutionTrigger executionTrigger, boolean completionRequired) Creates a new instance. -
Method Summary
Modifier and TypeMethodDescriptionReturns the moment at which this operation is to be executed.Returns the location the peripheral device is associated with.Returns the actual operation to be executed by the peripheral device.boolean
Returns whether the completion of this operation is required to allow a vehicle to continue driving.toString()
-
Constructor Details
-
PeripheralOperation
public PeripheralOperation(@Nonnull TCSResourceReference<Location> location, @Nonnull String operation, @Nonnull PeripheralOperation.ExecutionTrigger executionTrigger, boolean completionRequired) Creates a new instance.- Parameters:
location
- The location the peripheral device is associated with.operation
- The actual operation to be executed by the peripheral device.executionTrigger
- The moment at which this operation is to be executed.completionRequired
- Whether the completion of this operation is required to allow a vehicle to continue driving.
-
-
Method Details
-
getLocation
Returns the location the peripheral device is associated with.- Returns:
- The location the peripheral device is associated with.
-
getOperation
Returns the actual operation to be executed by the peripheral device.- Returns:
- The actual operation to be executed by the peripheral device.
-
getExecutionTrigger
Returns the moment at which this operation is to be executed.- Returns:
- The moment at which this operation is to be executed.
-
isCompletionRequired
public boolean isCompletionRequired()Returns whether the completion of this operation is required to allow a vehicle to continue driving.- Returns:
- Whether the completion of this operation is required to allow a vehicle to continue driving.
-
toString
-