Rename EndOfEvent

Author: EinarElen

include/SimCore/SDs/EcalSD.h

@@ -74,9 +74,7 @@ class EcalSD : public SensitiveDetector {
   /**
    * Clear the map of hits we have accumulated
    */
-  virtual void EndOfEvent() final override {
-    hits_.clear();
-  }
+  virtual void OnFinishedEvent() final override { hits_.clear(); }
 
  private:
   /// map of hits to add to the event (will be squashed)

include/SimCore/SDs/HcalSD.h

@@ -87,8 +87,8 @@ class HcalSD : public SensitiveDetector {
     event.add(COLLECTION_NAME, hits_);
   }
 
-  virtual void EndOfEvent() final override { hits_.clear(); }
-  
+  virtual void OnFinishedEvent() final override { hits_.clear(); }
+
  private:
   // A list of identifiers used to find out whether or not a given logical
   // volume is one of the Hcal sensitive detector volumes. Any volume that is

include/SimCore/SDs/ScoringPlaneSD.h

@@ -51,9 +51,7 @@ class ScoringPlaneSD : public SensitiveDetector {
    */
   virtual void saveHits(framework::Event& event) final override;
 
-  virtual void EndOfEvent() final override {
-    hits_.clear();
-  }
+  virtual void OnFinishedEvent() final override { hits_.clear(); }
 
  private:
   /// Substring to match to logical volumes

include/SimCore/SDs/TrackerSD.h

@@ -51,9 +51,7 @@ class TrackerSD : public SensitiveDetector {
     event.add(collection_name_, hits_);
   }
 
-  virtual void EndOfEvent() final override {
-    hits_.clear();
-  }
+  virtual void OnFinishedEvent() final override { hits_.clear(); }
 
  private:
   /// The name of the subsystem we are apart of

include/SimCore/SDs/TrigScintSD.h

@@ -54,9 +54,7 @@ class TrigScintSD : public SensitiveDetector {
     event.add(collection_name_, hits_);
   }
 
-  virtual void EndOfEvent() final override {
-    hits_.clear();
-  }
+  virtual void OnFinishedEvent() final override { hits_.clear(); }
 
  private:
   /// our collection of hits in this SD

include/SimCore/SensitiveDetector.h

@@ -87,20 +87,23 @@ class SensitiveDetector : public G4VSensitiveDetector {
    * the input to this function is of no use to us. This is simply
    * here to make sure that we can reset the SD to a new-event state
    * whether or not a given event was serialized.
+   *
+   * @note: If you are looking for the callback that is used in LDMX-sw when a
+   * Simulator event finishes, you want `OnFinishedEvent`
    */
   virtual void EndOfEvent(G4HCofThisEvent*) override {}
 
   /**
-   * Cleanup SD and prepare a new-event state
+   * Cleanup SD and prepare a new-event state.
    */
-  virtual void EndOfEvent() = 0;
+  virtual void OnFinishedEvent() = 0;
 
   /**
    * Record the configuration of this detector into the run header.
    *
    * @param[in,out] header RunHeader to write configuration to
    */
-  //virtual void RecordConfig(ldmx::RunHeader& header) const = 0;
+  // virtual void RecordConfig(ldmx::RunHeader& header) const = 0;
 
  protected:
   /**

src/SimCore/ReSimulator.cxx

@@ -47,7 +47,8 @@ void ReSimulator::produce(framework::Event& event) {
   }
   if (runManager_->GetCurrentEvent()->IsAborted()) {
     runManager_->TerminateOneEvent();
-    SensitiveDetector::Factory::get().apply([](auto sd) { sd->EndOfEvent(); });
+    SensitiveDetector::Factory::get().apply(
+        [](auto sd) { sd->OnFinishedEvent(); });
     EXCEPTION_RAISE(
         "ReSimAbortedEvent",
         "Resimulation resulted in an aborted event, something is wrong with "

src/SimCore/Simulator.cxx

@@ -142,7 +142,8 @@ void Simulator::produce(framework::Event& event) {
   // the next event.
   if (runManager_->GetCurrentEvent()->IsAborted()) {
     runManager_->TerminateOneEvent();  // clean up event objects
-    SensitiveDetector::Factory::get().apply([](auto sd) { sd->EndOfEvent(); });
+    SensitiveDetector::Factory::get().apply(
+        [](auto sd) { sd->OnFinishedEvent(); });
     this->abortEvent();  // get out of processors loop
   }
 

src/SimCore/SimulatorBase.cxx

@@ -169,7 +169,7 @@ void SimulatorBase::saveSDHits(framework::Event& event) {
   // Copy hit objects from SD hit collections into the output event.
   SensitiveDetector::Factory::get().apply([&event](auto sd) {
     sd->saveHits(event);
-    sd->EndOfEvent();
+    sd->OnFinishedEvent();
   });
 }