org.opentcs.data.model.PlantModel Maven / Gradle / Ivy

Go to download
// SPDX-FileCopyrightText: The openTCS Authors
// SPDX-License-Identifier: MIT
package org.opentcs.data.model;

import static java.util.Objects.requireNonNull;

import jakarta.annotation.Nonnull;
import java.io.Serializable;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.opentcs.data.model.visualization.Layer;
import org.opentcs.data.model.visualization.LayerGroup;
import org.opentcs.data.model.visualization.VisualLayout;

/**
 * An immutable representation of a complete plant model's state.
 */
public class PlantModel
    implements
      Serializable {

  private final String name;
  private final Map properties;
  private final Set points;
  private final Set paths;
  private final Set locationTypes;
  private final Set locations;
  private final Set blocks;
  private final Set vehicles;
  private final VisualLayout visualLayout;

  /**
   * Creates a new instance.
   *
   * @param name The model's name.
   */
  public PlantModel(
      @Nonnull
      String name
  ) {
    this(
        name, Map.of(), Set.of(), Set.of(), Set.of(), Set.of(), Set.of(), Set.of(),
        defaultVisualLayout()
    );
  }

  private PlantModel(
      @Nonnull
      String name,
      @Nonnull
      Map properties,
      @Nonnull
      Set points,
      @Nonnull
      Set paths,
      @Nonnull
      Set locationTypes,
      @Nonnull
      Set locations,
      @Nonnull
      Set blocks,
      @Nonnull
      Set vehicles,
      @Nonnull
      VisualLayout visualLayout
  ) {
    this.name = requireNonNull(name, "name");
    this.properties = Map.copyOf(properties);
    this.points = Set.copyOf(points);
    this.paths = Set.copyOf(paths);
    this.locationTypes = Set.copyOf(locationTypes);
    this.locations = Set.copyOf(locations);
    this.blocks = Set.copyOf(blocks);
    this.vehicles = Set.copyOf(vehicles);
    this.visualLayout = requireNonNull(visualLayout, "visualLayout");
  }

  /**
   * Returns the name of the plant model.
   *
   * @return The name of the plant model.
   */
  @Nonnull
  public String getName() {
    return name;
  }

  /**
   * Returns the plant model's properties.
   *
   * @return The plant model's properties.
   */
  @Nonnull
  public Map getProperties() {
    return properties;
  }

  /**
   * Returns a copy of this plant model, with its properties replaced by the given ones.
   *
   * @param properties The properties.
   * @return A copy of this plant model, with its properties replaced by the given ones.
   */
  public PlantModel withProperties(Map properties) {
    return new PlantModel(
        name,
        properties,
        points,
        paths,
        locationTypes,
        locations,
        blocks,
        vehicles,
        visualLayout
    );
  }

  /**
   * Returns the points in this plant model.
   *
   * @return The points in this plant model.
   */
  @Nonnull
  public Set getPoints() {
    return points;
  }

  /**
   * Returns a copy of this plant model, with its points replaced by the given ones.
   *
   * @param points The points.
   * @return A copy of this plant model, with its points replaced by the given ones.
   */
  public PlantModel withPoints(
      @Nonnull
      Set points
  ) {
    return new PlantModel(
        name,
        properties,
        points,
        paths,
        locationTypes,
        locations,
        blocks,
        vehicles,
        visualLayout
    );
  }

  /**
   * Returns the paths in this plant model.
   *
   * @return The paths in this plant model.
   */
  @Nonnull
  public Set getPaths() {
    return paths;
  }

  /**
   * Returns a copy of this plant model, with its paths replaced by the given ones.
   *
   * @param paths The paths.
   * @return A copy of this plant model, with its paths replaced by the given ones.
   */
  public PlantModel withPaths(
      @Nonnull
      Set paths
  ) {
    return new PlantModel(
        name,
        properties,
        points,
        paths,
        locationTypes,
        locations,
        blocks,
        vehicles,
        visualLayout
    );
  }

  /**
   * Returns the location types in this plant model.
   *
   * @return The location types in this plant model.
   */
  @Nonnull
  public Set getLocationTypes() {
    return locationTypes;
  }

  /**
   * Returns a copy of this plant model, with its location types replaced by the given ones.
   *
   * @param locationTypes The location types.
   * @return A copy of this plant model, with its location types replaced by the given ones.
   */
  public PlantModel withLocationTypes(
      @Nonnull
      Set locationTypes
  ) {
    return new PlantModel(
        name,
        properties,
        points,
        paths,
        locationTypes,
        locations,
        blocks,
        vehicles,
        visualLayout
    );
  }

  /**
   * Returns the locations in this plant model.
   *
   * @return The locations in this plant model.
   */
  @Nonnull
  public Set getLocations() {
    return locations;
  }

  /**
   * Returns a copy of this plant model, with its locations replaced by the given ones.
   *
   * @param locations The locations.
   * @return A copy of this plant model, with its locations replaced by the given ones.
   */
  public PlantModel withLocations(
      @Nonnull
      Set locations
  ) {
    return new PlantModel(
        name,
        properties,
        points,
        paths,
        locationTypes,
        locations,
        blocks,
        vehicles,
        visualLayout
    );
  }

  /**
   * Returns the blocks in this plant model.
   *
   * @return The blocks in this plant model.
   */
  @Nonnull
  public Set getBlocks() {
    return blocks;
  }

  /**
   * Returns a copy of this plant model, with its blocks replaced by the given ones.
   *
   * @param blocks The blocks.
   * @return A copy of this plant model, with its blocks replaced by the given ones.
   */
  public PlantModel withBlocks(
      @Nonnull
      Set blocks
  ) {
    return new PlantModel(
        name,
        properties,
        points,
        paths,
        locationTypes,
        locations,
        blocks,
        vehicles,
        visualLayout
    );
  }

  /**
   * Returns the vehicles in this plant model.
   *
   * @return The vehicles in this plant model.
   */
  @Nonnull
  public Set getVehicles() {
    return vehicles;
  }

  /**
   * Returns a copy of this plant model, with its vehicles replaced by the given ones.
   *
   * @param vehicles The vehicles.
   * @return A copy of this plant model, with its vehicles replaced by the given ones.
   */
  public PlantModel withVehicles(
      @Nonnull
      Set vehicles
  ) {
    return new PlantModel(
        name,
        properties,
        points,
        paths,
        locationTypes,
        locations,
        blocks,
        vehicles,
        visualLayout
    );
  }

  /**
   * Returns the visual layout in this plant model.
   *
   * @return The visual layout in this plant model.
   */
  @Nonnull
  public VisualLayout getVisualLayout() {
    return visualLayout;
  }

  /**
   * Returns a copy of this plant model, with its visual layout replaced by the given one.
   *
   * @param visualLayout The visual layout to be set.
   * @return A copy of this plant model, with its visual layout replaced by the given one.
   */
  public PlantModel withVisualLayout(
      @Nonnull
      VisualLayout visualLayout
  ) {
    return new PlantModel(
        name,
        properties,
        points,
        paths,
        locationTypes,
        locations,
        blocks,
        vehicles,
        visualLayout
    );
  }

  @Override
  public String toString() {
    return "PlantModel{"
        + "name=" + name
        + ", properties=" + properties
        + ", points=" + points
        + ", paths=" + paths
        + ", locationTypes=" + locationTypes
        + ", locations=" + locations
        + ", blocks=" + blocks
        + ", vehicles=" + vehicles
        + ", visualLayout=" + visualLayout
        + '}';
  }

  private static VisualLayout defaultVisualLayout() {
    return new VisualLayout(ModelConstants.DEFAULT_VISUAL_LAYOUT_NAME)
        .withLayers(
            List.of(
                new Layer(
                    ModelConstants.DEFAULT_LAYER_ID,
                    ModelConstants.DEFAULT_LAYER_ORDINAL,
                    true,
                    ModelConstants.DEFAULT_LAYER_NAME,
                    ModelConstants.DEFAULT_LAYER_GROUP_ID
                )
            )
        )
        .withLayerGroups(
            List.of(
                new LayerGroup(
                    ModelConstants.DEFAULT_LAYER_GROUP_ID,
                    ModelConstants.DEFAULT_LAYER_GROUP_NAME,
                    true
                )
            )
        );
  }

}