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:
Serializable
A transfer object describing a path in the plant model.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Contains information regarding the grahical representation of a path. -
Constructor Summary
ConstructorsConstructorDescriptionPathCreationTO
(String name, String srcPointName, String destPointName) Creates a new instance. -
Method Summary
Modifier and TypeMethodDescriptionReturns the point name this path ends in.Returns the information regarding the grahical representation of this path.long
Returns the length of this path (in mm).int
Returns the maximum allowed reverse velocity (in mm/s) for this path.int
Returns the maximum allowed forward velocity (in mm/s) for this path.Returns the peripheral operations to be performed when a vehicle travels along this path.Returns the point name this path originates in.Returns a map of envelope keys to envelopes that vehicles traversing this path may occupy.boolean
isLocked()
Returns the lock status of this path (i.e.toString()
withDestPointName
(String destPointName) Creates a copy of this object with the given destination point.withLayout
(PathCreationTO.Layout layout) Creates a copy of this object, with the given layout.withLength
(long length) Creates a copy of this object with the given path length (in mm).withLocked
(boolean locked) Creates a copy of this object that is locked iflocked==true
and unlocked otherwise.withMaxReverseVelocity
(int maxReverseVelocity) Creates a copy of this object with the allowed maximum reverse velocity (in mm/s).withMaxVelocity
(int maxVelocity) Creates a copy of this object with the maximum allowed forward velocity (in mm/s) for this path.Creates a copy of this object with the given name.withPeripheralOperations
(List<PeripheralOperationCreationTO> peripheralOperations) Creates a copy of this object with the given peripheral operations.withProperties
(Map<String, String> properties) Creates a copy of this object with the given properties.withProperty
(String key, String value) Creates a copy of this object and adds the given property.withSrcPointName
(String srcPointName) Creates a copy of this object with the given point name this path originates in.withVehicleEnvelopes
(Map<String, Envelope> vehicleEnvelopes) Creates a copy of this object, with the given vehicle envelopes.Methods inherited from class org.opentcs.access.to.CreationTO
getModifiableProperties, getName, getProperties, listWithAppendix, mapWithMapping, propertiesWith
-
Constructor Details
-
Method Details
-
withName
Creates a copy of this object with the given name.- Overrides:
withName
in classCreationTO
- Parameters:
name
- The new name.- Returns:
- A copy of this object, differing in the given name.
-
getSrcPointName
Returns the point name this path originates in.- Returns:
- The point name this path originates in.
-
withSrcPointName
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
Returns the point name this path ends in.- Returns:
- The point name this path ends in.
-
withDestPointName
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
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
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
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.
-
getPeripheralOperations
Returns the peripheral operations to be performed when a vehicle travels along this path.- Returns:
- The peripheral operations to be performed when a vehicle travels along this path.
-
withPeripheralOperations
public PathCreationTO withPeripheralOperations(@Nonnull List<PeripheralOperationCreationTO> peripheralOperations) Creates a copy of this object with the given peripheral operations.- Parameters:
peripheralOperations
- The peripheral operations.- Returns:
- A copy of this object, differing in the given peripheral operations.
-
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), elsefalse
.
-
withLocked
Creates a copy of this object that is locked iflocked==true
and unlocked otherwise.- Parameters:
locked
- Iftrue
, this path will be locked when the method call returns; iffalse
, this path will be unlocked.- Returns:
- a copy of this object, differing in the locked attribute.
-
withProperties
Creates a copy of this object with the given properties.- Overrides:
withProperties
in classCreationTO
- Parameters:
properties
- The new properties.- Returns:
- A copy of this object, differing in the given properties.
-
withProperty
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 classCreationTO
- 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
Returns a map of envelope keys to envelopes that vehicles traversing this path may occupy.- Returns:
- A map of envelope keys to envelopes that vehicles traversing this path may occupy.
-
withVehicleEnvelopes
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
Returns the information regarding the grahical representation of this path.- Returns:
- The information regarding the grahical representation of this path.
-
withLayout
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
-