Package org.opentcs.data.model
Class PeripheralInformation
java.lang.Object
org.opentcs.data.model.PeripheralInformation
- All Implemented Interfaces:
java.io.Serializable
public class PeripheralInformation
extends java.lang.Object
implements java.io.Serializable
Contains details about a peripheral device a location may represent.
- See Also:
- Serialized Form
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classPeripheralInformation.ProcStateA peripheral device's processing state as seen by the peripheral job dispatcher.static classPeripheralInformation.StateThe elements of this enumeration describe the various possible states of a peripheral device. -
Constructor Summary
Constructors Constructor Description PeripheralInformation() -
Method Summary
Modifier and Type Method Description TCSObjectReference<PeripheralJob>getPeripheralJob()Returns a reference to the peripheral job this peripheral device is currently processing.PeripheralInformation.ProcStategetProcState()Returns the peripheral device's current processing state.java.lang.StringgetReservationToken()Returns a token for which a location/peripheral device is currently reserved.PeripheralInformation.StategetState()Returns the peripheral device's current state.PeripheralInformationwithPeripheralJob(TCSObjectReference<PeripheralJob> peripheralJob)Creates a copy of this object, with the given peripheral job.PeripheralInformationwithProcState(PeripheralInformation.ProcState procState)Creates a copy of this object, with the given processing state.PeripheralInformationwithReservationToken(java.lang.String reservationToken)Creates a copy of this object, with the given reservation token.PeripheralInformationwithState(PeripheralInformation.State state)Creates a copy of this object, with the given state.
-
Constructor Details
-
PeripheralInformation
public PeripheralInformation()
-
-
Method Details
-
getReservationToken
@Nullable public java.lang.String 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.
-