Author: [log in to unmask]
Date: Mon Nov 17 13:30:12 2014
New Revision: 1538
Log:
Move LCSimEventBuilder interface definition to record-util from evio so that record-util does not depend on evio module.
Added:
java/trunk/record-util/src/main/java/org/hps/record/LCSimEventBuilder.java
- copied, changed from r1522, java/trunk/evio/src/main/java/org/hps/evio/LCSimEventBuilder.java
Removed:
java/trunk/evio/src/main/java/org/hps/evio/LCSimEventBuilder.java
Copied: java/trunk/record-util/src/main/java/org/hps/record/LCSimEventBuilder.java (from r1522, java/trunk/evio/src/main/java/org/hps/evio/LCSimEventBuilder.java)
=============================================================================
--- java/trunk/evio/src/main/java/org/hps/evio/LCSimEventBuilder.java (original)
+++ java/trunk/record-util/src/main/java/org/hps/record/LCSimEventBuilder.java Mon Nov 17 13:30:12 2014
@@ -1,29 +1,33 @@
-package org.hps.evio;
+package org.hps.record;
import org.jlab.coda.jevio.EvioEvent;
import org.lcsim.conditions.ConditionsListener;
import org.lcsim.event.EventHeader;
+/**
+ * This is an interface that should be implemented by classes that
+ * build LCSim events from EVIO raw data.
+ * @author Jeremy McCormick <[log in to unmask]>
+ */
public interface LCSimEventBuilder extends ConditionsListener {
/**
- * Read any run information out of an EVIO event (not necessarily a physics event).
- * @param evioEvent
+ * Read information from an EVIO event to set the event builder's state.
+ * This does not actually build an LCSim event.
+ * @param evioEvent The input EvioEvent.
*/
void readEvioEvent(EvioEvent evioEvent);
/**
- * Make the LCSim event.
- * @param evioEvent - must be a physics event
- * @return LCSim event
+ * Build the LCSim event from EVIO data.
+ * @param evioEvent The input EvioEvent.
+ * @return The LCSim event.
*/
EventHeader makeLCSimEvent(EvioEvent evioEvent);
- // FIXME: Why is this needed here when checking the header tag is a static operation on the EvioEvent?
- boolean isPhysicsEvent(EvioEvent evioEvent);
-
- // FIXME: This should not be a method on the API. It should come from the conditions system.
+ /**
+ * Set the detector to be used for LCSim conditions.
+ * @param detectorName The detector name.
+ */
void setDetectorName(String detectorName);
-
- void setDebug(boolean debug);
}
|