Add templated parameters support

Benjamin Renard
1 parent bd59dd0b
Showing 6 changed files with 189 additions and 27 deletions Show diff stats
generic_data/ParamTemplate/ParamTemplateList.xml
generic_data/ParamTemplate/bmorsch_mso_##sampling##_##orbit##.xml
generic_data/ParamTemplate/bmorsch_tot_##sampling##_##orbit##.xml
js/app/models/PlotObjects/PlotParamObject.js
js/app/views/ParamArgumentsUI.js
js/app/views/PlotComponents/PlotParamForm.js
@@ -0,0 +1,24 @@
+<?xml version="1.0"?>
+
+<paramTemplateList>
+	<paramTemplate paramId='bmorsch_mso' fileName='bmorsch_mso_##sampling##_##orbit##'>
+		<arguments>
+			<argument key='sampling' name='Sampling Time' type='float' default='60'/>
+			<argument key='orbit' name='Spacecraft Orbit' type='list' default='mex_xyz'>
+				<item key='mex_xyz' name='MEX'/>
+				<item key='mav_xyz_mso' name='MAVEN'/>
+				<item key='xyz_mgs_mso' name='MGS'/>
+			</argument>
+		</arguments>
+	</paramTemplate>
+	<paramTemplate paramId='bmorsch_tot' fileName='bmorsch_tot_##sampling##_##orbit##'>
+		<arguments>
+			<argument key='sampling' name='Sampling Time' type='float' default='60'/>
+			<argument key='orbit' name='Spacecraft Orbit' type='list' default='mex_xyz'>
+				<item key='mex_xyz' name='MEX'/>
+				<item key='mav_xyz_mso' name='MAVEN'/>
+				<item key='xyz_mgs_mso' name='MGS'/>
+			</argument>
+		</arguments>
+	</paramTemplate>
+</paramTemplateList>
 \ No newline at end of file
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<param xml:id="bmorsch_mso_##sampling##_##orbit##"> 
+  <get>
+	<amdaParam name='##orbit##'/>
+  </get>
+  <process description="bmorsch_mso(##sampling##, ##orbit##)">#morschhauser_bfield(#sampling_classic($##orbit##;##sampling##;5))</process>
+  <output/>
+</param>
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<param xml:id="bmorsch_tot_##sampling##_##orbit##"> 
+  <get>
+	<amdaParam name='##orbit##'/>
+  </get>
+  <process description="bmorsch_tot(##sampling##,##orbit##)">#morschhauser_bmag(#sampling_classic($##orbit##;##sampling##;5))</process>
+  <output/>
+</param>
@@ -35,7 +35,8 @@ Ext.define(&#39;amdaPlotObj.PlotParamObject&#39;, {
 	          {name: 'param-dim-1', type: 'string'},
 	          {name: 'param-dim-2', type: 'string'},
 	          {name: 'param-drawing-type', type: 'string'},
-	          {name: 'param-drawing-object', type: 'auto'}
+	          {name: 'param-drawing-object', type: 'auto'},
+	          {name: 'param-template-args', type: 'auto'}
     ],
  
     associations : [
@@ -173,22 +174,30 @@ Ext.define(&#39;amdaPlotObj.PlotParamObject&#39;, {
   	  				paramIndexes = '('+dim1+','+dim2+')';
   	  	}
  
+		var template_args = "";
+		if (this.get('param-template-args')) {
+			Ext.Object.each(this.get('param-template-args'), function (argKey, argValue) {
+				template_args += "_";
+				template_args += argValue;
+    		});
+		}
+		
 		switch (plotType)
 		{
 		case 'xyPlot' :
 			if (this.get('param-drawing-type') == 'orbit-serie')
 			{
 				var projection = amdaPlotObj.PlotObjectConfig.getValueByKey(amdaPlotObj.PlotObjectConfig.availableOrbitSerieProjections, this.get('param-drawing-object').get('serie-projection'));
-				info = this.get('param-id')+paramIndexes+', '+projection;
+				info = this.get('param-id')+template_args+paramIndexes+', '+projection;
 			}
 			else
-				info = this.get('param-id')+paramIndexes+' = f('+this.get('param-drawing-object').get('serie-xaxis-param')+', t)';
+				info = this.get('param-id')+template_args+paramIndexes+' = f('+this.get('param-drawing-object').get('serie-xaxis-param')+', t)';
 			break;
 		case 'instantPlot' :
-			info = this.get('param-id')+paramIndexes;
+			info = this.get('param-id')+template_args+paramIndexes;
 			break;
 		default :
-			info = this.get('param-id')+paramIndexes+' = f(t)';
+			info = this.get('param-id')+template_args+paramIndexes+' = f(t)';
 		}
  
 		info += ', '+type;
@@ -233,6 +242,13 @@ Ext.define(&#39;amdaPlotObj.PlotParamObject&#39;, {
     	if (this.get('param-drawing-object') != null)
     		paramValues['param-drawing-object'] = this.get('param-drawing-object').getJsonValues();
  
+    	if (this.get('param-template-args') != null) {
+    		paramValues['param-template-args'] = new Object();
+    		Ext.Object.each(this.get('param-template-args'), function (argKey, argValue) {
+    			paramValues['param-template-args'][argKey] = argValue;
+    		});
+    	}
+    	
     	return paramValues;
     }
 });
 \ No newline at end of file
