Package org.opentcs.data.peripherals
Class PeripheralJob
- All Implemented Interfaces:
Serializable
Represents a job that is to be processed by a peripheral device.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
Defines the various states a peripheral job may be in. -
Field Summary
-
Constructor Summary
ConstructorsConstructorDescriptionPeripheralJob
(String name, String reservationToken, PeripheralOperation peripheralOperation) Creates a new instance. -
Method Summary
Modifier and TypeMethodDescriptionReturns the point of time at which this peripheral job was created.Returns the point of time at which processing of this peripheral job was finished.Returns the operation that is to be performed by the peripheral device.Returns the transport order for which this peripheral job was created.Returns the vehicle for which this peripheral job was created.Returns the token that may be used to reserve a peripheral device.getState()
Returns this peripheral job's current state.toString()
withCreationTime
(Instant creationTime) Creates a copy of this object, with the given creation time.withFinishedTime
(Instant finishedTime) Creates a copy of this object, with the given finished time.withHistory
(ObjectHistory history) Creates a copy of this object, with the given history.Creates a copy of this object, with the given history entry integrated.withPeripheralOperation
(PeripheralOperation peripheralOperation) Creates a copy of this object, with the given peripheral operation.withProperties
(Map<String, String> properties) Creates a copy of this object, with the given properties.withProperty
(String key, String value) Creates a copy of this object, with the given property integrated.withRelatedTransportOrder
(TCSObjectReference<TransportOrder> relatedTransportOrder) Creates a copy of this object, with the given related transport order.withRelatedVehicle
(TCSObjectReference<Vehicle> relatedVehicle) Creates a copy of this object, with the given related vehicle.withReservationToken
(String reservationToken) Creates a copy of this object, with the given reservation token.withState
(PeripheralJob.State state) Creates a copy of this object, with the given state.Methods inherited from class org.opentcs.data.TCSObject
equals, getHistory, getName, getProperties, getProperty, getReference, hashCode, listWithoutNullValues, mapWithoutNullValues, propertiesWith, setWithoutNullValues
-
Constructor Details
-
PeripheralJob
public PeripheralJob(@Nonnull String name, @Nonnull String reservationToken, @Nonnull PeripheralOperation peripheralOperation) Creates a new instance.- Parameters:
name
- The peripheral job's name.reservationToken
- The reservation token to be used.peripheralOperation
- The operation to be performed.
-
-
Method Details
-
withProperty
Description copied from class:TCSObject
Creates a copy of this object, with the given property integrated.- Specified by:
withProperty
in classTCSObject<PeripheralJob>
- Parameters:
key
- The key of the property to be changed.value
- The new value of the property, ornull
, if the property is to be removed.- Returns:
- A copy of this object, with the given property integrated.
-
withProperties
Description copied from class:TCSObject
Creates a copy of this object, with the given properties.- Specified by:
withProperties
in classTCSObject<PeripheralJob>
- Parameters:
properties
- The properties.- Returns:
- A copy of this object, with the given properties.
-
withHistoryEntry
Description copied from class:TCSObject
Creates a copy of this object, with the given history entry integrated.- Specified by:
withHistoryEntry
in classTCSObject<PeripheralJob>
- Parameters:
entry
- The history entry to be integrated.- Returns:
- A copy of this object, with the given history entry integrated.
-
withHistory
Description copied from class:TCSObject
Creates a copy of this object, with the given history.- Specified by:
withHistory
in classTCSObject<PeripheralJob>
- Parameters:
history
- The history.- Returns:
- A copy of this object, with the given history.
-
getReservationToken
Returns the token that may be used to reserve a peripheral device.- Returns:
- The token that may be used to reserve a peripheral device.
-
withReservationToken
Creates a copy of this object, with the given reservation token.- Parameters:
reservationToken
- The reservation token to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
getRelatedVehicle
Returns the vehicle for which this peripheral job was created.- Returns:
- The vehicle for which this peripheral job was created.
-
withRelatedVehicle
Creates a copy of this object, with the given related vehicle.- Parameters:
relatedVehicle
- The related vehicle to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
getRelatedTransportOrder
Returns the transport order for which this peripheral job was created.- Returns:
- The transport order for which this peripheral job was created.
-
withRelatedTransportOrder
public PeripheralJob withRelatedTransportOrder(TCSObjectReference<TransportOrder> relatedTransportOrder) Creates a copy of this object, with the given related transport order.- Parameters:
relatedTransportOrder
- The related transport order to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
getPeripheralOperation
Returns the operation that is to be performed by the peripheral device.- Returns:
- The operation that is to be performed by the peripheral device.
-
withPeripheralOperation
Creates a copy of this object, with the given peripheral operation.- Parameters:
peripheralOperation
- The peripheral operation to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
getState
Returns this peripheral job's current state.- Returns:
- this peripheral job's current state.
-
withState
Creates a copy of this object, with the given state.- Parameters:
state
- The state to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
getCreationTime
Returns the point of time at which this peripheral job was created.- Returns:
- The point of time at which this peripheral job was created.
-
withCreationTime
Creates a copy of this object, with the given creation time.- Parameters:
creationTime
- The creation time to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
getFinishedTime
Returns the point of time at which processing of this peripheral job was finished.- Returns:
- The point of time at which processing of this peripheral job was finished.
-
withFinishedTime
Creates a copy of this object, with the given finished time.- Parameters:
finishedTime
- The finished time to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
toString
- Overrides:
toString
in classTCSObject<PeripheralJob>
-