net.sf.javagimmicks.graph.routing.Route Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gimmicks Show documentation

Utility classes, APIs and tools for Java

There is a newer version: 0.99-alpha1

package net.sf.javagimmicks.graph.routing;

import java.util.List;

import net.sf.javagimmicks.graph.Edge;
import net.sf.javagimmicks.graph.Graph;
import net.sf.javagimmicks.graph.WeightedEdge;

/**
 * Represents a route between two vertices with a {@link Graph}.
 * 
 * A route is a {@link List} of {@link Edge}s that knows its source and target
 * vertex as well as an optional cost.
 * 
 * @param 
 *           the type of vertices of this {@link Route}
 * @param 
 *           the type of {@link Edge}s of this {@link Route}
 */
public interface Route> extends List
{
   /**
    * Returns the cost of this {@link Route} - which is the sum of it's
    * {@link Edge}s (if they are {@link WeightedEdge}s).
    * 
    * @return the cost of this {@link Route}
    */
   double getCost();

   /**
    * Returns the source vertex of this {@link Route}.
    * 
    * @return the source vertex of this {@link Route}
    */
   VertexType getSourceVertex();

   /**
    * Returns the target vertex of this {@link Route}.
    * 
    * @return the target vertex of this {@link Route}
    */
   VertexType getTargetVertex();
}