Package org.opentcs.access.to.order

Klasse TransportOrderCreationTO

java.lang.Object
org.opentcs.access.to.CreationTO
org.opentcs.access.to.order.TransportOrderCreationTO
Alle implementierten Schnittstellen:
Serializable
public class TransportOrderCreationTO extends CreationTO implements Serializable
A transfer object describing a transport order.
Siehe auch:

  • Konstruktordetails

    • TransportOrderCreationTO

      public TransportOrderCreationTO(@Nonnull String name, @Nonnull List<DestinationCreationTO> destinations)
      Creates a new instance.
      Parameter:
      name - The name of this transport order.
      destinations - The destinations that need to be travelled to.

  • Methodendetails

    • withName

      public TransportOrderCreationTO withName(@Nonnull String name)
      Creates a copy of this object with the given name.
      Setzt außer Kraft:
      withName in Klasse CreationTO
      Parameter:
      name - The new name of the instance.
      Gibt zurück:
      A copy of this object, differing in the given name.

    • withProperties

      public TransportOrderCreationTO withProperties(@Nonnull Map<String,String> properties)
      Creates a copy of this object with the given properties.
      Setzt außer Kraft:
      withProperties in Klasse CreationTO
      Parameter:
      properties - The new properties.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • withProperty

      public TransportOrderCreationTO withProperty(@Nonnull String key, @Nonnull String value)
      Creates a copy of this object and adds the given property. If value == null, then the key-value pair is removed from the properties.
      Setzt außer Kraft:
      withProperty in Klasse CreationTO
      Parameter:
      key - the key.
      value - the value
      Gibt zurück:
      A copy of this object that either includes the given entry in it's current properties, if value != null or excludes the entry otherwise.

    • hasIncompleteName

      public boolean hasIncompleteName()
      Indicates whether the name is incomplete and requires to be completed when creating the actual transport order. (How exactly this is done is decided by the kernel.)
      Gibt zurück:
      true if, and only if, the name is incomplete and requires to be completed by the kernel.

    • withIncompleteName

      public TransportOrderCreationTO withIncompleteName(boolean incompleteName)
      Creates a copy of this object with the given nameIncomplete flag.
      Parameter:
      incompleteName - Whether the name is incomplete and requires to be completed when creating the actual transport order.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • getDestinations

      @Nonnull public List<DestinationCreationTO> getDestinations()
      Returns the destinations that need to be travelled to.
      Gibt zurück:
      The destinations that need to be travelled to.

    • withDestinations

      public TransportOrderCreationTO withDestinations(@Nonnull List<DestinationCreationTO> destinations)
      Creates a copy of this object with the given destinations that need to be travelled to.
      Parameter:
      destinations - The destinations.
      Gibt zurück:
      A copy of this object, differing in the given derstinations.

    • getPeripheralReservationToken

      @Nullable public String getPeripheralReservationToken()
      Returns an optional token for reserving peripheral devices while processing this transport order.
      Gibt zurück:
      An optional token for reserving peripheral devices while processing this transport order.

    • withPeripheralReservationToken

      public TransportOrderCreationTO withPeripheralReservationToken(@Nullable String peripheralReservationToken)
      Creates a copy of this object with the given (optional) peripheral reservation token.
      Parameter:
      peripheralReservationToken - The token.
      Gibt zurück:
      A copy of this object, differing in the given peripheral reservation token.

    • getWrappingSequence

      @Nullable public String getWrappingSequence()
      Returns the (optional) name of the order sequence the transport order belongs to.
      Gibt zurück:
      The (optional) name of the order sequence the transport order belongs to.

    • withWrappingSequence

      public TransportOrderCreationTO withWrappingSequence(@Nullable String wrappingSequence)
      Creates a copy of this object with the given (optional) name of the order sequence the transport order belongs to.
      Parameter:
      wrappingSequence - The name of the sequence.
      Gibt zurück:
      A copy of this object, differing in the given name of the sequence.

    • getDependencyNames

      @Nonnull public Set<String> getDependencyNames()
      Returns the (optional) names of transport orders the transport order depends on.
      Gibt zurück:
      The (optional) names of transport orders the transport order depends on.

    • withDependencyNames

      public TransportOrderCreationTO withDependencyNames(@Nonnull Set<String> dependencyNames)
      Creates a copy of this object with the given (optional) names of transport orders the transport order depends on.
      Parameter:
      dependencyNames - The dependency names.
      Gibt zurück:
      A copy of this object, differing in the given dependency names.

    • getIntendedVehicleName

      @Nullable public String getIntendedVehicleName()
      Returns the (optional) name of the vehicle that is supposed to execute the transport order.
      Gibt zurück:
      The (optional) name of the vehicle that is supposed to execute the transport order.

    • withIntendedVehicleName

      public TransportOrderCreationTO withIntendedVehicleName(@Nullable String intendedVehicleName)
      Creates a copy of this object with the given (optional) name of the vehicle that is supposed to execute the transport order.
      Parameter:
      intendedVehicleName - The vehicle name.
      Gibt zurück:
      A copy of this object, differing in the given vehicle's name.

    • getType

      @Nonnull public String getType()
      Returns the (optional) type of the transport order.
      Gibt zurück:
      The (optional) type of the transport order.

    • withType

      public TransportOrderCreationTO withType(@Nonnull String type)
      Creates a copy of this object with the given (optional) type of the transport order.
      Parameter:
      type - The type.
      Gibt zurück:
      A copy of this object, differing in the given type.

    • getDeadline

      @Nonnull public Instant getDeadline()
      Returns the point of time at which execution of the transport order is supposed to be finished.
      Gibt zurück:
      The point of time at which execution of the transport order is supposed to be finished.

    • withDeadline

      public TransportOrderCreationTO withDeadline(@Nonnull Instant deadline)
      Creates a copy of this object with the given point of time at which execution of the transport order is supposed to be finished.
      Parameter:
      deadline - The deadline.
      Gibt zurück:
      A copy of this object, differing in the given deadline.

    • isDispensable

      public boolean isDispensable()
      Returns whether the transport order is dispensable or not.
      Gibt zurück:
      Whether the transport order is dispensable or not.

    • withDispensable

      public TransportOrderCreationTO withDispensable(boolean dispensable)
      Creates a copy of this object with the given indication whether the transport order is dispensable or not.
      Parameter:
      dispensable - The dispensable flag.
      Gibt zurück:
      A copy of this object, differing in the given dispensable flag.