Package org.opentcs.access.to.model

Klasse PointCreationTO

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

  • Konstruktordetails

    • PointCreationTO

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

  • Methodendetails

    • withName

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

    • getPose

      @Nonnull public Pose getPose()
      Returns the pose of the vehicle at this point.
      Gibt zurück:
      The pose of the vehicle at this point.

    • withPose

      public PointCreationTO withPose(@Nonnull Pose pose)
      Creates a copy of this object with the given pose.
      Parameter:
      pose - The new pose.
      Gibt zurück:
      A copy of this object, differing in the given position.

    • getType

      @Nonnull public Point.Type getType()
      Returns the type of this point.
      Gibt zurück:
      The type of this point.

    • withType

      public PointCreationTO withType(@Nonnull Point.Type type)
      Creates a copy of this object with the given type.
      Parameter:
      type - The new type.
      Gibt zurück:
      A copy of this object, differing in the given type.

    • withProperties

      public PointCreationTO 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 PointCreationTO 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.

    • getVehicleEnvelopes

      public Map<String,Envelope> getVehicleEnvelopes()
      Returns a map of envelope keys to envelopes that vehicles located at this point may occupy.
      Gibt zurück:
      A map of envelope keys to envelopes that vehicles located at this point may occupy.

    • withVehicleEnvelopes

      public PointCreationTO withVehicleEnvelopes(@Nonnull Map<String,Envelope> vehicleEnvelopes)
      Creates a copy of this object, with the given vehicle envelopes.
      Parameter:
      vehicleEnvelopes - The value to be set in the copy.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • getMaxVehicleBoundingBox

      public BoundingBoxCreationTO getMaxVehicleBoundingBox()
      Returns the maximum bounding box (in mm) that a vehicle at this point is allowed to have.
      Gibt zurück:
      The maximum bounding box (in mm) that a vehicle at this point is allowed to have.

    • withMaxVehicleBoundingBox

      public PointCreationTO withMaxVehicleBoundingBox(BoundingBoxCreationTO maxVehicleBoundingBox)
      Creates a copy of this object, with the given maximum vehicle bounding box.
      Parameter:
      maxVehicleBoundingBox - The value to be set in the copy.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • getLayout

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

    • withLayout

      public PointCreationTO withLayout(PointCreationTO.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