ordmodels/common/src/main/yang/org-openroadm-common-amplifier-types@2018-11-30.yang

   1 module org-openroadm-common-amplifier-types {
   2   namespace "http://org/openroadm/common-amplifier-types";
   3   prefix org-openroadm-common-amplifier-types;
   4
   5   organization
   6     "Open ROADM MSA";
   7   contact
   8     "OpenROADM.org";
   9   description
  10     "YANG definitions of common types.
  11
  12       Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
  13       All other rights reserved.
  14
  15       Redistribution and use in source and binary forms, with or without modification,
  16       are permitted provided that the following conditions are met:
  17
  18       * Redistributions of source code must retain the above copyright notice, this
  19         list of conditions and the following disclaimer.
  20       * Redistributions in binary form must reproduce the above copyright notice,
  21         this list of conditions and the following disclaimer in the documentation and/or
  22         other materials provided with the distribution.
  23       * Neither the Members of the Open ROADM MSA Agreement nor the names of its
  24         contributors may be used to endorse or promote products derived from this software
  25         without specific prior written permission.
  26
  27       THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
  28       AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  29       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  30       IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
  31       INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  32       NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
  33       OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  34       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  35       ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  36       POSSIBILITY OF SUCH DAMAGE";
  37
  38   revision 2018-11-30 {
  39     description
  40       "Version 4.1.0";
  41   }
  42   revision 2018-03-30 {
  43     description
  44       "Version 3.0.0";
  45   }
  46
  47   typedef amplifier-types {
  48     type enumeration {
  49       enum "standard" {
  50         value 1;
  51       }
  52     }
  53     description
  54       "identifier for amplifier type
  55        1. standard for amplifier as defined initially in the ROADM MSA specifications
  56        To be completed if/when additional amplifier types are required ";
  57   }
  58
  59   typedef line-amplifier-control-mode {
  60     type enumeration {
  61       enum "gainLoss" {
  62         value 2;
  63       }
  64       enum "off" {
  65         value 3;
  66       }
  67     }
  68     description
  69       "Identifies the line amplifier control mode, either off or gain.";
  70   }
  71
  72   typedef amplifier-gain-range {
  73     type enumeration {
  74       enum "gain-range-1" {
  75         value 1;
  76       }
  77       enum "gain-range-2" {
  78         value 2;
  79       }
  80       enum "gain-range-3" {
  81         value 3;
  82       }
  83       enum "gain-range-4" {
  84         value 4;
  85       }
  86     }
  87     description
  88       "Operational mode for the amplifier:
  89        this parameter allows modeling different operational modes (gain ranges) ,notably for switched-gain amplifiers.
  90        It indicates which performance model shall be used by the path feasibility engine.
  91        For standard amplifier, or when performance evaluation is based on incremental noise, use gain-range-1.
  92        When performance evaluation is based on advanced parameters, specify used gain-range (1 to 4).
  93        Up to release 2.1, only gain-range-1 is to be used (default value) ";
  94   }
  95 }