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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opentcs-api-base Show documentation
opentcs-api-base
There is a newer version: 6.2.0
/**
 * Copyright (c) The openTCS Authors.
 *
 * This program is free software and subject to the MIT license. (For details,
 * see the licensing information (LICENSE.txt) you should have received with
 * this copy of the software.)
 */
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.visualization.Layer;
import org.opentcs.data.model.visualization.LayerGroup;

/**
 * A transfer object describing a visual layout in the plant model.
 */
public class VisualLayoutCreationTO
    extends
      CreationTO
    implements
      Serializable {

  /**
   * This layout's scale on the X axis (in mm/pixel).
   */
  private final double scaleX;
  /**
   * This layout's scale on the Y axis (in mm/pixel).
   */
  private final double scaleY;
  /**
   * This layout's layers.
   */
  private final List layers;
  /**
   * The layout's layer groups.
   */
  private final List layerGroups;

  /**
   * Creates a new instance.
   *
   * @param name The name of this visual layout.
   */
  public VisualLayoutCreationTO(
      @Nonnull
      String name
  ) {
    super(name);

    this.scaleX = 50.0;
    this.scaleY = 50.0;
    this.layers = List.of();
    this.layerGroups = List.of();
  }

  private VisualLayoutCreationTO(
      @Nonnull
      String name,
      @Nonnull
      Map properties,
      double scaleX,
      double scaleY,
      @Nonnull
      List layers,
      @Nonnull
      List layerGroups
  ) {
    super(name, properties);
    this.scaleX = scaleX;
    this.scaleY = scaleY;
    this.layers = requireNonNull(layers, "layers");
    this.layerGroups = requireNonNull(layerGroups, "layerGroups");
  }

  /**
   * Creates a copy of this object with the given name.
   *
   * @param name the new name of the instance.
   * @return A copy of this object, differing in the given value.
   */
  @Override
  public VisualLayoutCreationTO withName(
      @Nonnull
      String name
  ) {
    return new VisualLayoutCreationTO(
        name,
        getModifiableProperties(),
        scaleX,
        scaleY,
        layers,
        layerGroups
    );
  }

  /**
   * 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 value.
   */
  @Override
  public VisualLayoutCreationTO withProperties(
      @Nonnull
      Map properties
  ) {
    return new VisualLayoutCreationTO(
        getName(),
        properties,
        scaleX,
        scaleY,
        layers,
        layerGroups
    );
  }

  /**
   * 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 VisualLayoutCreationTO withProperty(
      @Nonnull
      String key,
      @Nonnull
      String value
  ) {
    return new VisualLayoutCreationTO(
        getName(),
        propertiesWith(key, value),
        scaleX,
        scaleY,
        layers,
        layerGroups
    );
  }

  /**
   * Returns this layout's scale on the X axis (in mm/pixel).
   *
   * @return This layout's scale on the X axis.
   */
  public double getScaleX() {
    return scaleX;
  }

  /**
   * Creates a copy of this object with the layout's scale on the X axis (in mm/pixel).
   *
   * @param scaleX The new scale.
   * @return A copy of this object, differing in the given value.
   */
  public VisualLayoutCreationTO withScaleX(double scaleX) {
    return new VisualLayoutCreationTO(
        getName(),
        getModifiableProperties(),
        scaleX,
        scaleY,
        layers,
        layerGroups
    );
  }

  /**
   * Returns this layout's scale on the Y axis (in mm/pixel).
   *
   * @return This layout's scale on the Y axis.
   */
  public double getScaleY() {
    return scaleY;
  }

  /**
   * Creates a copy of this object with the given layout's scale on the Y axis (in mm/pixel).
   *
   * @param scaleY The new scale.
   * @return A copy of this object, differing in the given value.
   */
  public VisualLayoutCreationTO withScaleY(double scaleY) {
    return new VisualLayoutCreationTO(
        getName(),
        getModifiableProperties(),
        scaleX,
        scaleY,
        layers,
        layerGroups
    );
  }

  /**
   * Returns the layers of this visual layout.
   *
   * @return The layers of this visual layout.
   */
  @Nonnull
  public List getLayers() {
    return Collections.unmodifiableList(layers);
  }

  /**
   * Creates a copy of this object, with the given layers.
   *
   * @param layers The value to be set in the copy.
   * @return A copy of this object, differing in the given value.
   */
  public VisualLayoutCreationTO withLayers(
      @Nonnull
      List layers
  ) {
    return new VisualLayoutCreationTO(
        getName(),
        getModifiableProperties(),
        scaleX,
        scaleY,
        layers,
        layerGroups
    );
  }

  /**
   * Creates a copy of this object, with the given layer.
   *
   * @param layer The value to be set in the copy.
   * @return A copy of this object, differing in the given value.
   */
  public VisualLayoutCreationTO withLayer(
      @Nonnull
      Layer layer
  ) {
    return new VisualLayoutCreationTO(
        getName(),
        getModifiableProperties(),
        scaleX,
        scaleY,
        listWithAppendix(layers, layer),
        layerGroups
    );
  }

  /**
   * Returns the layer groups of this visual layout.
   *
   * @return The layer groups of this visual layout.
   */
  @Nonnull
  public List getLayerGroups() {
    return Collections.unmodifiableList(layerGroups);
  }

  /**
   * Creates a copy of this object, with the given layer groups.
   *
   * @param layerGroups The value to be set in the copy.
   * @return A copy of this object, differing in the given value.
   */
  public VisualLayoutCreationTO withLayerGroups(
      @Nonnull
      List layerGroups
  ) {
    return new VisualLayoutCreationTO(
        getName(),
        getModifiableProperties(),
        scaleX,
        scaleY,
        layers,
        layerGroups
    );
  }

  /**
   * Creates a copy of this object, with the given layer group.
   *
   * @param layerGroup The value to be set in the copy.
   * @return A copy of this object, differing in the given value.
   */
  public VisualLayoutCreationTO withLayerGroup(
      @Nonnull
      LayerGroup layerGroup
  ) {
    return new VisualLayoutCreationTO(
        getName(),
        getModifiableProperties(),
        scaleX,
        scaleY,
        layers,
        listWithAppendix(layerGroups, layerGroup)
    );
  }

  @Override
  public String toString() {
    return "VisualLayoutCreationTO{"
        + "name=" + getName()
        + ", scaleX=" + scaleX
        + ", scaleY=" + scaleY
        + ", layers=" + layers
        + ", layerGroups=" + layerGroups
        + ", properties=" + getProperties()
        + '}';
  }

}