Package org.opentcs.access.to.model

Class PointCreationTO

java.lang.Object
org.opentcs.access.to.CreationTO
org.opentcs.access.to.model.PointCreationTO
All Implemented Interfaces:
java.io.Serializable
public class PointCreationTO
extends CreationTO
implements java.io.Serializable
A transfer object describing a point in the plant model.
See Also:
Serialized Form

  • Constructor Details

    • PointCreationTO

      public PointCreationTO​(@Nonnull java.lang.String name)
      Creates a new instance.
      Parameters:
      name - The name of this point.

  • Method Details

    • withName

      public PointCreationTO withName​(@Nonnull java.lang.String name)
      Creates a copy of this object with the given name.
      Overrides:
      withName in class CreationTO
      Parameters:
      name - The new name.
      Returns:
      A copy of this object, differing in the given name.

    • getPose

      @Nonnull public Pose getPose()
      Returns the pose of the vehicle at this point.
      Returns:
      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.
      Parameters:
      pose - The new pose.
      Returns:
      A copy of this object, differing in the given position.

    • getPosition

      @Deprecated @ScheduledApiChange(when="6.0", details="Will be removed.") @Nonnull public Triple getPosition()
      Deprecated.
      Use getPose() instead.
      Returns the position of this point (in mm).
      Returns:
      The position of this point (in mm).

    • withPosition

      @Deprecated @ScheduledApiChange(when="6.0", details="Will be removed.") public PointCreationTO withPosition​(@Nonnull Triple position)
      Deprecated.
      Use withPose(org.opentcs.data.model.Pose) instead.
      Creates a copy of this object with the given position (in mm).
      Parameters:
      position - The new position.
      Returns:
      A copy of this object, differing in the given position.

    • getVehicleOrientationAngle

      @Deprecated @ScheduledApiChange(when="6.0", details="Will be removed.") public double getVehicleOrientationAngle()
      Deprecated.
      Use getPose() instead.
      Returns a vehicle's orientation angle at this position. (-360..360, or Double.NaN, if an orientation angle is not specified for this point.)
      Returns:
      The vehicle's orientation angle when it's at this position.

    • withVehicleOrientationAngle

      @Deprecated @ScheduledApiChange(when="6.0", details="Will be removed.") public PointCreationTO withVehicleOrientationAngle​(double vehicleOrientationAngle)
      Deprecated.
      Use withPose(org.opentcs.data.model.Pose) instead.
      Creates a copy of this object with the vehicle's (assumed) orientation angle when it's at this position. Allowed value range: [-360..360], or Double.NaN to indicate that there is no specific orientation angle for this point.
      Parameters:
      vehicleOrientationAngle - The new angle.
      Returns:
      A copy of this object, differing in the given angle.

    • getType

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

    • withType

      public PointCreationTO withType​(@Nonnull Point.Type type)
      Creates a copy of this object with the given type.
      Parameters:
      type - The new type.
      Returns:
      A copy of this object, differing in the given type.

    • withProperties

      public PointCreationTO withProperties​(@Nonnull java.util.Map<java.lang.String,​java.lang.String> properties)
      Creates a copy of this object with the given properties.
      Overrides:
      withProperties in class CreationTO
      Parameters:
      properties - The new properties.
      Returns:
      A copy of this object, differing in the given properties.

    • withProperty

      public PointCreationTO withProperty​(@Nonnull java.lang.String key, @Nonnull java.lang.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.
      Overrides:
      withProperty in class CreationTO
      Parameters:
      key - the key.
      value - the value
      Returns:
      A copy of this object that either includes the given entry in it's current properties, if value != null or excludes the entry otherwise.

    • getVehicleEnvelopes

      public java.util.Map<java.lang.String,​Envelope> getVehicleEnvelopes()
      Returns a map of envelope keys to envelopes that vehicles located at this point may occupy.
      Returns:
      A map of envelope keys to envelopes that vehicles located at this point may occupy.

    • withVehicleEnvelopes

      public PointCreationTO withVehicleEnvelopes​(@Nonnull java.util.Map<java.lang.String,​Envelope> vehicleEnvelopes)
      Creates a copy of this object, with the given vehicle envelopes.
      Parameters:
      vehicleEnvelopes - The value to be set in the copy.
      Returns:
      A copy of this object, differing in the given value.

    • getLayout

      public PointCreationTO.Layout getLayout()
      Returns the information regarding the grahical representation of this point.
      Returns:
      The information regarding the grahical representation of this point.

    • withLayout

      public PointCreationTO withLayout​(PointCreationTO.Layout layout)
      Creates a copy of this object, with the given layout.
      Parameters:
      layout - The value to be set in the copy.
      Returns:
      A copy of this object, differing in the given value.

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object