Package org.opentcs.access.to.model

Class PathCreationTO

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

  • Constructor Summary

    Constructors 
    Constructor Description
    PathCreationTO​(java.lang.String name, java.lang.String srcPointName, java.lang.String destPointName)
    Creates a new instance.

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getDestPointName()
    Returns the point name this path ends in.
    long getLength()
    Returns the length of this path (in mm).
    int getMaxReverseVelocity()
    Returns the maximum allowed reverse velocity (in mm/s) for this path.
    int getMaxVelocity()
    Returns the maximum allowed forward velocity (in mm/s) for this path.
    java.lang.String getSrcPointName()
    Returns the point name this path originates in.
    boolean isLocked()
    Returns the lock status of this path (i.e. whether this path my be used by vehicles or not).
    PathCreationTO withDestPointName​(java.lang.String destPointName)
    Creates a copy of this object with the given destination point.
    PathCreationTO withLength​(long length)
    Creates a copy of this object with the given path length (in mm).
    PathCreationTO withLocked​(boolean locked)
    Creates a copy of this object that is locked if locked==true and unlocked otherwise.
    PathCreationTO withMaxReverseVelocity​(int maxReverseVelocity)
    Creates a copy of this object with the allowed maximum reverse velocity (in mm/s).
    PathCreationTO withMaxVelocity​(int maxVelocity)
    Creates a copy of this object with the maximum allowed forward velocity (in mm/s) for this path.
    PathCreationTO withName​(java.lang.String name)
    Creates a copy of this object with the given name.
    PathCreationTO withProperties​(java.util.Map<java.lang.String,​java.lang.String> properties)
    Creates a copy of this object with the given properties.
    PathCreationTO withProperty​(java.lang.String key, java.lang.String value)
    Creates a copy of this object and adds the given property.
    PathCreationTO withSrcPointName​(java.lang.String srcPointName)
    Creates a copy of this object with the given point name this path originates in.

    Methods inherited from class org.opentcs.access.to.CreationTO

    getModifiableProperties, getName, getProperties, listWithAppendix, mapWithMapping, propertiesWith

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • PathCreationTO

      public PathCreationTO​(@Nonnull java.lang.String name, @Nonnull java.lang.String srcPointName, @Nonnull java.lang.String destPointName)
      Creates a new instance.
      Parameters:
      name - The name of this path.
      srcPointName - The point name this path originates in.
      destPointName - The point name this path ends in.

  • Method Details

    • withName

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

    • getSrcPointName

      @Nonnull public java.lang.String getSrcPointName()
      Returns the point name this path originates in.
      Returns:
      The point name this path originates in.

    • withSrcPointName

      public PathCreationTO withSrcPointName​(@Nonnull java.lang.String srcPointName)
      Creates a copy of this object with the given point name this path originates in.
      Parameters:
      srcPointName - The new source point name.
      Returns:
      A copy of this object, differing in the given source point.

    • getDestPointName

      @Nonnull public java.lang.String getDestPointName()
      Returns the point name this path ends in.
      Returns:
      The point name this path ends in.

    • withDestPointName

      public PathCreationTO withDestPointName​(@Nonnull java.lang.String destPointName)
      Creates a copy of this object with the given destination point.
      Parameters:
      destPointName - The new source point.
      Returns:
      A copy of this object, differing in the given value.

    • getLength

      public long getLength()
      Returns the length of this path (in mm).
      Returns:
      The length of this path (in mm).

    • withLength

      public PathCreationTO withLength​(long length)
      Creates a copy of this object with the given path length (in mm).
      Parameters:
      length - the new length (in mm). Must be a positive value.
      Returns:
      A copy of this object, differing in the given length.

    • getMaxVelocity

      public int getMaxVelocity()
      Returns the maximum allowed forward velocity (in mm/s) for this path.
      Returns:
      The maximum allowed forward velocity (in mm/s). A value of 0 means forward movement is not allowed on this path.

    • withMaxVelocity

      public PathCreationTO withMaxVelocity​(int maxVelocity)
      Creates a copy of this object with the maximum allowed forward velocity (in mm/s) for this path.
      Parameters:
      maxVelocity - The new maximum allowed velocity (in mm/s). May not be a negative value.
      Returns:
      A copy of this object, differing in the given maximum velocity.

    • getMaxReverseVelocity

      public int getMaxReverseVelocity()
      Returns the maximum allowed reverse velocity (in mm/s) for this path.
      Returns:
      The maximum allowed reverse velocity (in mm/s). A value of 0 means reverse movement is not allowed on this path.

    • withMaxReverseVelocity

      public PathCreationTO withMaxReverseVelocity​(int maxReverseVelocity)
      Creates a copy of this object with the allowed maximum reverse velocity (in mm/s).
      Parameters:
      maxReverseVelocity - The new maximum allowed reverse velocity (in mm/s). Must not be a negative value.
      Returns:
      A copy of this object, differing in the given maximum reverse velocity.

    • isLocked

      public boolean isLocked()
      Returns the lock status of this path (i.e. whether this path my be used by vehicles or not).
      Returns:
      true if this path is currently locked (i.e. it may not be used by vehicles), else false.

    • withLocked

      public PathCreationTO withLocked​(boolean locked)
      Creates a copy of this object that is locked if locked==true and unlocked otherwise.
      Parameters:
      locked - If true, this path will be locked when the method call returns; if false, this path will be unlocked.
      Returns:
      a copy of this object, differing in the locked attribute.

    • withProperties

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