Package org.opentcs.access.to.model

Klasse VehicleCreationTO

java.lang.Object
org.opentcs.access.to.CreationTO
org.opentcs.access.to.model.VehicleCreationTO
Alle implementierten Schnittstellen:
Serializable
public class VehicleCreationTO extends CreationTO implements Serializable
A transfer object describing a block in the plant model.
Siehe auch:

  • Konstruktordetails

    • VehicleCreationTO

      public VehicleCreationTO(@Nonnull String name)
      Creates a new instance.
      Parameter:
      name - The name of this vehicle.

  • Methodendetails

    • withName

      public VehicleCreationTO 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 instance.
      Gibt zurück:
      A copy of this object, differing in the given name.

    • withProperties

      public VehicleCreationTO 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 properties.

    • withProperty

      public VehicleCreationTO 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 its current properties, if value != null or excludes the entry otherwise.

    • getBoundingBox

      public BoundingBoxCreationTO getBoundingBox()
      Returns the vehicle's current bounding box (in mm).
      Gibt zurück:
      The vehicle's current bounding box (in mm).

    • withBoundingBox

      public VehicleCreationTO withBoundingBox(BoundingBoxCreationTO boundingBox)
      Creates a copy of this object, with the given bounding box (in mm).
      Parameter:
      boundingBox - The new bounding box.
      Gibt zurück:
      A copy of this object, differing in the given vehicle bounding box.

    • getLength

      @Deprecated @ScheduledApiChange(when="7.0", details="Will be removed.") public int getLength()
      Veraltet.
      Use getBoundingBox() instead.
      Returns the vehicle's length (in mm).
      Gibt zurück:
      The vehicle's length (in mm).

    • withLength

      @Deprecated @ScheduledApiChange(when="7.0", details="Will be removed.") public VehicleCreationTO withLength(int length)
      Veraltet.
      Use withBoundingBox(BoundingBoxCreationTO) instead.
      Creates a copy of this object with the vehicle's given length (in mm).
      Parameter:
      length - The new length. Must be at least 1.
      Gibt zurück:
      A copy of this object, differing in the given vehicle length.

    • getEnergyLevelCritical

      @Deprecated @ScheduledApiChange(when="7.0", details="Will be removed.") public int getEnergyLevelCritical()
      Veraltet.
      Use getEnergyLevelThresholdSet() instead.
      Returns this vehicle's critical energy level (in percent of the maximum). The critical energy level is the one at/below which the vehicle should be recharged.
      Gibt zurück:
      This vehicle's critical energy level.

    • withEnergyLevelCritical

      @Deprecated @ScheduledApiChange(when="7.0", details="Will be removed.") public VehicleCreationTO withEnergyLevelCritical(int energyLevelCritical)
      Veraltet.
      Use withEnergyLevelThresholdSet(EnergyLevelThresholdSet) instead.
      Creates a copy of this object with the given critical energy level. The critical energy level is the one at/below which the vehicle should be recharged.
      Parameter:
      energyLevelCritical - The new critical energy level. Must not be smaller than 0 or greater than 100.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • getEnergyLevelGood

      @Deprecated @ScheduledApiChange(when="7.0", details="Will be removed.") public int getEnergyLevelGood()
      Veraltet.
      Use getEnergyLevelThresholdSet() instead.
      Returns this vehicle's good energy level (in percent of the maximum). The good energy level is the one at/above which the vehicle can be dispatched again when charging.
      Gibt zurück:
      This vehicle's good energy level.

    • withEnergyLevelGood

      @Deprecated @ScheduledApiChange(when="7.0", details="Will be removed.") public VehicleCreationTO withEnergyLevelGood(int energyLevelGood)
      Veraltet.
      Use withEnergyLevelThresholdSet(EnergyLevelThresholdSet) instead.
      Creates a copy of this object with the vehicle's good energy level (in percent of the maximum). The good energy level is the one at/above which the vehicle can be dispatched again when charging.
      Parameter:
      energyLevelGood - The new good energy level. Must not be smaller than 0 or greater than 100.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • getEnergyLevelFullyRecharged

      @Deprecated @ScheduledApiChange(when="7.0", details="Will be removed.") public int getEnergyLevelFullyRecharged()
      Veraltet.
      Use getEnergyLevelThresholdSet() instead.
      Returns this vehicle's fully recharged energy level (in percent of the maximum).
      Gibt zurück:
      This vehicle's fully recharged energy level.

    • withEnergyLevelFullyRecharged

      @Deprecated @ScheduledApiChange(when="7.0", details="Will be removed.") public VehicleCreationTO withEnergyLevelFullyRecharged(int energyLevelFullyRecharged)
      Veraltet.
      Use withEnergyLevelThresholdSet(EnergyLevelThresholdSet) instead.
      Creates a copy of this object with the vehicle's fully recharged energy level (in percent of the maximum).
      Parameter:
      energyLevelFullyRecharged - The new fully recharged energy level. Must not be smaller than 0 or greater than 100.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • getEnergyLevelSufficientlyRecharged

      @Deprecated @ScheduledApiChange(when="7.0", details="Will be removed.") public int getEnergyLevelSufficientlyRecharged()
      Veraltet.
      Use getEnergyLevelThresholdSet() instead.
      Returns this vehicle's sufficiently recharged energy level (in percent of the maximum).
      Gibt zurück:
      This vehicle's sufficiently recharged energy level.

    • withEnergyLevelSufficientlyRecharged

      @Deprecated @ScheduledApiChange(when="7.0", details="Will be removed.") public VehicleCreationTO withEnergyLevelSufficientlyRecharged(int energyLevelSufficientlyRecharged)
      Veraltet.
      Use withEnergyLevelThresholdSet(EnergyLevelThresholdSet) instead.
      Creates a copy of this object with the vehicle's sufficiently recharged energy level (in percent of the maximum).
      Parameter:
      energyLevelSufficientlyRecharged - The new sufficiently recharged energy level. Must not be smaller than 0 or greater than 100.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • getEnergyLevelThresholdSet

      @Nonnull public VehicleCreationTO.EnergyLevelThresholdSet getEnergyLevelThresholdSet()
      Returns this vehicle's energy level threshold set.
      Gibt zurück:
      This vehicle's energy level threshold set.

    • withEnergyLevelThresholdSet

      public VehicleCreationTO withEnergyLevelThresholdSet(@Nonnull VehicleCreationTO.EnergyLevelThresholdSet energyLevelThresholdSet)
      Creates a copy of this object, with the given EnergyLevelThresholdSet.
      Parameter:
      energyLevelThresholdSet - The new EnergyLevelThresholdSet.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • getMaxVelocity

      public int getMaxVelocity()

    • withMaxVelocity

      public VehicleCreationTO withMaxVelocity(int maxVelocity)
      Creates a copy of this object with the given maximum velocity (in mm/s).
      Parameter:
      maxVelocity - the new max velocity.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • getMaxReverseVelocity

      public int getMaxReverseVelocity()

    • withMaxReverseVelocity

      public VehicleCreationTO withMaxReverseVelocity(int maxReverseVelocity)
      Creates a copy of this object with the given maximum reverse velocity (in mm/s).
      Parameter:
      maxReverseVelocity - the new maximum reverse velocity.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • getEnvelopeKey

      @ScheduledApiChange(when="7.0", details="Envelope key will become non-null.") @Nullable public String getEnvelopeKey()
      Returns the key for selecting the envelope to be used for resources the vehicle occupies.
      Gibt zurück:
      The key for selecting the envelope to be used for resources the vehicle occupies.

    • withEnvelopeKey

      @ScheduledApiChange(when="7.0", details="Envelope key will become non-null.") public VehicleCreationTO withEnvelopeKey(@Nullable String envelopeKey)
      Creates a copy of this object, with the given envelope key.
      Parameter:
      envelopeKey - The value to be set in the copy.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • getLayout

      public VehicleCreationTO.Layout getLayout()
      Returns the information regarding the graphical representation of this vehicle.
      Gibt zurück:
      The information regarding the graphical representation of this vehicle.

    • withLayout

      public VehicleCreationTO withLayout(VehicleCreationTO.Layout layout)
      Creates a copy of this object, with the given layout.
      Parameter:
      layout - The value to be set in the copy.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • toString

      public String toString()
      Setzt außer Kraft:
      toString in Klasse Object