Commit in lcsim/src/org/lcsim/event on MAIN
SimCalorimeterHit.java+16-11.3 -> 1.4
Add documentation to SimCalorimeterHit

lcsim/src/org/lcsim/event
SimCalorimeterHit.java 1.3 -> 1.4
diff -u -r1.3 -r1.4
--- SimCalorimeterHit.java	28 Jun 2006 04:48:30 -0000	1.3
+++ SimCalorimeterHit.java	6 Aug 2007 23:24:12 -0000	1.4
@@ -4,14 +4,29 @@
 
 /**
  * Represents one simulated "hit" in a calorimeter
- * @version $Id: SimCalorimeterHit.java,v 1.3 2006/06/28 04:48:30 jstrube Exp $
+ * @version $Id: SimCalorimeterHit.java,v 1.4 2007/08/06 23:24:12 tonyj Exp $
  */
 
 public interface SimCalorimeterHit extends CalorimeterHit
 {
+   /**
+    * Returns the number of MC contributions to the hit.
+    */
    int getMCParticleCount();
+   /**
+    * Returns the MCParticle that caused the shower responsible for this contribution to the hit.
+    */
    MCParticle getMCParticle(int index);
+   /**
+    * Returns the energy in [GeV] of the i-th contribution to the hit.
+    */
    double getContributedEnergy(int index);
+   /**
+    * Returns the time of the i-th in [ns] contribution to the hit.
+    */
    public double getContributedTime(int index);
+   /**
+    * Returns the PDG code of the shower particle that caused this contribution.
+    */
    public int getPDG(int index);
 }
CVSspam 0.2.8