Print

---

Author: [log in to unmask]
Date: Wed Mar 25 13:18:03 2015
New Revision: 2545

Log:
Add method documentation.

Modified:
    java/branches/monitoring-app-dev/src/main/java/org/hps/monitoring/application/EventProcessing.java

Modified: java/branches/monitoring-app-dev/src/main/java/org/hps/monitoring/application/EventProcessing.java
 =============================================================================
--- java/branches/monitoring-app-dev/src/main/java/org/hps/monitoring/application/EventProcessing.java	(original)
+++ java/branches/monitoring-app-dev/src/main/java/org/hps/monitoring/application/EventProcessing.java	Wed Mar 25 13:18:03 2015
@@ -545,12 +545,20 @@
         }
     }       
     
+    /**
+     * Create the select array from event selection in ET stations.
+     * @return The select array.
+     */
     static int[] createSelectArray() {
         int select[] = new int[EtConstants.stationSelectInts];
         Arrays.fill(select, -1);
         return select;   
     }    
      
+    /**
+     * Create a station that listens for physics sync events
+     * containing DAQ configuration.
+     */
     void createSyncStation() {
         
         // Sync events have bits 6 and 7 set.
@@ -567,6 +575,10 @@
                 select);
     }                                                                                                                                                                                                                                                                               
     
+    /**
+     * Create a station that listens for PRESTART events
+     * to initialize the conditions system.
+     */
     void createPreStartStation() {
                 
         // Select only PRESTART events.
@@ -580,6 +592,9 @@
                 select);
     }
     
+    /**
+     * Create a station that listens for EPICS control events (currently not activated).     
+     */
     void createEpicsStation() {
         
         // Select only EPICS events.
@@ -593,18 +608,25 @@
                 select);
     }
     
-    void createStationThread(EtEventProcessor processor, String nameAppend, int stationPosition, int[] control) {
+    /**
+     * Create an ET station thread.
+     * @param processor The event processor to run on the thread.
+     * @param nameAppend The string to append for naming this station.
+     * @param stationPosition The position of the station.
+     * @param select The event selection data array.
+     */
+    void createStationThread(EtEventProcessor processor, String nameAppend, int stationPosition, int[] select) {
         EtStationThread stationThread = new EtStationThread(
                 processor,
                 sessionState.connection.getEtSystem(),
                 sessionState.connection.getEtStation().getName() + "_" + nameAppend,
                 stationPosition,
-                control);
+                select);
         new Thread(sessionState.stationThreadGroup, stationThread).start();
         sessionState.stations.add(stationThread);
         logger.config("started ET station " + nameAppend);
         StringBuffer sb = new StringBuffer();
-        for (int word : control) {
+        for (int word : select) {
             sb.append(word + " ");
         }
         logger.config("station has select array: " + sb.toString());
@@ -652,6 +674,9 @@
         }
     }
     
+    /**
+     * Invalidate all 
+     */
     void invalidate() {
 
         application = null;