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 Summary
Constructors Constructor Description PointCreationTO(java.lang.String name)
Creates a new instance. -
Method Summary
Modifier and Type Method Description Triple
getPosition()
Returns the position of this point (in mm).Point.Type
getType()
Returns the type of this point.double
getVehicleOrientationAngle()
Returns a vehicle's orientation angle at this position. (-360..360, orDouble.NaN
, if an orientation angle is not specified for this point.)PointCreationTO
withName(java.lang.String name)
Creates a copy of this object with the given name.PointCreationTO
withPosition(Triple position)
Creates a copy of this object with the given position (in mm).PointCreationTO
withProperties(java.util.Map<java.lang.String,java.lang.String> properties)
Creates a copy of this object with the given properties.PointCreationTO
withProperty(java.lang.String key, java.lang.String value)
Creates a copy of this object and adds the given property.PointCreationTO
withType(Point.Type type)
Creates a copy of this object with the given type.PointCreationTO
withVehicleOrientationAngle(double vehicleOrientationAngle)
Creates a copy of this object with the vehicle's (assumed) orientation angle when it's at this position.Methods inherited from class org.opentcs.access.to.CreationTO
getModifiableProperties, getName, getProperties, listWithAppendix, mapWithMapping, propertiesWith
-
Constructor Details
-
PointCreationTO
public PointCreationTO(@Nonnull java.lang.String name)Creates a new instance.- Parameters:
name
- The name of this point.
-
-
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.
-
getPosition
Returns the position of this point (in mm).- Returns:
- The position of this point (in mm).
-
withPosition
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
public double getVehicleOrientationAngle()Returns a vehicle's orientation angle at this position. (-360..360, orDouble.NaN
, if an orientation angle is not specified for this point.)- Returns:
- The vehicle's orientation angle when it's at this position.
-
withVehicleOrientationAngle
Creates a copy of this object with the vehicle's (assumed) orientation angle when it's at this position. Allowed value range: [-360..360], orDouble.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
Returns the type of this point.- Returns:
- The type of this point.
-
withType
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 classCreationTO
- 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 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.
-