Package org.opentcs.access.to.model
Class PlantModelCreationTO
java.lang.Object
org.opentcs.access.to.CreationTO
org.opentcs.access.to.model.PlantModelCreationTO
- All Implemented Interfaces:
Serializable
A transfer object describing a plant model.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns this plant model's blocks.Returns this plant model's locations.Returns this plant model's location types.getPaths()
Returns this plant model's paths.Returns this plant model's points.Returns this plant model's vehicles.Returns this plant model's visual layout.toString()
withBlock
(BlockCreationTO block) Creates a copy of this object that includes the given block in the list of blocks.withBlocks
(List<BlockCreationTO> blocks) Creates a copy of this object with the given blocks.withLocation
(LocationCreationTO location) Creates a copy of this object that includes the given block in the list of locations.withLocations
(List<LocationCreationTO> locations) Creates a copy of this object with the given locations.withLocationType
(LocationTypeCreationTO locationType) Creates a copy of this object that includes the given path in the list of location types.withLocationTypes
(List<LocationTypeCreationTO> locationTypes) Creates a copy of this object with the given location type.withPath
(PathCreationTO path) Creates a copy of this object that includes the given path in the list of paths.withPaths
(List<PathCreationTO> paths) Creates a copy of this object with the given paths.withPoint
(PointCreationTO point) Creates a copy of this object that includes the given point in the list of points.withPoints
(List<PointCreationTO> points) Creates a copy of this object with the given points.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.withVehicle
(VehicleCreationTO vehicle) Creates a copy of this object that includes the given vehicle in the list of vehicles.withVehicles
(List<VehicleCreationTO> vehicles) Creates a copy of this object with the given vehicles.withVisualLayout
(VisualLayoutCreationTO visualLayout) Creates a copy of this object with the given visual layout.Methods inherited from class org.opentcs.access.to.CreationTO
getModifiableProperties, getName, getProperties, listWithAppendix, mapWithMapping, propertiesWith, withName
-
Constructor Details
-
PlantModelCreationTO
Creates a new instance.- Parameters:
name
- The name of this plant model.
-
-
Method Details
-
getPoints
Returns this plant model's points.- Returns:
- This plant model's points.
-
withPoints
Creates a copy of this object with the given points.- Parameters:
points
- The new points.- Returns:
- A copy of this model, differing in the given points.
-
withPoint
Creates a copy of this object that includes the given point in the list of points.- Parameters:
point
- the new point.- Returns:
- A copy of this model that also includes the given point.
-
getPaths
Returns this plant model's paths.- Returns:
- This plant model's paths.
-
withPaths
Creates a copy of this object with the given paths.- Parameters:
paths
- The new paths.- Returns:
- A copy of this model, differing in the given paths.
-
withPath
Creates a copy of this object that includes the given path in the list of paths.- Parameters:
path
- the new path.- Returns:
- A copy of this model that also includes the given path.
-
getLocationTypes
Returns this plant model's location types.- Returns:
- This plant model's location types.
-
withLocationTypes
Creates a copy of this object with the given location type.- Parameters:
locationTypes
- The new location types.- Returns:
- A copy of this model, differing in the given location types.
-
withLocationType
Creates a copy of this object that includes the given path in the list of location types.- Parameters:
locationType
- the new location type.- Returns:
- A copy of this model that also includes the given location type.
-
getLocations
Returns this plant model's locations.- Returns:
- This plant model's locations.
-
withLocations
Creates a copy of this object with the given locations.- Parameters:
locations
- The new locations.- Returns:
- A copy of this model, differing in the given locations.
-
withLocation
Creates a copy of this object that includes the given block in the list of locations.- Parameters:
location
- the new location.- Returns:
- A copy of this model that also includes the given location.
-
getBlocks
Returns this plant model's blocks.- Returns:
- This plant model's blocks.
-
withBlocks
Creates a copy of this object with the given blocks.- Parameters:
blocks
- The new blocks.- Returns:
- A copy of this model, differing in the given blocks.
-
withBlock
Creates a copy of this object that includes the given block in the list of blocks.- Parameters:
block
- the new block.- Returns:
- A copy of this model that also includes the given block.
-
getVehicles
Returns this plant model's vehicles.- Returns:
- This plant model's vehicles.
-
withVehicles
Creates a copy of this object with the given vehicles.- Parameters:
vehicles
- The new vehicles.- Returns:
- A copy of this model, differing in the given vehicles.
-
withVehicle
Creates a copy of this object that includes the given vehicle in the list of vehicles.- Parameters:
vehicle
- the new vehicle.- Returns:
- A copy of this model that also includes the given vehicle.
-
getVisualLayout
Returns this plant model's visual layout.- Returns:
- This plant model's visual layout.
-
withVisualLayout
Creates a copy of this object with the given visual layout.- Parameters:
visualLayout
- the new visual layout.- Returns:
- A copy of this model with the given visual layout.
-
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.
-
toString
-