Klasse PlantModelCreationTO

java.lang.Object
org.opentcs.access.to.CreationTO
org.opentcs.access.to.model.PlantModelCreationTO
Alle implementierten Schnittstellen:
Serializable

public class PlantModelCreationTO extends CreationTO implements Serializable
A transfer object describing a plant model.
Siehe auch:
  • Konstruktordetails

    • PlantModelCreationTO

      public PlantModelCreationTO(String name)
      Creates a new instance.
      Parameter:
      name - The name of this plant model.
  • Methodendetails

    • getPoints

      public List<PointCreationTO> getPoints()
      Returns this plant model's points.
      Gibt zurück:
      This plant model's points.
    • withPoints

      public PlantModelCreationTO withPoints(@Nonnull List<PointCreationTO> points)
      Creates a copy of this object with the given points.
      Parameter:
      points - The new points.
      Gibt zurück:
      A copy of this model, differing in the given points.
    • withPoint

      public PlantModelCreationTO withPoint(@Nonnull PointCreationTO point)
      Creates a copy of this object that includes the given point in the list of points.
      Parameter:
      point - the new point.
      Gibt zurück:
      A copy of this model that also includes the given point.
    • getPaths

      public List<PathCreationTO> getPaths()
      Returns this plant model's paths.
      Gibt zurück:
      This plant model's paths.
    • withPaths

      public PlantModelCreationTO withPaths(@Nonnull List<PathCreationTO> paths)
      Creates a copy of this object with the given paths.
      Parameter:
      paths - The new paths.
      Gibt zurück:
      A copy of this model, differing in the given paths.
    • withPath

      public PlantModelCreationTO withPath(@Nonnull PathCreationTO path)
      Creates a copy of this object that includes the given path in the list of paths.
      Parameter:
      path - the new path.
      Gibt zurück:
      A copy of this model that also includes the given path.
    • getLocationTypes

      public List<LocationTypeCreationTO> getLocationTypes()
      Returns this plant model's location types.
      Gibt zurück:
      This plant model's location types.
    • withLocationTypes

      public PlantModelCreationTO withLocationTypes(@Nonnull List<LocationTypeCreationTO> locationTypes)
      Creates a copy of this object with the given location type.
      Parameter:
      locationTypes - The new location types.
      Gibt zurück:
      A copy of this model, differing in the given location types.
    • withLocationType

      public PlantModelCreationTO withLocationType(@Nonnull LocationTypeCreationTO locationType)
      Creates a copy of this object that includes the given path in the list of location types.
      Parameter:
      locationType - the new location type.
      Gibt zurück:
      A copy of this model that also includes the given location type.
    • getLocations

      public List<LocationCreationTO> getLocations()
      Returns this plant model's locations.
      Gibt zurück:
      This plant model's locations.
    • withLocations

      public PlantModelCreationTO withLocations(@Nonnull List<LocationCreationTO> locations)
      Creates a copy of this object with the given locations.
      Parameter:
      locations - The new locations.
      Gibt zurück:
      A copy of this model, differing in the given locations.
    • withLocation

      public PlantModelCreationTO withLocation(@Nonnull LocationCreationTO location)
      Creates a copy of this object that includes the given block in the list of locations.
      Parameter:
      location - the new location.
      Gibt zurück:
      A copy of this model that also includes the given location.
    • getBlocks

      public List<BlockCreationTO> getBlocks()
      Returns this plant model's blocks.
      Gibt zurück:
      This plant model's blocks.
    • withBlocks

      public PlantModelCreationTO withBlocks(@Nonnull List<BlockCreationTO> blocks)
      Creates a copy of this object with the given blocks.
      Parameter:
      blocks - The new blocks.
      Gibt zurück:
      A copy of this model, differing in the given blocks.
    • withBlock

      public PlantModelCreationTO withBlock(@Nonnull BlockCreationTO block)
      Creates a copy of this object that includes the given block in the list of blocks.
      Parameter:
      block - the new block.
      Gibt zurück:
      A copy of this model that also includes the given block.
    • getVehicles

      public List<VehicleCreationTO> getVehicles()
      Returns this plant model's vehicles.
      Gibt zurück:
      This plant model's vehicles.
    • withVehicles

      public PlantModelCreationTO withVehicles(@Nonnull List<VehicleCreationTO> vehicles)
      Creates a copy of this object with the given vehicles.
      Parameter:
      vehicles - The new vehicles.
      Gibt zurück:
      A copy of this model, differing in the given vehicles.
    • withVehicle

      public PlantModelCreationTO withVehicle(@Nonnull VehicleCreationTO vehicle)
      Creates a copy of this object that includes the given vehicle in the list of vehicles.
      Parameter:
      vehicle - the new vehicle.
      Gibt zurück:
      A copy of this model that also includes the given vehicle.
    • getVisualLayout

      public VisualLayoutCreationTO getVisualLayout()
      Returns this plant model's visual layout.
      Gibt zurück:
      This plant model's visual layout.
    • withVisualLayout

      public PlantModelCreationTO withVisualLayout(@Nonnull VisualLayoutCreationTO visualLayout)
      Creates a copy of this object with the given visual layout.
      Parameter:
      visualLayout - the new visual layout.
      Gibt zurück:
      A copy of this model with the given visual layout.
    • withProperties

      public PlantModelCreationTO withProperties(@Nonnull Map<String,String> properties)
      Creates a copy of this object with the given properties.
      Setzt außer Kraft:
      withProperties in Klasse CreationTO
      Parameter:
      properties - The new properties.
      Gibt zurück:
      A copy of this object, differing in the given properties.
    • withProperty

      public PlantModelCreationTO withProperty(@Nonnull String key, @Nonnull 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.
      Setzt außer Kraft:
      withProperty in Klasse CreationTO
      Parameter:
      key - the key.
      value - the value
      Gibt zurück:
      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

      public String toString()
      Setzt außer Kraft:
      toString in Klasse Object