From cbef08682a74cc157ae84a89e4cc42ddca78b598 Mon Sep 17 00:00:00 2001
From: Simon Ebner <simon.ebner@psi.ch>
Date: Thu, 29 Aug 2013 08:11:35 +0200
Subject: [PATCH] Added comments and modified some test

---
 .../ch/psi/fda/aq/ng/AcquisitionEngineNG.java   | 17 ++++++++++++++++-
 .../java/ch/psi/fda/aq/ng/ScanMapperNG.java     |  4 ++--
 .../fda/aq/ng/rdescriptors/ProbeDescriptor.java |  1 +
 .../java/ch/psi/fda/aq/ng/ScanMapperNGTest.java |  2 +-
 4 files changed, 20 insertions(+), 4 deletions(-)

diff --git a/ch.psi.fda/src/main/java/ch/psi/fda/aq/ng/AcquisitionEngineNG.java b/ch.psi.fda/src/main/java/ch/psi/fda/aq/ng/AcquisitionEngineNG.java
index ebe7bf3..b196e08 100644
--- a/ch.psi.fda/src/main/java/ch/psi/fda/aq/ng/AcquisitionEngineNG.java
+++ b/ch.psi.fda/src/main/java/ch/psi/fda/aq/ng/AcquisitionEngineNG.java
@@ -61,6 +61,12 @@ public class AcquisitionEngineNG {
 		System.setProperty("python.options.internalTablesImpl", "weak");
 	}
 	
+	/**
+	 * Execute the specified script/logic while using the specified resources and paramters
+	 * @param resourceDescriptors
+	 * @param script
+	 * @param parameter
+	 */
 	public void execute(Map<String, ?> resourceDescriptors, String script, List<String> parameter){
 		
 		// TODO Remove debugging messages
@@ -94,6 +100,14 @@ public class AcquisitionEngineNG {
 		}	
 	}
 	
+	/**
+	 * Create resources based on the passed rDescriptors
+	 * Supported descriptor types are:
+	 * ChannelDescriptor, ShellDescriptor, ProbeDescriptor
+	 * 
+	 * @param resourceDescriptors
+	 * @return
+	 */
 	private Map<String,?> createResources(Map<String, ?> resourceDescriptors){
 		Map<String,Object> resources = new HashMap<>();
 		for(String k: resourceDescriptors.keySet()){
@@ -122,7 +136,8 @@ public class AcquisitionEngineNG {
 						throw new RuntimeException("Unable to create resource for channel: "+s.getName(),e);
 					}
 				}
-				resources.put(k, new ChannelProbeResource(channels, outQueue));
+				// TODO Remove workaround ...
+				resources.put(k, new ChannelProbeResource(channels, outQueue)); // Configure the probe to use the acquisitions out queue for writing data into
 //				engine.put(k, new ChannelProbeResource(channels, outQueue));
 			}
 			else{
diff --git a/ch.psi.fda/src/main/java/ch/psi/fda/aq/ng/ScanMapperNG.java b/ch.psi.fda/src/main/java/ch/psi/fda/aq/ng/ScanMapperNG.java
index 5fe21e8..aee0cd7 100644
--- a/ch.psi.fda/src/main/java/ch/psi/fda/aq/ng/ScanMapperNG.java
+++ b/ch.psi.fda/src/main/java/ch/psi/fda/aq/ng/ScanMapperNG.java
@@ -52,7 +52,7 @@ import ch.psi.jcae.util.ComparatorOR;
 import ch.psi.jcae.util.ComparatorREGEX;
 
 /**
- * @author ebner
+ * Mapper to transform a FDA v1 xml into the new internal model
  * 
  */
 public class ScanMapperNG {
@@ -177,7 +177,7 @@ public class ScanMapperNG {
 					// Use readback
 					probeDescriptor.getSensors().add(new ChannelDescriptor<>(type, positioner.getReadback(), false));
 				}
-				System.out.println(positioner.getId());
+//				System.out.println(positioner.getId());
 				dataMessageMetadata.getComponents().add(new ComponentMetadata(positioner.getId(), (dimensions.size()-1-index)));
 				
 				// TODO Done resource
diff --git a/ch.psi.fda/src/main/java/ch/psi/fda/aq/ng/rdescriptors/ProbeDescriptor.java b/ch.psi.fda/src/main/java/ch/psi/fda/aq/ng/rdescriptors/ProbeDescriptor.java
index 76a1f7b..d255f8e 100644
--- a/ch.psi.fda/src/main/java/ch/psi/fda/aq/ng/rdescriptors/ProbeDescriptor.java
+++ b/ch.psi.fda/src/main/java/ch/psi/fda/aq/ng/rdescriptors/ProbeDescriptor.java
@@ -30,6 +30,7 @@ import ch.psi.jcae.ChannelDescriptor;
 public class ProbeDescriptor {
 	
 	private List<ChannelDescriptor<?>> sensors = new ArrayList<>();
+	
 	public List<ChannelDescriptor<?>> getSensors(){
 		return sensors;
 	}
diff --git a/ch.psi.fda/src/test/java/ch/psi/fda/aq/ng/ScanMapperNGTest.java b/ch.psi.fda/src/test/java/ch/psi/fda/aq/ng/ScanMapperNGTest.java
index ec1e220..eddb080 100644
--- a/ch.psi.fda/src/test/java/ch/psi/fda/aq/ng/ScanMapperNGTest.java
+++ b/ch.psi.fda/src/test/java/ch/psi/fda/aq/ng/ScanMapperNGTest.java
@@ -121,7 +121,7 @@ public class ScanMapperNGTest {
 		positioner.setName(TestChannels.ANALOG_OUT);
 		positioner.setStart(0.1);
 		positioner.setEnd(2.2);
-		positioner.setStepSize(0.1);
+		positioner.setStepSize(0.000001);
 		
 		d.getPositioner().add(positioner);