All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.github.rinde.rinsim.scenario.generator.Models Maven / Gradle / Ivy

There is a newer version: 4.4.6
Show newest version
/*
 * Copyright (C) 2011-2015 Rinde van Lon, iMinds-DistriNet, KU Leuven
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.github.rinde.rinsim.scenario.generator;

import javax.annotation.Nullable;
import javax.measure.Measure;
import javax.measure.quantity.Length;
import javax.measure.quantity.Velocity;
import javax.measure.unit.Unit;

import com.github.rinde.rinsim.core.model.Model;
import com.github.rinde.rinsim.core.model.pdp.DefaultPDPModel;
import com.github.rinde.rinsim.core.model.pdp.PDPModel;
import com.github.rinde.rinsim.core.model.pdp.TimeWindowPolicy;
import com.github.rinde.rinsim.core.model.road.PlaneRoadModel;
import com.github.rinde.rinsim.core.model.road.RoadModel;
import com.github.rinde.rinsim.geom.Point;
import com.github.rinde.rinsim.pdptw.common.PDPRoadModel;
import com.google.common.base.MoreObjects;
import com.google.common.base.Objects;
import com.google.common.base.Supplier;

/**
 * Utility class for creating {@link Supplier}s that create {@link Model}s which
 * can be used in a {@link ScenarioGenerator}.
 * @author Rinde van Lon
 */
public final class Models {

  private Models() {}

  /**
   * Creates a new supplier for creating a {@link PlaneRoadModel} wrapped in a
   * {@link PDPRoadModel}. All constructor parameters except
   * maxSpeed and allowDiversion are supplied by the
   * {@link ScenarioGenerator}. The bounds of the plane, the speed unit and the
   * distance unit are supplied by the {@link ScenarioGenerator}.
   * @param maxSpeed The maximum speed to use. See the {@link PlaneRoadModel}
   *          constructor for more information. The unit of the speed is defined
   *          by the {@link ScenarioGenerator} instance.
   * @param allowDiversion Whether to allow diversion. See the
   *          {@link PDPRoadModel} constructor for more information.
   * @return A supplier which can be used in a {@link ScenarioGenerator}. See
   *         {@link ScenarioGenerator.Builder#addModel(ModelSupplierScenGen)}.
   */
  public static ModelSupplierScenGen roadModel(double maxSpeed,
      boolean allowDiversion) {
    return new DefaultRoadModelSupplier(maxSpeed, allowDiversion);
  }

  /**
   * Creates a new supplier for creating a {@link PDPModel}.
   * @param twp The {@link TimeWindowPolicy} to use.
   * @return A supplier for {@link PDPModel}.
   */
  public static Supplier pdpModel(TimeWindowPolicy twp) {
    return new PDPModelSupplier(twp);
  }

  /**
   * Wraps the specified supplier in a {@link ModelSupplierScenGen}.
   * @param sup The supplier.
   * @param  The model type.
   * @return The wrapped supplier.
   */
  public static > ModelSupplierScenGen adapt(
      Supplier sup) {
    return new Adapter<>(sup);
  }

  /**
   * A supplier which can be used to construct a {@link Model} based on a
   * {@link ScenarioGenerator}.
   * @param  The type of model the supplier returns.
   * @author Rinde van Lon
   */
  public interface ModelSupplierScenGen> {
    /**
     * @param sg The {@link ScenarioGenerator} that can be used in the supplier.
     * @return An instance of T. This must be a newly
     *         constructed instance.
     */
    Supplier get(ScenarioGenerator sg);
  }

  private static class Adapter> implements
  ModelSupplierScenGen {
    private final Supplier supplier;

    Adapter(Supplier sup) {
      supplier = sup;
    }

    @Override
    public Supplier get(ScenarioGenerator sg) {
      return supplier;
    }
  }

  private static class PDPModelSupplier implements Supplier {
    private final TimeWindowPolicy timeWindowPolicy;

    PDPModelSupplier(TimeWindowPolicy twp) {
      timeWindowPolicy = twp;
    }

    @Override
    public PDPModel get() {
      return new DefaultPDPModel(timeWindowPolicy);
    }

    @Override
    public String toString() {
      return MoreObjects.toStringHelper(this)
          .add("timeWindowPolicy", timeWindowPolicy)
          .toString();
    }

    @Override
    public int hashCode() {
      return Objects.hashCode(timeWindowPolicy);
    }

    @Override
    public boolean equals(@Nullable Object other) {
      if (this == other) {
        return true;
      }
      if (null == other || getClass() != other.getClass()) {
        return false;
      }
      final PDPModelSupplier o = (PDPModelSupplier) other;
      return Objects.equal(o.timeWindowPolicy, timeWindowPolicy);
    }
  }

  private static class DefaultRoadModelSupplier implements
  ModelSupplierScenGen {
    final double speed;
    final boolean diversion;

    DefaultRoadModelSupplier(double maxSpeed, boolean allowDiversion) {
      speed = maxSpeed;
      diversion = allowDiversion;
    }

    @Override
    public Supplier get(final ScenarioGenerator sg) {
      return new RoadModelSup(speed, diversion, sg);
    }
  }

  private static class RoadModelSup implements Supplier {
    private final Point min;
    private final Point max;
    private final Unit distanceUnit;
    private final Measure speedMeasure;
    private final boolean allowDiversion;

    RoadModelSup(double speed, boolean diversion, ScenarioGenerator sg) {
      min = sg.getMin();
      max = sg.getMax();
      distanceUnit = sg.getDistanceUnit();
      speedMeasure = Measure.valueOf(speed, sg.getSpeedUnit());
      allowDiversion = diversion;
    }

    @Override
    public RoadModel get() {
      return new PDPRoadModel(
          new PlaneRoadModel(
              min,
              max,
              distanceUnit,
              speedMeasure),
              allowDiversion);
    }

    @Override
    public String toString() {
      return MoreObjects.toStringHelper(this)
          .add("min", min)
          .add("max", max)
          .add("distanceUnit", distanceUnit)
          .add("speedMeasure", speedMeasure)
          .add("allowDiversion", allowDiversion)
          .toString();
    }

    @Override
    public int hashCode() {
      return Objects.hashCode(min, max, distanceUnit, speedMeasure,
          allowDiversion);
    }

    @Override
    public boolean equals(@Nullable Object other) {
      if (this == other) {
        return true;
      }
      if (null == other) {
        return false;
      }
      if (getClass() != other.getClass()) {
        return false;
      }
      final RoadModelSup o = (RoadModelSup) other;
      return Objects.equal(o.min, min)
          && Objects.equal(o.max, max)
          && Objects.equal(o.distanceUnit, distanceUnit)
          && Objects.equal(o.speedMeasure, speedMeasure)
          && Objects.equal(o.allowDiversion, allowDiversion);
    }
  }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy