Package org.opentcs.data.model
Class PeripheralInformation
java.lang.Object
org.opentcs.data.model.PeripheralInformation
- All Implemented Interfaces:
Serializable
Contains details about a peripheral device a location may represent.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
A peripheral device's processing state as seen by the peripheral job dispatcher.static enum
The elements of this enumeration describe the various possible states of a peripheral device. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns a reference to the peripheral job this peripheral device is currently processing.Returns the peripheral device's current processing state.Returns a token for which a location/peripheral device is currently reserved.getState()
Returns the peripheral device's current state.withPeripheralJob
(TCSObjectReference<PeripheralJob> peripheralJob) Creates a copy of this object, with the given peripheral job.withProcState
(PeripheralInformation.ProcState procState) Creates a copy of this object, with the given processing state.withReservationToken
(String reservationToken) Creates a copy of this object, with the given reservation token.Creates a copy of this object, with the given state.
-
Constructor Details
-
PeripheralInformation
public PeripheralInformation()Creates a new instance.
-
-
Method Details
-
getReservationToken
Returns a token for which a location/peripheral device is currently reserved.- Returns:
- A token for which a location/peripheral device is currently reserved.
-
withReservationToken
Creates a copy of this object, with the given reservation token.- Parameters:
reservationToken
- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
getState
Returns the peripheral device's current state.- Returns:
- The peripheral device's current state.
-
withState
Creates a copy of this object, with the given state.- Parameters:
state
- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
getProcState
Returns the peripheral device's current processing state.- Returns:
- The peripheral device's current processing state.
-
withProcState
Creates a copy of this object, with the given processing state.- Parameters:
procState
- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
getPeripheralJob
Returns a reference to the peripheral job this peripheral device is currently processing.- Returns:
- A reference to the peripheral job this peripheral device is currently processing,
or
null
, it is not processing any peripheral job at the moment.
-
withPeripheralJob
public PeripheralInformation withPeripheralJob(@Nullable TCSObjectReference<PeripheralJob> peripheralJob) Creates a copy of this object, with the given peripheral job.- Parameters:
peripheralJob
- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-