AndroidGCS SmartSave: Begin implement a smart save architecture

This SmartSave class only associates with one UAVO.  However, you can instantiate multiple of these for the various objects.  Use addControlMapping to create new mappings between controls and UAVO fields.

androidgcs/src/org/openpilot/androidgcs/util/ObjectFieldMappable.java

@@ -0,0 +1,6 @@
+package org.openpilot.androidgcs.util;
+
+public interface ObjectFieldMappable {
+	public double getValue();
+	public void setValue(double val);
+}

androidgcs/src/org/openpilot/androidgcs/util/SmartSave.java

@@ -0,0 +1,250 @@
+/**
+ ******************************************************************************
+ * @file       SmartSave.java
+ * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2012.
+ * @brief      Provides a handler to provide robust apply and save for settings
+ *             and updating of the UI when the object changes.
+ * @see        The GNU Public License (GPL) Version 3
+ *
+ *****************************************************************************/
+/*
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+ * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+
+package org.openpilot.androidgcs.util;
+
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+import java.util.Observable;
+import java.util.Observer;
+import java.util.Set;
+
+import junit.framework.Assert;
+
+import org.openpilot.uavtalk.UAVObject;
+import org.openpilot.uavtalk.UAVObjectManager;
+
+import android.util.Log;
+import android.view.View;
+import android.view.View.OnClickListener;
+import android.widget.Button;
+
+public class SmartSave {
+
+	private final static String TAG = SmartSave.class.getSimpleName();
+
+	//! Create a smart save button attached to the object manager and an apply and ave button
+	public SmartSave(UAVObjectManager objMngr, UAVObject obj, Button saveButton, Button applyButton) {
+		Assert.assertNotNull(objMngr);
+		this.objMngr = objMngr;
+		this.applyBtn = applyButton;
+		this.obj = obj;
+
+		Assert.assertNotNull(objMngr);
+		Assert.assertNotNull(obj);
+
+		obj.addUpdatedObserver(ObjectUpdated);
+
+		controlFieldMapping = new HashMap<ObjectFieldMappable,FieldPairing>();
+
+		if (saveButton != null) {
+			saveBtn = saveButton;
+			saveBtn.setOnClickListener(new OnClickListener() {
+				@Override
+				public void onClick(View v) {
+					saveSettings();
+				}
+			});
+		} else
+			saveBtn = null;
+
+		if (applyButton != null) {
+			applyBtn = applyButton;
+			applyBtn.setOnClickListener(new OnClickListener() {
+				@Override
+				public void onClick(View v) {
+					applySettings();
+				}
+			});
+		} else
+			applyBtn = null;
+	}
+
+	//! Disconnect any listeners when this object is destroyed
+	public void disconnect() {
+		obj.removeUpdatedObserver(ObjectUpdated);
+	}
+
+	/**
+	 * Add a control to this SmartSave object which maps between a particular control
+	 * and a UAVO field.
+	 * @param control The control to associate with
+	 * @param fieldName The name of the UAVO field
+	 * @param fieldIndex The index of the UAVO field
+	 */
+	public void addControlMapping(ObjectFieldMappable control, String fieldName, int fieldIndex) {
+		FieldPairing pairing = new FieldPairing(fieldName, fieldIndex);
+		controlFieldMapping.put(control, pairing);
+	}
+
+	//! Update the settings in the UI from the mappings
+	public void refreshSettingsDisplay() {
+		Set<ObjectFieldMappable> keys = controlFieldMapping.keySet();
+		Iterator<ObjectFieldMappable> iter = keys.iterator();
+		while(iter.hasNext()) {
+			ObjectFieldMappable mappable = iter.next();
+			FieldPairing field = controlFieldMapping.get(mappable);
+			mappable.setValue(field.getValue(obj));
+		}
+	}
+
+	/**
+	 * Call applySettings() and then save them
+	 * @return True if the save succeeded or false otherwise
+	 */
+	private boolean saveSettings() {
+		/*
+		 * 1. Update object
+		 * 2. Install listener on object persistence
+		 * 3. Send save operation
+		 * 4. Wait for completed
+		 * 5. Remove listener
+		 */
+
+		// 1. Update object
+		if(!applySettings())
+			return false;
+
+		UAVObject persistence = objMngr.getObject("ObjectPersistence");
+		Assert.assertNotNull(persistence);
+
+		// 2. Install listener
+		persistence.addUpdatedObserver(ObjectPersistenceUpdated);
+
+		// 3. Send save operation
+		obj.getField("ObjectID").setValue(obj.getObjID());
+		obj.getField("Operation").setValue("Save");
+		obj.getField("Selection").setValue("SingleObject");
+		obj.updated();
+
+		return true;
+	}
+
+	/**
+	 * Robustly apply the settings to the UAV
+	 * @return True if the apply is ack'd, False if not
+	 */
+	private boolean applySettings() {
+		/*
+		 * 1. Set the values from the fields into the object
+		 * 2. Install the listener on the object
+		 * 3. Update object
+		 * 4. Wait for the acknowledgment or timeout
+		 * 5. Uninstall the listener
+		 */
+
+		// 1. Set the fields in the object from the UI
+		Set<ObjectFieldMappable> keys = controlFieldMapping.keySet();
+		Iterator<ObjectFieldMappable> iter = keys.iterator();
+		while(iter.hasNext()) {
+			ObjectFieldMappable mappable = iter.next();
+			FieldPairing field = controlFieldMapping.get(mappable);
+			field.setValue(obj,mappable.getValue());
+		}
+
+		// 2. Install the listener on the object
+		obj.addTransactionCompleted(ApplyCompleted);
+
+		// 3. Update the object
+		obj.updated();
+
+		// 4. Wait for acknowledgment
+		// TODO: Set up some semaphore with timeout
+		// sem.wait(1000);
+
+		// 5. Uninstall the listener
+		//obj.removeTransactionCompleted(ApplyCompleted);
+
+		return true;
+	}
+
+	//! Private class to store the field mapping information
+	private class FieldPairing {
+		FieldPairing(String fieldName, int fieldIndex) {
+			this.fieldName = fieldName;
+			this.fieldIndex = fieldIndex;
+		}
+
+		//! Update the field in the UAVO
+		void setValue(UAVObject obj, double value) {
+			Assert.assertNotNull(obj);
+			obj.getField(fieldName).setDouble(value,fieldIndex);
+		}
+
+		//! Get the value from the UAVO field
+		double getValue(UAVObject obj) {
+			return obj.getField(fieldName).getDouble(fieldIndex);
+		}
+
+		//! Cache the name of the field
+		private final String fieldName;
+
+		//! Cache the field index
+		private final int fieldIndex;
+	}
+
+	//! Installed on monitored object to know when an object is updated
+	private final Observer ApplyCompleted = new Observer() {
+		@Override
+		public void update(Observable observable, Object data) {
+			Log.d(TAG, "Apply called");
+		}
+	};
+
+	//! Installed on monitored object to know when an object is updated
+	private final Observer ObjectUpdated = new Observer() {
+		@Override
+		public void update(Observable observable, Object data) {
+			Log.d(TAG, "Object updated");
+			refreshSettingsDisplay();
+		}
+	};
+
+	//! Installed on object persistence to know when save completes
+	private final Observer ObjectPersistenceUpdated = new Observer() {
+		@Override
+		public void update(Observable observable, Object data) {
+			Log.d(TAG, "Object persistence updated");
+		}
+	};
+
+	//! Map of all the UAVO field <-> control mappings.  The key is the control.
+	private final Map<ObjectFieldMappable,FieldPairing> controlFieldMapping;
+
+	//! Handle to the object manager
+	private final UAVObjectManager objMngr;
+
+	//! Handle to the apply button
+	private Button applyBtn;
+
+	//! Handle to the save button
+	private Button saveBtn;
+
+	//! Handle to the UAVO this class works with
+	private final UAVObject obj;
+
+
+}

