it.unibo.alchemist.model.Route Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alchemist-implementationbase Show documentation

Abstract, incarnation independent implementations of the Alchemist's interfaces. Provides support for those who want to write incarnations.

There is a newer version: 35.0.1

Show newest version

/*
 * Copyright (C) 2010-2023, Danilo Pianini and contributors
 * listed, for each module, in the respective subproject's build.gradle.kts file.
 *
 * This file is part of Alchemist, and is distributed under the terms of the
 * GNU General Public License, with a linking exception,
 * as described in the file LICENSE in the Alchemist distribution's top directory.
 */

package it.unibo.alchemist.model;

import java.io.Serializable;
import java.util.List;
import java.util.stream.Stream;

/**
 * @param  type of Position followed by {@link Route} 
 */
public interface Route
> extends Iterable
, Serializable {

    /**
     * @return the length of the route
     */
    double length();

    /**
     * @param step
     *            the step
     * @return the step-th {@link Position} in the route
     */
    P getPoint(int step);

    /**
     * @return the route as list of {@link Position}
     */
    List
 getPoints();

    /**
     * 
     * @return the route as stream of {@link Position}
     */
    Stream stream();

    /**
     * @return the number of points this route is made of
     */
    int size();

}