Class AttachmentInformation

java.lang.Object
org.opentcs.drivers.vehicle.management.AttachmentInformation
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
VehicleAttachmentInformation

@Deprecated
@ScheduledApiChange(details="Will be removed.",
                    when="6.0")
public class AttachmentInformation
extends java.lang.Object
implements java.io.Serializable
Deprecated.
Describes which communication adapter a vehicle is currently associated with and which adapters are available.
See Also:
Serialized Form
  • Constructor Details

    • AttachmentInformation

      public AttachmentInformation​(@Nonnull TCSObjectReference<Vehicle> vehicleReference, @Nonnull java.util.List<VehicleCommAdapterDescription> availableCommAdapters, @Nonnull VehicleCommAdapterDescription attachedCommAdapter)
      Deprecated.
      Creates a new instance.
      Parameters:
      vehicleReference - The vehicle this attachment information belongs to.
      availableCommAdapters - The list of comm adapters available to be attached to the referenced vehicle.
      attachedCommAdapter - The comm adapter attached to the referenced vehicle.
  • Method Details

    • getVehicleReference

      @Nonnull public TCSObjectReference<Vehicle> getVehicleReference()
      Deprecated.
      Returns the vehicle this attachment information belongs to.
      Returns:
      The vehicle this attachment information belongs to.
    • withVehicleReference

      public AttachmentInformation withVehicleReference​(TCSObjectReference<Vehicle> vehicleReference)
      Deprecated.
      Creates a copy of this object with the given vehicle reference.
      Parameters:
      vehicleReference - The new vehicle reference.
      Returns:
      A copy of this object, differing in the given vehicle reference.
    • getAvailableCommAdapters

      @Nonnull public java.util.List<VehicleCommAdapterDescription> getAvailableCommAdapters()
      Deprecated.
      Returns the list of comm adapters available to be attached to the referenced vehicle.
      Returns:
      The list of comm adapters available to be attached to the referenced vehicle.
    • withAvailableCommAdapters

      public AttachmentInformation withAvailableCommAdapters​(@Nonnull java.util.List<VehicleCommAdapterDescription> availableCommAdapters)
      Deprecated.
      Creates a copy of this object with the given available comm adapters.
      Parameters:
      availableCommAdapters - The new available comm adapters.
      Returns:
      A copy of this object, differing in the given available comm adapters.
    • getAttachedCommAdapter

      @Nonnull public VehicleCommAdapterDescription getAttachedCommAdapter()
      Deprecated.
      Returns the comm adapter attached to the referenced vehicle.
      Returns:
      The comm adapter attached to the referenced vehicle.
    • withAttachedCommAdapter

      public AttachmentInformation withAttachedCommAdapter​(@Nonnull VehicleCommAdapterDescription attachedCommAdapter)
      Deprecated.
      Creates a copy of this object with the given attached comm adapter.
      Parameters:
      attachedCommAdapter - The new attached comm adapter.
      Returns:
      A copy of this object, differing in the given attached comm adapter.