org.opentcs.data.model.TCSResource 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.4.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.data.model;

import java.io.Serializable;
import java.util.Map;
import org.opentcs.components.kernel.Scheduler;
import org.opentcs.data.ObjectHistory;
import org.opentcs.data.TCSObject;

/**
 * Describes a resource that {@link Vehicle}s may claim for exclusive usage.
 *
 * @see Scheduler
 * @param  The actual resource class.
 */
public abstract class TCSResource>
    extends
      TCSObject
    implements
      Serializable {

  /**
   * Creates a new TCSResource.
   *
   * @param name The new resource's name.
   */
  @SuppressWarnings("this-escape")
  protected TCSResource(String name) {
    super(name);
    reference = new TCSResourceReference<>(this);
  }

  /**
   * Creates a new TCSResource.
   *
   * @param name The new resource's name.
   * @param properties A set of properties (key-value pairs) associated with this object.
   * @param history A history of events related to this object.
   */
  @SuppressWarnings("this-escape")
  protected TCSResource(String name, Map properties, ObjectHistory history) {
    super(name, properties, history);
    reference = new TCSResourceReference<>(this);
  }

  // Methods inherited from TCSObject start here.
  @Override
  public TCSResourceReference getReference() {
    return (TCSResourceReference) reference;
  }
}