java.lang.Object

org.opentcs.data.model.PlantModel

All Implemented Interfaces:: java.io.Serializable

public class PlantModel
extends java.lang.Object
implements java.io.Serializable

An immutable representation of a complete plant model's state.

See Also:: Serialized Form

Constructor Summary

Constructors

Constructor Description

PlantModel(java.lang.String name)
Creates a new instance.

Method Summary

Modifier and Type	Method	Description
`java.util.Set<Block>`	`getBlocks()`
`java.util.Set<Location>`	`getLocations()`
`java.util.Set<LocationType>`	`getLocationTypes()`
`java.lang.String`	`getName()`
`java.util.Set<Path>`	`getPaths()`
`java.util.Set<Point>`	`getPoints()`
`java.util.Map<java.lang.String,java.lang.String>`	`getProperties()`
`java.util.Set<Vehicle>`	`getVehicles()`
`java.util.Set<VisualLayout>`	`getVisualLayouts()`
`java.lang.String`	`toString()`
`PlantModel`	`withBlocks(java.util.Set<Block> blocks)`
`PlantModel`	`withLocations(java.util.Set<Location> locations)`
`PlantModel`	`withLocationTypes(java.util.Set<LocationType> locationTypes)`
`PlantModel`	`withPaths(java.util.Set<Path> paths)`
`PlantModel`	`withPoints(java.util.Set<Point> points)`
`PlantModel`	`withProperties(java.util.Map<java.lang.String,java.lang.String> properties)`
`PlantModel`	`withVehicles(java.util.Set<Vehicle> vehicles)`
`PlantModel`	`withVisuaLayouts(java.util.Set<VisualLayout> visualLayouts)`	Deprecated. Use `withVisualLayouts(java.util.Set)` instead.
`PlantModel`	`withVisualLayouts(java.util.Set<VisualLayout> visualLayouts)`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- PlantModel
  
  public PlantModel(@Nonnull java.lang.String name)
  
  Creates a new instance.
  
  Parameters:
  
  name - The model's name.
Method Details
- getName
  
  @Nonnull public java.lang.String getName()
- getProperties
  
  @Nonnull public java.util.Map<java.lang.String,java.lang.String> getProperties()
- withProperties
  
  public PlantModel withProperties(java.util.Map<java.lang.String,java.lang.String> properties)
- getPoints
  
  @Nonnull public java.util.Set<Point> getPoints()
- withPoints
  
  public PlantModel withPoints(@Nonnull java.util.Set<Point> points)
- getPaths
  
  @Nonnull public java.util.Set<Path> getPaths()
- withPaths
  
  public PlantModel withPaths(@Nonnull java.util.Set<Path> paths)
- getLocationTypes
  
  @Nonnull public java.util.Set<LocationType> getLocationTypes()
- withLocationTypes
  
  public PlantModel withLocationTypes(@Nonnull java.util.Set<LocationType> locationTypes)
- getLocations
  
  @Nonnull public java.util.Set<Location> getLocations()
- withLocations
  
  public PlantModel withLocations(@Nonnull java.util.Set<Location> locations)
- getBlocks
  
  @Nonnull public java.util.Set<Block> getBlocks()
- withBlocks
  
  public PlantModel withBlocks(@Nonnull java.util.Set<Block> blocks)
- getVehicles
  
  @Nonnull public java.util.Set<Vehicle> getVehicles()
- withVehicles
  
  public PlantModel withVehicles(@Nonnull java.util.Set<Vehicle> vehicles)
- getVisualLayouts
  
  @Nonnull public java.util.Set<VisualLayout> getVisualLayouts()
- withVisuaLayouts
  
  @Deprecated @ScheduledApiChange(when="6.0", details="Will be removed.") public PlantModel withVisuaLayouts(@Nonnull java.util.Set<VisualLayout> visualLayouts)
  
  Deprecated.
  Use withVisualLayouts(java.util.Set) instead.
  
  Returns an instance with the visual layouts replaced by the given ones.
  
  Parameters:
  
  visualLayouts - The visual layouts to be set.
  
  Returns:
  
  The instance with the visual layouts replaced by the given ones.
- withVisualLayouts
  
  public PlantModel withVisualLayouts(@Nonnull java.util.Set<VisualLayout> visualLayouts)
- toString
  
  public java.lang.String toString()
  
  Overrides:
  
  toString in class java.lang.Object

Class PlantModel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

Method Details