org.opentcs.access.to.model.PlantModelCreationTO Maven / Gradle / Ivy

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

import static java.util.Objects.requireNonNull;

import jakarta.annotation.Nonnull;
import java.io.Serializable;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import org.opentcs.access.to.CreationTO;
import org.opentcs.data.model.ModelConstants;
import org.opentcs.data.model.visualization.Layer;
import org.opentcs.data.model.visualization.LayerGroup;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * A transfer object describing a plant model.
 */
public class PlantModelCreationTO
    extends
      CreationTO
    implements
      Serializable {

  /**
   * This class's logger.
   */
  private static final Logger LOG = LoggerFactory.getLogger(PlantModelCreationTO.class);

  /**
   * The plant model's points.
   */
  private final List points;
  /**
   * The plant model's paths.
   */
  private final List paths;
  /**
   * The plant model's location types.
   */
  private final List locationTypes;
  /**
   * The plant model's locations.
   */
  private final List locations;
  /**
   * The plant model's blocks.
   */
  private final List blocks;
  /**
   * The plant model's vehicles.
   */
  private final List vehicles;
  /**
   * The plant model's visual layout.
   */
  private final VisualLayoutCreationTO visualLayout;

  /**
   * Creates a new instance.
   *
   * @param name The name of this plant model.
   */
  public PlantModelCreationTO(String name) {
    super(name);
    this.points = List.of();
    this.paths = List.of();
    this.locationTypes = List.of();
    this.locations = List.of();
    this.blocks = List.of();
    this.vehicles = List.of();
    this.visualLayout = defaultVisualLayout();
  }

  private PlantModelCreationTO(
      @Nonnull
      String name,
      @Nonnull
      Map properties,
      @Nonnull
      List points,
      @Nonnull
      List paths,
      @Nonnull
      List locationTypes,
      @Nonnull
      List locations,
      @Nonnull
      List blocks,
      @Nonnull
      List vehicles,
      @Nonnull
      VisualLayoutCreationTO visualLayout
  ) {
    super(name, properties);
    this.points = requireNonNull(points, "points");
    this.paths = requireNonNull(paths, "paths");
    this.locationTypes = requireNonNull(locationTypes, "locationTypes");
    this.locations = requireNonNull(locations, "locations");
    this.blocks = requireNonNull(blocks, "blocks");
    this.vehicles = requireNonNull(vehicles, "vehicles");
    this.visualLayout = requireNonNull(visualLayout, "visualLayout");
  }

  /**
   * Returns this plant model's points.
   *
   * @return This plant model's points.
   */
  public List getPoints() {
    return Collections.unmodifiableList(points);
  }

  /**
   * Creates a copy of this object with the given points.
   *
   * @param points The new points.
   * @return A copy of this model, differing in the given points.
   */
  public PlantModelCreationTO withPoints(
      @Nonnull
      List points
  ) {
    return new PlantModelCreationTO(
        getName(),
        getModifiableProperties(),
        points,
        paths,
        locationTypes,
        locations,
        blocks,
        vehicles,
        visualLayout
    );
  }

  /**
   * Creates a copy of this object that includes the given point in the list of points.
   *
   * @param point the new point.
   * @return A copy of this model that also includes the given point.
   */
  public PlantModelCreationTO withPoint(
      @Nonnull
      PointCreationTO point
  ) {
    requireNonNull(point, "point");
    return new PlantModelCreationTO(
        getName(),
        getModifiableProperties(),
        listWithAppendix(points, point),
        paths,
        locationTypes,
        locations,
        blocks,
        vehicles,
        visualLayout
    );
  }

  /**
   * Returns this plant model's paths.
   *
   * @return This plant model's paths.
   */
  public List getPaths() {
    return Collections.unmodifiableList(paths);
  }

  /**
   * Creates a copy of this object with the given paths.
   *
   * @param paths The new paths.
   * @return A copy of this model, differing in the given paths.
   */
  public PlantModelCreationTO withPaths(
      @Nonnull
      List paths
  ) {
    return new PlantModelCreationTO(
        getName(),
        getModifiableProperties(),
        points,
        paths,
        locationTypes,
        locations,
        blocks,
        vehicles,
        visualLayout
    );
  }

  /**
   * Creates a copy of this object that includes the given path in the list of paths.
   *
   * @param path the new path.
   * @return A copy of this model that also includes the given path.
   */
  public PlantModelCreationTO withPath(
      @Nonnull
      PathCreationTO path
  ) {
    requireNonNull(path, "path");
    return new PlantModelCreationTO(
        getName(),
        getModifiableProperties(),
        points,
        listWithAppendix(paths, path),
        locationTypes,
        locations,
        blocks,
        vehicles,
        visualLayout
    );
  }

  /**
   * Returns this plant model's location types.
   *
   * @return This plant model's location types.
   */
  public List getLocationTypes() {
    return Collections.unmodifiableList(locationTypes);
  }

  /**
   * Creates a copy of this object with the given location type.
   *
   * @param locationTypes The new location types.
   * @return A copy of this model, differing in the given location types.
   */
  public PlantModelCreationTO withLocationTypes(
      @Nonnull
      List locationTypes
  ) {
    return new PlantModelCreationTO(
        getName(),
        getModifiableProperties(),
        points,
        paths,
        locationTypes,
        locations,
        blocks,
        vehicles,
        visualLayout
    );
  }

  /**
   * Creates a copy of this object that includes the given path in the list of location types.
   *
   * @param locationType the new location type.
   * @return A copy of this model that also includes the given location type.
   */
  public PlantModelCreationTO withLocationType(
      @Nonnull
      LocationTypeCreationTO locationType
  ) {
    requireNonNull(locationType, "locationType");
    return new PlantModelCreationTO(
        getName(),
        getModifiableProperties(),
        points,
        paths,
        listWithAppendix(locationTypes, locationType),
        locations,
        blocks,
        vehicles,
        visualLayout
    );
  }

  /**
   * Returns this plant model's locations.
   *
   * @return This plant model's locations.
   */
  public List getLocations() {
    return Collections.unmodifiableList(locations);
  }

  /**
   * Creates a copy of this object with the given locations.
   *
   * @param locations The new locations.
   * @return A copy of this model, differing in the given locations.
   */
  public PlantModelCreationTO withLocations(
      @Nonnull
      List locations
  ) {
    return new PlantModelCreationTO(
        getName(),
        getModifiableProperties(),
        points,
        paths,
        locationTypes,
        locations,
        blocks,
        vehicles,
        visualLayout
    );
  }

  /**
   * Creates a copy of this object that includes the given block in the list of locations.
   *
   * @param location the new location.
   * @return A copy of this model that also includes the given location.
   */
  public PlantModelCreationTO withLocation(
      @Nonnull
      LocationCreationTO location
  ) {
    requireNonNull(location, "location");
    return new PlantModelCreationTO(
        getName(),
        getModifiableProperties(),
        points,
        paths,
        locationTypes,
        listWithAppendix(locations, location),
        blocks,
        vehicles,
        visualLayout
    );
  }

  /**
   * Returns this plant model's blocks.
   *
   * @return This plant model's blocks.
   */
  public List getBlocks() {
    return Collections.unmodifiableList(blocks);
  }

  /**
   * Creates a copy of this object with the given blocks.
   *
   * @param blocks The new blocks.
   * @return A copy of this model, differing in the given blocks.
   */
  public PlantModelCreationTO withBlocks(
      @Nonnull
      List blocks
  ) {
    return new PlantModelCreationTO(
        getName(),
        getModifiableProperties(),
        points,
        paths,
        locationTypes,
        locations,
        blocks,
        vehicles,
        visualLayout
    );
  }

  /**
   * Creates a copy of this object that includes the given block in the list of blocks.
   *
   * @param block the new block.
   * @return A copy of this model that also includes the given block.
   */
  public PlantModelCreationTO withBlock(
      @Nonnull
      BlockCreationTO block
  ) {
    requireNonNull(block, "block");
    return new PlantModelCreationTO(
        getName(),
        getModifiableProperties(),
        points,
        paths,
        locationTypes,
        locations,
        CreationTO.listWithAppendix(blocks, block),
        vehicles,
        visualLayout
    );
  }

  /**
   * Returns this plant model's vehicles.
   *
   * @return This plant model's vehicles.
   */
  public List getVehicles() {
    return Collections.unmodifiableList(vehicles);
  }

  /**
   * Creates a copy of this object with the given vehicles.
   *
   * @param vehicles The new vehicles.
   * @return A copy of this model, differing in the given vehicles.
   */
  public PlantModelCreationTO withVehicles(
      @Nonnull
      List vehicles
  ) {
    return new PlantModelCreationTO(
        getName(),
        getModifiableProperties(),
        points,
        paths,
        locationTypes,
        locations,
        blocks,
        vehicles,
        visualLayout
    );
  }

  /**
   * Creates a copy of this object that includes the given vehicle in the list of vehicles.
   *
   * @param vehicle the new vehicle.
   * @return A copy of this model that also includes the given vehicle.
   */
  public PlantModelCreationTO withVehicle(
      @Nonnull
      VehicleCreationTO vehicle
  ) {
    requireNonNull(vehicle, "vehicle");
    return new PlantModelCreationTO(
        getName(),
        getModifiableProperties(),
        points,
        paths,
        locationTypes,
        locations,
        blocks,
        listWithAppendix(vehicles, vehicle),
        visualLayout
    );
  }

  /**
   * Returns this plant model's visual layout.
   *
   * @return This plant model's visual layout.
   */
  public VisualLayoutCreationTO getVisualLayout() {
    return visualLayout;
  }

  /**
   * Creates a copy of this object with the given visual layout.
   *
   * @param visualLayout the new visual layout.
   * @return A copy of this model with the given visual layout.
   */
  public PlantModelCreationTO withVisualLayout(
      @Nonnull
      VisualLayoutCreationTO visualLayout
  ) {
    requireNonNull(visualLayout, "visualLayout");
    return new PlantModelCreationTO(
        getName(),
        getModifiableProperties(),
        points,
        paths,
        locationTypes,
        locations,
        blocks,
        vehicles,
        ensureValidity(visualLayout)
    );
  }

  /**
   * Creates a copy of this object with the given properties.
   *
   * @param properties The new properties.
   * @return A copy of this object, differing in the given properties.
   */
  @Override
  public PlantModelCreationTO withProperties(
      @Nonnull
      Map properties
  ) {
    return new PlantModelCreationTO(
        getName(),
        properties,
        points,
        paths,
        locationTypes,
        locations,
        blocks,
        vehicles,
        visualLayout
    );
  }

  /**
   * Creates a copy of this object and adds the given property.
   * If value == null, then the key-value pair is removed from the properties.
   *
   * @param key the key.
   * @param value the value
   * @return A copy of this object that either
   * includes the given entry in it's current properties, if value != null or
   * excludes the entry otherwise.
   */
  @Override
  public PlantModelCreationTO withProperty(
      @Nonnull
      String key,
      @Nonnull
      String value
  ) {
    return new PlantModelCreationTO(
        getName(),
        propertiesWith(key, value),
        points,
        paths,
        locationTypes,
        locations,
        blocks,
        vehicles,
        visualLayout
    );
  }

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

  private VisualLayoutCreationTO defaultVisualLayout() {
    return new VisualLayoutCreationTO(ModelConstants.DEFAULT_VISUAL_LAYOUT_NAME)
        .withLayer(
            new Layer(
                ModelConstants.DEFAULT_LAYER_ID,
                ModelConstants.DEFAULT_LAYER_ORDINAL,
                true,
                ModelConstants.DEFAULT_LAYER_NAME,
                ModelConstants.DEFAULT_LAYER_GROUP_ID
            )
        )
        .withLayerGroup(
            new LayerGroup(
                ModelConstants.DEFAULT_LAYER_GROUP_ID,
                ModelConstants.DEFAULT_LAYER_GROUP_NAME,
                true
            )
        );
  }

  private VisualLayoutCreationTO ensureValidity(
      @Nonnull
      VisualLayoutCreationTO visualLayout
  ) {
    VisualLayoutCreationTO vLayout = visualLayout;

    if (visualLayout.getLayers().isEmpty()) {
      LOG.warn("Adding default layer to visual layout with no layers...");
      vLayout = visualLayout.withLayer(
          new Layer(
              ModelConstants.DEFAULT_LAYER_ID,
              ModelConstants.DEFAULT_LAYER_ORDINAL,
              true,
              ModelConstants.DEFAULT_LAYER_NAME,
              ModelConstants.DEFAULT_LAYER_GROUP_ID
          )
      );
    }

    if (visualLayout.getLayerGroups().isEmpty()) {
      LOG.warn("Adding default layer group to visual layout with no layer groups...");
      vLayout = vLayout.withLayerGroup(
          new LayerGroup(
              ModelConstants.DEFAULT_LAYER_GROUP_ID,
              ModelConstants.DEFAULT_LAYER_GROUP_NAME,
              true
          )
      );
    }

    return vLayout;
  }
}