Print

---

Author: [log in to unmask]
Date: Fri Jan 16 15:56:32 2015
New Revision: 1946

Log:
Add class for modeling beam conditions.

Added:
    java/trunk/conditions/src/main/java/org/hps/conditions/beam/BeamConditions.java

Added: java/trunk/conditions/src/main/java/org/hps/conditions/beam/BeamConditions.java
 =============================================================================
--- java/trunk/conditions/src/main/java/org/hps/conditions/beam/BeamConditions.java	(added)
+++ java/trunk/conditions/src/main/java/org/hps/conditions/beam/BeamConditions.java	Fri Jan 16 15:56:32 2015
@@ -0,0 +1,67 @@
+package org.hps.conditions.beam;
+
+import org.hps.conditions.api.AbstractConditionsObject;
+import org.hps.conditions.api.AbstractConditionsObjectCollection;
+import org.hps.conditions.database.Converter;
+import org.hps.conditions.database.MultipleCollectionsAction;
+import org.hps.conditions.database.Table;
+
+/**
+ * <p>
+ * Beam-related detector conditions, including current, position
+ * in X and Y, and energy.
+ * <p>  
+ * Unless otherwise stated, these are assumed to be average values 
+ * for an entire run.
+ * 
+ * @author Jeremy McCormick <[log in to unmask]>
+ */
+@Table(names = {"beam"})
+@Converter(multipleCollectionsAction = MultipleCollectionsAction.ERROR)
+public final class BeamConditions extends AbstractConditionsObject {
+    
+    /**
+     * Collection implementation for this class.
+     */
+    public final static class BeamConditionsCollection extends AbstractConditionsObjectCollection<BeamConditions> {
+    }
+    
+    public BeamConditions() {
+    }
+    
+    /**
+     * Get the average beam current (nA).
+     * A value of 0 indicates there was no beam.
+     * A null value means it was not recorded.
+     * @return The beam current (nA).
+     */
+    public Double getCurrent() {
+        return getFieldValue("current");
+    }
+    
+    /**
+     * Get the average beam position in X (mm).
+     * @return The beam position (mm).
+     */
+    public Double getPositionX() {
+        return getFieldValue("position_x");
+    }
+    
+    /**
+     * Get the average beam position in Y (mm).
+     * @return The beam position (mm).
+     */
+    public Double getPositionY() {
+        return getFieldValue("position_y");
+    }
+    
+    /**
+     * Get the beam energy (GeV).
+     * A value of 0 indicates there was no beam.
+     * A null value means it was not recorded.
+     * @return The beam energy.
+     */
+    public Double getEnergy() {
+        return getFieldValue("energy");
+    }        
+}