androidgcs/src/org/openpilot/androidgcs/views/ScrollBarView.java

@@ -1,6 +1,7 @@
 package org.openpilot.androidgcs.views;
 
 import org.openpilot.androidgcs.R;
+import org.openpilot.androidgcs.util.ObjectFieldMappable;
 
 import android.content.Context;
 import android.content.res.TypedArray;
@@ -12,7 +13,7 @@ import android.widget.LinearLayout;
 import android.widget.SeekBar;
 import android.widget.TextView;
 
-public class ScrollBarView extends GridLayout {
+public class ScrollBarView extends GridLayout implements ObjectFieldMappable {
 
 	private final static String TAG = ScrollBarView.class.getSimpleName();
 
@@ -49,13 +50,6 @@ public class ScrollBarView extends GridLayout {
 		setValue(0.0035);
 	}
 
-	public void setValue(double val)
-	{
-		value = val;
-		edit.setText(Double.toString(value));
-		bar.setProgress((int) (SCALE * value));
-	}
-
 	public void setName(String n)
 	{
 		name = n;
@@ -75,4 +69,16 @@ public class ScrollBarView extends GridLayout {
 		param = lbl.getLayoutParams();
 		param.width = getMeasuredWidth() / 2;
 	}
+
+	@Override
+	public double getValue() {
+		return value;
+	}
+
+	@Override
+	public void setValue(double val) {
+		value = val;
+		edit.setText(Double.toString(value));
+		bar.setProgress((int) (SCALE * value));
+	}
 }