sdnr/wireless-transport/code-Carbon-SR1/ux/mwtnCommons/mwtnCommons-module/src/main/resources/mwtnCommons/README.md

   1 # MTWN Comments
   2
   3 This component offers services for MTWN specific ODL DLUX application development.
   4 It should ensure, that common functionality of ODL DLUX applications is implemented and tested only once, but reused by several applications.
   5
   6 All MWTN ODL DLUX application should have a dependency to 'mtwnCommons'.
   7 However, it is a case by case decision by developers, whether such dependency is needed for their application of not.
   8
   9 Common functions are:
  10 * A centralized service ($mwtnLog), which stores application logs in a centralized database. It should simplify failure analysis and debugging.
  11 * Communication with the RestConf API of OpenDaylight.
  12 * WebSocket subscription for notification handling
  13 * Implementation of common object classes as defined by the Microwave Information model (e.g. NetConfServer, NetworkElement, LogicalTerminationPoint, LayerProtocol, MW_AirInterface_Pac, MW_PureEthernetStructure_Pac, MW_EthernetContainer_Pac)
  14 * Enhanced [angular.js](https://angularjs.org/) features for web development, which are not native in [ODL DLUX](https://wiki.opendaylight.org/view/OpenDaylight_dlux:Main).
  15
  16 ## Installation
  17
  18 Additional [angular.js](https://angularjs.org/) feature and implementations are listed in the file [bower.json](./bower.json).
  19
  20 ```
  21 bower install
  22 ```
  23 Please see [bower.io](https://bower.io/) for further information about bower.
  24
  25 ## angular-chart.js
  26
  27 * Open app/mwtnCommons/bower_components/angular-chart.js/dist/angular-chart
  28 * Locate
  29    else if (typeof define === 'function' && define.amd) {
  30     // AMD. Register as an anonymous module.
  31     define(['angular', 'chart'], factory);
  32   }
  33
  34   * change  define(['angular', 'chart'], factory); to  define(['angular', 'app/mwtnCommons/bower_components/chart.js/dist/Chart'], factory);