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:
Serializable
A transfer object describing a point in the plant model.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classContains information regarding the grahical representation of a point. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the information regarding the grahical representation of this point.getPose()Returns the pose of the vehicle at this point.getType()Returns the type of this point.Returns a map of envelope keys to envelopes that vehicles located at this point may occupy.toString()withLayout(PointCreationTO.Layout layout) Creates a copy of this object, with the given layout.Creates a copy of this object with the given name.Creates a copy of this object with the given pose.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.withType(Point.Type type) Creates a copy of this object with the given type.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
-
PointCreationTO
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:
withNamein classCreationTO- Parameters:
name- The new name.- Returns:
- A copy of this object, differing in the given name.
-
getPose
Returns the pose of the vehicle at this point.- Returns:
- The pose of the vehicle at this point.
-
withPose
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.
-
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
Creates a copy of this object with the given properties.- Overrides:
withPropertiesin 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:
withPropertyin 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 located at this point may occupy.- Returns:
- A map of envelope keys to envelopes that vehicles located at this point 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 point.- Returns:
- The information regarding the grahical representation of this point.
-
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
-