gerrit.onap Code Review - ccsdk/apps.git/blob

   1 module CoreModel-CoreFoundationModule-SuperClassesAndCommonPackages {
   2     namespace "uri:onf:CoreModel-CoreFoundationModule-SuperClassesAndCommonPackages";
   3     prefix CoreModel-CoreFoundationModule-SuperClassesAndCommonPackages;
   4
   5     import CoreModel-CoreFoundationModule-StateModel {
   6         prefix CoreModel-CoreFoundationModule-StateModel;
   7     }
   8
   9     organization
  10         'ONF (Open Networking Foundation) Open Transport Working Group - Wireless Transport Project';
  11
  12     contact
  13         'WG Web:   <https://www.opennetworking.org/technical-communities/areas/specification/1931-optical-transport>
  14          WG List:  <mailto:wireless-transport@login.opennetworking.org >
  15          WG Chair: Lyndon Ong
  16                    <mailto:lyong@ciena.com>
  17          WG Chair: Giorgio Cazzaniga
  18                    <mailto:giorgio.cazzaniga@sm-optics.com>';
  19
  20     description
  21         'This module contains a collection of YANG definitions for
  22          managing microwave transport networks.';
  23
  24     revision 2016-07-10 {
  25         description
  26             "Initial revision.";
  27         reference
  28             "ONF TR xyz: A YANG Data Model for Microwave Transport Networks.";
  29     }
  30
  31     grouping Name {
  32         description "Name: A property of an entity with a value that is unique in some namespace but may change during the life of the entity. A name carries no semantics with respect to the purpose of the entity.";
  33         list nameList {
  34             description "List of names.";
  35             key 'valueName';
  36             config true;
  37             ordered-by system;
  38             uses NameAndValue;
  39             min-elements 1;
  40         }
  41     }
  42     grouping GlobalClass {
  43         description "Represents a type of thing (an Entity) that has instances which can exist in their own right (independently of any others).
  44             Entity: Has identity, defined boundary, properties, functionality and lifecycle in a global context.
  45             (consider in the context of an Object Class: (usage) The representation of a thing that may be an entity or an inseparable Entity Feature)";
  46         uses Name;
  47         uses Label;
  48         uses Extension;
  49         uses CoreModel-CoreFoundationModule-StateModel:State_Pac;
  50         list localIdList {
  51             description "An identifier that is unique in the context of some scope that is less than the global scope.
  52                 (consider in the context of Identifier: A property of an entity/role with a value that is unique within an identifier space, where the identifier space is itself unique, and immutable. The identifier therefore represents the identity of the entity/role. An identifier carries no semantics with respect to the purpose of the entity.)";
  53             key 'valueName';
  54             config true;
  55             ordered-by system;
  56             uses NameAndValue;
  57         }
  58         leaf uuid {
  59             type UniversalId;
  60             description "UUID: An identifier that is universally unique
  61                 (consider in the context of Identifier: A property of an entity/role with a value that is unique within an identifier space, where the identifier space is itself globally unique, and immutable. An identifier carries no semantics with respect to the purpose or state of the entity)";
  62         }
  63     }
  64     grouping LocalClass {
  65         description "A LocalClass represents a Feature of an Entity. It is inseparable from a GlobalClass but is a distinct feature of that GlobalClass such that the instances of LocalClass are able to have associations to other instances..
  66             Feature of an Entity: An inseparable, externally distinguishable part of an entity.
  67             The mandatory LocalId of the LocalClass instance is unique in the context of the GlobalClass from which it is inseparable.
  68             (consider in the context of an Object Class: (usage) The representation of a thing that may be an entity or an inseparable feature of an entity)
  69             ";
  70         uses Name;
  71         uses Label;
  72         uses Extension;
  73         uses CoreModel-CoreFoundationModule-StateModel:State_Pac;
  74         list localIdList {
  75             description "An identifier that is unique in the context of some scope that is less than the global scope.
  76                 (consider in the context of Identifier: A property of an entity/role with a value that is unique within an identifier space, where the identifier space is itself unique, and immutable. The identifier therefore represents the identity of the entity/role. An identifier carries no semantics with respect to the purpose of the entity.)";
  77             key 'valueName';
  78             config true;
  79             ordered-by system;
  80             uses NameAndValue;
  81             min-elements 1;
  82         }
  83         leaf uuid {
  84             type UniversalId;
  85             description "A global identifier for the LocalClass, which is used as reference.";
  86         }
  87     }
  88     grouping Label {
  89         description "A property of an entity with a value that is not expected to be unique and is allowed to change. A label carries no semantics with respect to the purpose of the entity and has no effect on the entity behavior or state.";
  90         list labelList {
  91             description "List of labels.";
  92             key 'valueName';
  93             config true;
  94             ordered-by system;
  95             uses NameAndValue;
  96         }
  97     }
  98     grouping Extension {
  99         description "Extension provides an opportunity to define properties not declared in the class that extend the class enabling a realization with simple ad-hoc extension of standard classes to be conformant.";
 100         list extensionList {
 101             description "List of simple name-value extentions";
 102             key 'valueName';
 103             config true;
 104             ordered-by system;
 105             uses NameAndValue;
 106         }
 107     }
 108     grouping UniversalIdAuthority {
 109         description "Represents the authority that controls the allocation of UUIDs.
 110             lifecycle:Preliminary";
 111         leaf uuid {
 112             type UniversalId;
 113             description "The UUID for the UUID authority.";
 114         }
 115     }
 116     grouping NameAndValueAuthority {
 117         description "Represents the authority that controls the legal valuse for the names and values of a name/value attribute.
 118             lifecycle:Preliminary";
 119         leaf uuid {
 120             type UniversalId;
 121             description "The UUID for the NameValueAuthority.";
 122         }
 123     }
 124     grouping ConditionalPackage {
 125         description "The base class for conditional packages.
 126             lifecycle:Experimental";
 127         uses Extension;
 128         uses Label;
 129     }
 130     grouping NameAndValue {
 131         description "A scoped name-value pair";
 132         leaf valueName {
 133             type string;
 134             description "The name of the value. The value need not have a name.";
 135         }
 136         leaf value {
 137             type string;
 138             description "The value";
 139         }
 140     }
 141     typedef UniversalId {
 142         description "The univeral ID value where the mechanism for generation is defned by some authority not directly referenced in the structure.";
 143         type string;
 144     }
 145 }