Made TNumber nonparametric and moved range/units to NumberProperty, see

#137
phetsims · Sep 11, 2017 · d7388b3 · d7388b3
1 parent 9f6c643
commit d7388b3
Show file tree

Hide file tree

Showing 3 changed files with 70 additions and 11 deletions.
diff --git a/js/NumberProperty.js b/js/NumberProperty.js
@@ -9,9 +9,10 @@ define( function( require ) {
   'use strict';
 
   // modules
-  var inherit = require( 'PHET_CORE/inherit' );
-  var Property = require( 'AXON/Property' );
   var axon = require( 'AXON/axon' );
+  var Property = require( 'AXON/Property' );
+  var TNumber = require( 'ifphetio!PHET_IO/types/TNumber' );
+  var inherit = require( 'PHET_CORE/inherit' );
 
   // constants
   /**
@@ -22,6 +23,58 @@ define( function( require ) {
     return ( typeof value === 'number' );
   };
 
+  // valid values for options.units // TODO: Should this be an enum?
+  var VALID_UNITS = [
+    'amperes',
+    'milliamperes',
+    'becquerels',
+    'centimeters',
+    'centimeters-squared',
+    'coulombs',
+    'degrees Celsius',
+    'farads',
+    'kilograms',
+    'grams',
+    'gray',
+    'henrys',
+    'henries',
+    'hertz',
+    'joules',
+    'katals',
+    'kelvins',
+    'liters',
+    'liters/second',
+    'lumens',
+    'lux',
+    'meters',
+    'meters/second',
+    'meters/second/second',
+    'moles',
+    'moles/liter',
+    'nanometers',
+    'newtons',
+    'newtons/meters',
+    'newtons-second/meters',
+    'ohms',
+    'ohm-centimeters',
+    'pascals',
+    'percent',
+    'radians',
+    'radians/second',
+    'seconds',
+    'siemens',
+    'sieverts',
+    'steradians',
+    'tesla',
+    'view-coordinates/second',
+    'volts',
+    'watts',
+    'webers'
+  ];
+
+  // values for options.type
+  var VALID_TYPE_VALUES = [ 'FloatingPoint', 'Integer' ];
+
   /**
    * @param {number} value - initial value
    * @param {Object} [options]
@@ -30,12 +83,21 @@ define( function( require ) {
   function NumberProperty( value, options ) {
 
     options = _.extend( {
-      range: null // {null|Range|{min:number, max:number}} range of the value
+      range: null, // {null|Range|{min:number, max:number}} range of the value
+      phetioValueType: TNumber,
+      valueType: 'FloatingPoint', // 'FloatingPoint' | 'Integer'
+      units: null
     }, options );
 
     assert && assert( !options.validValues, 'NumberProperty cannot use validValues' );
     assert && assert( !options.isValidValue, 'NumberProperty implements its own isValidValue' );
 
+    options.units && assert && assert( _.includes( VALID_UNITS, options.units ), 'Invalid units: ' + options.units );
+    assert && assert( _.includes( VALID_TYPE_VALUES, options.valueType ), 'invalid type: ' + options.valueType );
+
+    // @public (read-only) {string} units from above
+    this.units = options.units;
+
     if ( options.range ) {
       options.isValidValue = function( value ) {
         return IS_NUMBER( value ) && ( value >= options.range.min ) && ( value <= options.range.max );

diff --git a/js/ObservableArray.js b/js/ObservableArray.js
@@ -13,16 +13,13 @@ define( function( require ) {
   'use strict';
 
   // modules
-  var Property = require( 'AXON/Property' );
   var axon = require( 'AXON/axon' );
-  var inherit = require( 'PHET_CORE/inherit' );
   var Emitter = require( 'AXON/Emitter' );
+  var NumberProperty = require( 'AXON/NumberProperty' );
   var TObservableArray = require( 'AXON/TObservableArray' );
+  var inherit = require( 'PHET_CORE/inherit' );
   var Tandem = require( 'TANDEM/Tandem' );
 
-  // phet-io modules
-  var TNumber = require( 'ifphetio!PHET_IO/types/TNumber' );
-
   /**
    * @param {Object[]} [array]
    * @param {Object} [options]
@@ -54,9 +51,9 @@ define( function( require ) {
     this._removedListeners = []; // @private listeners called when an item is removed
 
     // @public (read-only) observe this, but don't set it
-    this.lengthProperty = new Property( this._array.length, {
+    this.lengthProperty = new NumberProperty( this._array.length, {
       tandem: options.tandem && options.tandem.createTandem( 'lengthProperty' ),
-      phetioValueType: TNumber( { type: 'Integer' } )
+      valueType: 'Integer'
     } );
 
     // @private Store the initial array, if any, for resetting, see #4

diff --git a/js/TObservableArray.js b/js/TObservableArray.js
@@ -94,7 +94,7 @@ define( function( require ) {
          * Get the number of electrons currently in the array.
          */
         getLength: {
-          returnType: TNumber( { type: 'Integer' } ),
+          returnType: TNumber,
           parameterTypes: [],
           implementation: function() {
             return this.instance.length;