CbmMCEventList.h

Go to the documentation of this file.

/* Copyright (C) 2015-2020 GSI Helmholtzzentrum fuer Schwerionenforschung, Darmstadt
   SPDX-License-Identifier: GPL-3.0-only
   Authors: Volker Friese [committer] */
 
#ifndef CBMMCEVENTLIST_H
#define CBMMCEVENTLIST_H 1
 
#include "CbmLink.h"
#include "CbmMCEventInfo.h"  // for CbmMCEventInfo
 
#include <Rtypes.h>  // for THashConsistencyHolder, ClassDef
#include <TNamed.h>  // for TNamed
 
#include <cstddef>  // for size_t
#include <cstdint>
#include <string>  // for string
#include <vector>  // for vector, vector<>::iterator
 
/* Implementation note (VF/180618):
 * Both indexed access (for loops over all MC events in a time slice)
 * and random access (to get the event time for a given fileId and EventId)
 * are required. It was thus chosen to internally represent the event list
 * as a sortable vector of CbmMCEventInfo. I tried to use std::tuple instead
 * of CbmMCEventInfo, but ROOT seems not to be able to stream that.
 * Since it is assumed that the creation of the list is separate from the
 * access to the list, no sorting or checking for double occurrences of events
 * is done on insertion for performance reasons.
 * Sorting will be done on first access to the list. It includes checking of
 * double occurrences of (fileId, eventId).
 */
 
class CbmMCEventList : public TNamed {
 
public:
  CbmMCEventList();
 
 
  virtual ~CbmMCEventList();
 
 
  virtual void Clear(Option_t*) { fEvents.clear(); }
 
 
  int32_t GetEventIdByIndex(uint32_t index);
 
 
  double GetEventTime(uint32_t event, uint32_t file);
 
  Double_t GetEventTime(const CbmLink& link) { return GetEventTime(link.GetEntry(), link.GetFile()); }
 
  double GetEventTimeByIndex(uint32_t index);
 
 
  int32_t GetFileIdByIndex(uint32_t index);
 
  Int_t GetEventIndex(UInt_t event, UInt_t file);
 
  Int_t GetEventIndex(const CbmLink& link) { return GetEventIndex(link.GetEntry(), link.GetFile()); }
 
 
  CbmLink GetEventLinkByIndex(uint32_t index);
 
  std::size_t GetNofEvents() const { return fEvents.size(); }
 
 
  bool Insert(uint32_t event, uint32_t file, double time);
 
 
  virtual void Print(Option_t* opt = "") const;
 
 
  void Sort();
 
 
  std::string ToString(const char* option = "") const;
 
 
private:
  std::vector<CbmMCEventInfo> fEvents;
 
  bool fIsSorted;
 
 
  bool Check();
 
 
  std::vector<CbmMCEventInfo>::iterator Find(uint32_t file, uint32_t event);
 
 
  ClassDef(CbmMCEventList, 3);
};
 
 
#endif /* CBMMCEVENTLIST_H */