algo/algo-api/src/main/java/org/opendaylight/algo/PathComputationProvider.java

   1 /*
   2  * Copyright (c) 2020 Orange. All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.algo;
  10
  11 import org.opendaylight.graph.ConnectedGraph;
  12 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.path.computation.rev200120.AlgorithmType;
  13
  14 /**
  15  * This class provides access to Path Computation Algorithms.
  16  *
  17  * @author Olivier Dugeon
  18  *
  19  */
  20 public interface PathComputationProvider {
  21
  22     /**
  23      * Return Path Computation Algorithm object that corresponds to the requested type.
  24      *
  25      * @param cgraph         Connected Graph on which path computation will run
  26      * @param algorithmType  Algorithm supported types are: 'SPF', 'CSPF' and 'SAMCRA'
  27      *
  28      * @return PathComputationAlgorithm
  29      */
  30     PathComputationAlgorithm getPathComputationAlgorithm(ConnectedGraph cgraph, AlgorithmType algorithmType);
  31
  32 }