Package org.opentcs.access.to.model
Class VisualLayoutCreationTO
java.lang.Object
org.opentcs.access.to.CreationTO
org.opentcs.access.to.model.VisualLayoutCreationTO
- All Implemented Interfaces:
Serializable
A transfer object describing a visual layout in the plant model.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the layer groups of this visual layout.Returns the layers of this visual layout.double
Returns this layout's scale on the X axis (in mm/pixel).double
Returns this layout's scale on the Y axis (in mm/pixel).toString()
Creates a copy of this object, with the given layer.withLayerGroup
(LayerGroup layerGroup) Creates a copy of this object, with the given layer group.withLayerGroups
(List<LayerGroup> layerGroups) Creates a copy of this object, with the given layer groups.withLayers
(List<Layer> layers) Creates a copy of this object, with the given layers.Creates a copy of this object with the given name.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.withScaleX
(double scaleX) Creates a copy of this object with the layout's scale on the X axis (in mm/pixel).withScaleY
(double scaleY) Creates a copy of this object with the given layout's scale on the Y axis (in mm/pixel).Methods inherited from class org.opentcs.access.to.CreationTO
getModifiableProperties, getName, getProperties, listWithAppendix, mapWithMapping, propertiesWith
-
Constructor Details
-
VisualLayoutCreationTO
Creates a new instance.- Parameters:
name
- The name of this visual layout.
-
-
Method Details
-
withName
Creates a copy of this object with the given name.- Overrides:
withName
in classCreationTO
- Parameters:
name
- the new name of the instance.- Returns:
- A copy of this object, differing in the given value.
-
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 value.
-
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.
-
getScaleX
public double getScaleX()Returns this layout's scale on the X axis (in mm/pixel).- Returns:
- This layout's scale on the X axis.
-
withScaleX
Creates a copy of this object with the layout's scale on the X axis (in mm/pixel).- Parameters:
scaleX
- The new scale.- Returns:
- A copy of this object, differing in the given value.
-
getScaleY
public double getScaleY()Returns this layout's scale on the Y axis (in mm/pixel).- Returns:
- This layout's scale on the Y axis.
-
withScaleY
Creates a copy of this object with the given layout's scale on the Y axis (in mm/pixel).- Parameters:
scaleY
- The new scale.- Returns:
- A copy of this object, differing in the given value.
-
getLayers
Returns the layers of this visual layout.- Returns:
- The layers of this visual layout.
-
withLayers
Creates a copy of this object, with the given layers.- Parameters:
layers
- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
withLayer
Creates a copy of this object, with the given layer.- Parameters:
layer
- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
getLayerGroups
Returns the layer groups of this visual layout.- Returns:
- The layer groups of this visual layout.
-
withLayerGroups
Creates a copy of this object, with the given layer groups.- Parameters:
layerGroups
- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
withLayerGroup
Creates a copy of this object, with the given layer group.- Parameters:
layerGroup
- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
toString
-