Source: lib/node_options.js

  1. //
  2. // Licensed under the Apache License, Version 2.0 (the "License");
  3. // you may not use this file except in compliance with the License.
  4. // You may obtain a copy of the License at
  5. //
  6. //     http://www.apache.org/licenses/LICENSE-2.0
  7. //
  8. // Unless required by applicable law or agreed to in writing, software
  9. // distributed under the License is distributed on an "AS IS" BASIS,
  10. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11. // See the License for the specific language governing permissions and
  12. // limitations under the License.
  14. 'use strict';
  16. const { Parameter } = require('./parameter.js');
  17. /**
  18.  * NodeOptions specify configuration choices during the
  19.  * node instantiation process.
  20.  * @class
  21.  */
  22. class NodeOptions {
  23.   /**
  24.    * Create a new instance with default property values.
  25.    * @constructor
  26.    */
  27.   constructor() {
  28.     this._startParameterServices = true;
  29.     this._parameterOverrides = [];
  30.     this._automaticallyDeclareParametersFromOverrides = false;
  31.   }
  33.   /**
  34.    * Get the startParameterServices option.
  35.    * Default value = true;
  36.    * @returns {boolean} -
  37.    */
  38.   get startParameterServices() {
  39.     return this._startParameterServices;
  40.   }
  42.   /**
  43.    * Set startParameterServices.
  44.    * @param {boolean} startFlag - True indicates for a node to start it's parameter_service.
  45.    */
  46.   set startParameterServices(startFlag) {
  47.     this._startParameterServices = startFlag;
  48.   }
  50.   /**
  51.    * Get the parameterOverrides.
  52.    * @return {Parameter[]} - An array of Parameters that serve as overrides for a node's default
  53.    *   parameters. Default = empty array [].
  54.    */
  55.   get parameterOverrides() {
  56.     return this._parameterOverrides;
  57.   }
  59.   /**
  60.    * Set the Parameters that will serve to override a node's default parameter settings.
  61.    * Setting to null, reinitializes the parameterOverrides to an empty array.
  62.    * @param {Parameter|Parameter[]} parameters - A single parameter or parameter[].
  63.    *    Default is an empty array.
  64.    */
  65.   set parameterOverrides(parameters = []) {
  66.     let povalue = parameters;
  68.     if (!povalue) {
  69.       povalue = [];
  70.     } else if (povalue instanceof Parameter) {
  71.       // a single parameter
  72.       povalue = [povalue];
  73.     } else if (!Array.isArray(parameters)) {
  74.       throw TypeError('Expected Parameter[]');
  75.     }
  77.     this._parameterOverrides = povalue;
  78.   }
  80.   /**
  81.    * Get the automaticallyDeclareParametersFromOverrides.
  82.    *
  83.    * @returns {boolean} - True indicates that a node shold declare declare parameters from
  84.    *    it's parameter-overrides
  85.    */
  86.   get automaticallyDeclareParametersFromOverrides() {
  87.     return this._automaticallyDeclareParametersFromOverrides;
  88.   }
  90.   /**
  91.    * Set automaticallyDeclareParametersFromOverrides.
  92.    *
  93.    * @param {boolean} declareParamsFlag - When true, a node will declare parameters from all
  94.    * parameter-overrides.
  95.    */
  96.   set automaticallyDeclareParametersFromOverrides(declareParamsFlag) {
  97.     this._automaticallyDeclareParametersFromOverrides = declareParamsFlag;
  98.   }
  100.   /**
  101.    * Return an instance configured with default options.
  102.    * @returns {NodeOptions} - An instance with default values.
  103.    */
  104.   static get defaultOptions() {
  105.     return new NodeOptions();
  106.   }
  107. }
  109. module.exports = NodeOptions;