Source: modelviewer/NWPResources.js

  1. /**
  2.  * @module meteoJS/modelviewer/nwpResources
  3.  */
  4. import Resources from './Resources.js';
  5. import VariableCollection from './VariableCollection.js';
  6. import Node from './Node.js';
  7. import Variable from './Variable.js';
  8. import TimeVariable from './TimeVariable.js';
  10. /**
  11.  * @classdesc For usage of NWP (numerical weather prediction). This class is
  12.  *   designed to use the modelviewer for NWP.
  13.  */
  14. export class NWPResources extends Resources {
  15.   
  16.   constructor() {
  17.     let collections = new Set();
  18.     ['models', 'runs', 'regions', 'fields', 'levels', 'accumulations', 'thresholds']
  19.       .forEach(id => collections.add(new VariableCollection({ id })));
  20.     let nodes = {};
  21.     for (let collection of collections)
  22.       nodes[collection.id] = new Node(collection);
  23.     // build hierarchy
  24.     nodes.models.appendChild(nodes.runs);
  25.     nodes.runs.appendChild(nodes.regions);
  26.     nodes.regions.appendChild(nodes.fields);
  27.     nodes.fields.appendChild(nodes.levels, nodes.accumulations);
  28.     nodes.accumulations.appendChild(nodes.thresholds);
  29.     
  30.     super({
  31.       topNode: nodes.models,
  32.       timesVariableCollections: new Set([nodes.models.variableCollection, nodes.runs.variableCollection])
  33.     });
  34.   }
  35.   
  36.   /**
  37.    * Creates a Variable-Object and adds it to the VariableCollection.
  38.    * 
  39.    * @param {module:meteoJS/modelviewer/variableCollection.VariableCollection}
  40.    *   variableCollection - VariableCollection.
  41.    * @param {Object} [options] - Variable options.
  42.    * @param {mixed} [options.id] - Variable id.
  43.    * @param {string} [options.name] - Default name.
  44.    * @param {Object.<string,string>} [options.names] - Names.
  45.    * @param {string[]} [options.langSortation] - Priority of language codes.
  46.    * @param {Date|undefined} [option.sdatetime] - Datetime.
  47.    * @returns {module:meteoJS/modelviewer/nwpResources.NWPResources} This.
  48.    */
  49.   addVariable(variableCollection,
  50.     { id,
  51.       name = undefined,
  52.       names = {},
  53.       langSortation = [],
  54.       datetime = undefined } = {}) {
  55.     let variable =
  56.       (datetime === undefined)
  57.         ? new Variable({
  58.           id,
  59.           name,
  60.           names,
  61.           langSortation
  62.         })
  63.         : new TimeVariable({
  64.           id,
  65.           name,
  66.           names,
  67.           langSortation,
  68.           datetime
  69.         });
  70.     variableCollection.append(variable);
  71.     return this;
  72.   }
  73.   
  74.   /**
  75.    * Collection of all defined models.
  76.    * 
  77.    * @type module:meteoJS/modelviewer/variableCollection.VariableCollection
  78.    * @readonly
  79.    */
  80.   get models() {
  81.     return this.getNodeByVariableCollectionId('models').variableCollection;
  82.   }
  83.   
  84.   /**
  85.    * Collection of all defined runs.
  86.    * 
  87.    * @type module:meteoJS/modelviewer/variableCollection.VariableCollection
  88.    * @readonly
  89.    */
  90.   get runs() {
  91.     return this.getNodeByVariableCollectionId('runs').variableCollection;
  92.   }
  93.   
  94.   /**
  95.    * Collection of all defined regions.
  96.    * 
  97.    * @type module:meteoJS/modelviewer/variableCollection.VariableCollection
  98.    * @readonly
  99.    */
  100.   get regions() {
  101.     return this.getNodeByVariableCollectionId('regions').variableCollection;
  102.   }
  103.   
  104.   /**
  105.    * Collection of all defined fields.
  106.    * 
  107.    * @type module:meteoJS/modelviewer/variableCollection.VariableCollection
  108.    * @readonly
  109.    */
  110.   get fields() {
  111.     return this.getNodeByVariableCollectionId('fields').variableCollection;
  112.   }
  113.   
  114.   /**
  115.    * Collection of all defined levels.
  116.    * 
  117.    * @type module:meteoJS/modelviewer/variableCollection.VariableCollection
  118.    * @readonly
  119.    */
  120.   get levels() {
  121.     return this.getNodeByVariableCollectionId('levels').variableCollection;
  122.   }
  123.   
  124.   /**
  125.    * Collection of all defined accumulations.
  126.    * 
  127.    * @type module:meteoJS/modelviewer/variableCollection.VariableCollection
  128.    * @readonly
  129.    */
  130.   get accumulations() {
  131.     return this.getNodeByVariableCollectionId('accumulations').variableCollection;
  132.   }
  133.   
  134.   /**
  135.    * Collection of all defined thresholds.
  136.    * 
  137.    * @type module:meteoJS/modelviewer/variableCollection.VariableCollection
  138.    * @readonly
  139.    */
  140.   get thresholds() {
  141.     return this.getNodeByVariableCollectionId('thresholds').variableCollection;
  142.   }
  143. }
  144. export default NWPResources;