@@ -13,6 +13,8 @@ Ext.define(&#39;amdaUI.ParamArgumentsUI&#39;, {
 	extend: 'Ext.container.Container',
 	alias: 'widget.paramArguments',
  
+	regexp_istemplate: /^template_(.*)/,
+	
 	onChange: null,
  
 	// -1 -> unknown, 0 -> scalar, 1 -> Tab1D, 2 -> Tab2D
@@ -51,10 +53,24 @@ Ext.define(&#39;amdaUI.ParamArgumentsUI&#39;, {
     			else
     			{
     				//Rebuild arguments selection
-    				me.rebuildArguments(result.data, uiScope);
-    				//Set current values
-    				if (crtArgsValues)
-    					me.setValues(crtArgsValues);
+    				me.rebuildArguments(result, uiScope);
+    				
+    				//Set values
+    				var argsValues = crtArgsValues;
+    				if (!argsValues)
+    					argsValues = {};
+    				if (result.template && result.template.arguments) {
+    					if (!argsValues['template_args'])
+    						argsValues['template_args'] = {};
+    					//Add default template args definition if needed
+    					Ext.Object.each(result.template.arguments, function (argKey, argDef) {
+    						if (!argsValues['template_args'][argKey])
+    							argsValues['template_args'][argKey] = argDef['default'];
+    					}, me);
+    				}
+    				me.setValues(argsValues);
+    				
+    				//Set default values
     				if (onReady)
     					onReady(uiScope);
     			}
@@ -69,7 +85,12 @@ Ext.define(&#39;amdaUI.ParamArgumentsUI&#39;, {
  
     setValues: function(values) {
     	this.items.each(function (item) {
-    		if (values[item.getId()])
+    		if (this.regexp_istemplate.test(item.getId())) {
+    			var arg_key = this.regexp_istemplate.exec(item.getId())[1];
+    			if (values['template_args'] && values['template_args'][arg_key])
+    				item.setValue(values['template_args'][arg_key]);
+    		}
+    		else if (values[item.getId()])
     			item.setValue(values[item.getId()]);
     	}, this);
     },
@@ -77,8 +98,17 @@ Ext.define(&#39;amdaUI.ParamArgumentsUI&#39;, {
     getValues: function() {
     	var values = {type : this.paramType};
     	this.items.each(function(item) {
-    		values[item.getId()] = item.getValue();
-    	});
+    		if (item.getId() == 'no-arg')
+    			return;
+    		if (this.regexp_istemplate.test(item.getId())) {
+    			var arg_key = this.regexp_istemplate.exec(item.getId())[1];
+    			if (!values['template_args'])
+    				values['template_args'] = {};
+    			values['template_args'][arg_key] = item.getValue();
+    		}
+    		else
+    			values[item.getId()] = item.getValue();
+    	}, this);
  
     	return values;
     },
@@ -92,26 +122,30 @@ Ext.define(&#39;amdaUI.ParamArgumentsUI&#39;, {
     resetArguments: function(noArgsMsg) {
     	this.removeAll();
     	if (!noArgsMsg)
-    		this.add(new Ext.form.Label({text: 'No arguments for this parameter'}));
+    		this.add(new Ext.form.Label({text: 'No argument for this parameter', id: 'no-arg'}));
     },
  
-    rebuildArguments: function(data, uiScope) {
+    rebuildArguments: function(result, uiScope) {
     	this.resetArguments(true);
  
     	this.paramType = -1;
-    	if (data && data.dimensions) {
+    	if (result.data && result.data.dimensions) {
     		this.paramType = 0;
-    		if (data.dimensions.dim_1 && (parseInt(data.dimensions.dim_1) > 1)) {
-    			this.buildDimIndexSelection("dim_1", data, uiScope);
+    		if (result.data.dimensions.dim_1 && (parseInt(result.data.dimensions.dim_1) > 1)) {
+    			this.buildDimIndexSelection("dim_1", result.data, uiScope);
     			++this.paramType;
     		}
-    		if (data.dimensions.dim_2 && (parseInt(data.dimensions.dim_2) > 1)) {
-    			this.buildDimIndexSelection("dim_2", data, uiScope);
+    		if (result.data.dimensions.dim_2 && (parseInt(result.data.dimensions.dim_2) > 1)) {
+    			this.buildDimIndexSelection("dim_2", result.data, uiScope);
     			++this.paramType;
     		}
     	}
  
-    	if (this.paramType <= 0)
+    	var isTemplate = (result.template && result.template.arguments);
+    	if (isTemplate)
+    		this.buildTemplateArguments(result.template.arguments, uiScope);
+    	
+    	if ((this.paramType <= 0) && !isTemplate)
     		//Add no args message
     		this.resetArguments(false);
     },
@@ -174,7 +208,7 @@ Ext.define(&#39;amdaUI.ParamArgumentsUI&#39;, {
 		    listeners: {
             	change: function(field, newValue, oldValue, eOpts) {
             		if (this.onChange != null)
-            			this.onChange(uiScope, relatedDim, newValue, oldValue);
+            			this.onChange(uiScope, relatedDim, newValue, oldValue, false);
             	},
             	scope: this
             }
@@ -184,5 +218,65 @@ Ext.define(&#39;amdaUI.ParamArgumentsUI&#39;, {
 		this.add(indexesCombo);
  
 		return indexesCombo;
+    },
+    
+    buildTemplateArguments: function(arguments, uiScope) {
+    	var me = this;
+    	Ext.Object.each(arguments, function (key, argument) {
+    		switch (argument.type) {
+    		case 'float' :
+    			var argumentField = Ext.create('Ext.form.NumberField', {
+    				id: 'template_' + key,
+    				fieldLabel: argument.name,
+    				decimalPrecision : 3,
+    				allowBlank       : false,
+    				value: parseFloat(argument.default),
+    				listeners: {
+    					change: function(field, newValue, oldValue, eOpts) {
+    						if (me.onChange != null)
+    							me.onChange(uiScope, key, newValue, oldValue, true);
+    					},
+    					scope: me
+    				}
+                });
+    			
+    			me.add(argumentField);  
+    			break;
+    		case 'list' :
+    			var items = [];
+    			Ext.Object.each(argument.items, function (itemKey, itemName) {
+    				items.push({'key' : itemKey, 'value' : itemName});
+    			});
+    			
+    			var itemsStore = Ext.create('Ext.data.Store', {
+    			    fields: ['key', 'value'],
+    			    data : items
+    			});
+    			
+    			var itemsCombo = Ext.create('Ext.form.ComboBox', {
+    			    fieldLabel: argument.name,
+    			    store: itemsStore,
+    			    queryMode: 'local',
+    			    displayField: 'value',
+    			    valueField: 'key',
+    			    value: argument.default,
+    			    editable: false,
+    			    id: 'template_' + key,
+    			    listeners: {
+    	            	change: function(field, newValue, oldValue, eOpts) {
+    	            		if (me.onChange != null)
+    	            			me.onChange(uiScope, key, newValue, oldValue, true);
+    	            	},
+    	            	scope: me
+    	            }
+    			    
+    			});
+    			
+    			me.add(itemsCombo);    			
+    			break;
+    		default:
+    			console.log('Template argument type not yet implemented: '+argument.type);	
+    		}
+    	});
     }
 });
 \ No newline at end of file
@@ -103,17 +103,29 @@ Ext.define(&#39;amdaPlotComp.PlotParamForm&#39;, {
 			drawingOptionsForm.setObject(this.object);
  
 		if (this.paramArgs && paramId)
-			this.paramArgs.editParameter(paramId, {'dim_1' : this.object.get('param-dim-1'), 'dim_2' : this.object.get('param-dim-2')}, this, function (uiScope) {
+			this.paramArgs.editParameter(paramId, {'dim_1' : this.object.get('param-dim-1'), 'dim_2' : this.object.get('param-dim-2'), 'template_args' : this.object.get('param-template-args')}, this, function (uiScope) {
 				uiScope.object.set('param-type', uiScope.paramArgs.paramType);
+				var crtValues = uiScope.paramArgs.getValues();
+				if (crtValues && crtValues['template_args'])
+					uiScope.object.set('param-template-args', crtValues['template_args']);
 				uiScope.crtTree.refresh();
 			});
 	},
  
-	onChangeParamArgs: function(uiScope, args_key, newValue, oldValue) {
-		if (args_key == 'dim_1')
-			uiScope.object.set('param-dim-1', newValue);
-		else if (args_key == 'dim_2')
-			uiScope.object.set('param-dim-2', newValue);
+	onChangeParamArgs: function(uiScope, args_key, newValue, oldValue, isTemplateArg) {
+		if (!isTemplateArg) {
+			if (args_key == 'dim_1')
+				uiScope.object.set('param-dim-1', newValue);
+			else if (args_key == 'dim_2')
+				uiScope.object.set('param-dim-2', newValue);
+		}
+		else {
+			var templateArgs = uiScope.object.get('param-template-args');
+			if (!templateArgs)
+				templateArgs = {};
+			templateArgs[args_key] = newValue;
+			uiScope.object.set('param-template-args', templateArgs);
+		}
 		uiScope.crtTree.refresh();
 	},