lcsim/src/org/lcsim/contrib/uiowa/hitmap

diff -u -r1.1 -r1.2
--- HitMap.java	6 Feb 2006 19:21:27 -0000	1.1
+++ HitMap.java	8 Feb 2006 19:02:56 -0000	1.2
@@ -4,15 +4,30 @@

 import java.util.HashMap;
 import org.lcsim.event.CalorimeterHit;
 

+/**
+  * Conventional representation of a collection of CalorimeterHits.
+  * Each entry represents one hit and maps from its CellID
+  * to the hit itself.
+  */
+

 public class HitMap extends HashMap<Long,CalorimeterHit>
 {

+    /** Constructor */

     public HitMap() {
 	super();
     }

+
+    /** Copy constructor. The name of the new HitMap is copied from the name of the old HitMap. */

     public HitMap(HitMap map) {
 	super(map);
     }

+
+    /** Copy constructor that is backwards-compatible with a generic Map<Long,CalorimeterHit> */

     public HitMap(Map<Long,CalorimeterHit> map) {
 	super(map);
     }

+
+    // Here we could add getName() and setName() methods. But I think these
+    // might be redundant with the event meta-information when the HitMap is
+    // stored in the Event object, so perhaps we should not use them.

 }