org.opentcs.drivers.peripherals.management.PeripheralAttachmentEvent 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.drivers.peripherals.management;

import java.io.Serializable;
import static java.util.Objects.requireNonNull;
import javax.annotation.Nonnull;
import org.opentcs.data.model.Location;
import org.opentcs.data.model.TCSResourceReference;

/**
 * Instances of this class represent events emitted by/for attaching comm adapters.
 *
 * @author Martin Grzenia (Fraunhofer IML)
 */
public class PeripheralAttachmentEvent
    extends PeripheralCommAdapterEvent
    implements Serializable {

  /**
   * The location a peripheral comm adapter has been attached to.
   */
  private final TCSResourceReference location;
  /**
   * The information to the actual attachment.
   */
  private final PeripheralAttachmentInformation attachmentInformation;

  /**
   * Creates a new instance.
   *
   * @param location The location a comm adapter has been attached to.
   * @param attachmentInformation The information to the actual attachment.
   */
  public PeripheralAttachmentEvent(
      @Nonnull TCSResourceReference location,
      @Nonnull PeripheralAttachmentInformation attachmentInformation) {
    this.location = requireNonNull(location, "location");
    this.attachmentInformation = requireNonNull(attachmentInformation, "attachmentInformation");
  }

  /**
   * Returns the location a comm adapter has been attached to.
   *
   * @return The location a comm adapter has been attached to.
   */
  public TCSResourceReference getLocation() {
    return location;
  }

  /**
   * Returns the information to the actual attachment.
   *
   * @return The information to the actual attachment.
   */
  public PeripheralAttachmentInformation getAttachmentInformation() {
    return attachmentInformation;
  }
}