pcep/api/src/main/java/org/opendaylight/protocol/pcep/PCEPOFCodes.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  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 package org.opendaylight.protocol.pcep;
   9
  10 /**
  11  * Enumerable representing ObjectiveFunction codes. Defined in RFC5541.
  12  *
  13  * @see <a href="http://tools.ietf.org/html/rfc5541#section-4">Objective
  14  *      Functions Definition</a>
  15  * @see <a href="http://tools.ietf.org/html/rfc6006#section-3.6.1">New Objective
  16  *      Functions [RFC6006]</a>
  17  */
  18 public enum PCEPOFCodes {
  19         /**
  20          * Minimum Cost Path
  21          */
  22         MCP,
  23         /**
  24          * Minimum Load Path
  25          */
  26         MLP,
  27         /**
  28          * Maximum residual Bandwidth Path
  29          */
  30         MBP,
  31         /**
  32          * Minimize aggregate Bandwidth Consumption
  33          */
  34         MBC,
  35         /**
  36          * Minimize the load of the Most Loaded Link
  37          */
  38         MLL,
  39         /**
  40          * Minimize Cumulative Cost of a set of paths
  41          */
  42         MCC,
  43         /**
  44          * Name: Shortest Path Tree (SPT)
  45          *
  46          * Description: Minimize the maximum source-to-leaf cost with respect to a
  47          * specific metric or to the TE metric used as the default metric when the
  48          * metric is not specified (e.g., TE or IGP metric).
  49          */
  50         SPT,
  51         /**
  52          * Name: Minimum Cost Tree (MCT)
  53          *
  54          * Description: Minimize the total cost of the tree, that is the sum of the
  55          * costs of tree links, with respect to a specific metric or to the TE
  56          * metric used as the default metric when the metric is not specified.
  57          */
  58         MCT;
  59 }