VtxTrackRef.h

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
 
 
#ifndef O2_VERTEX_TRACK_REF
#define O2_VERTEX_TRACK_REF
 
#include "CommonDataFormat/RangeReference.h"
#include "ReconstructionDataFormats/VtxTrackIndex.h"
#include <cassert>
#include <array>
#include <iosfwd>
#include <string>
 
namespace o2
{
namespace dataformats
{
 
/* Class to refer in start and number of contributors in the container of with consecutively filled conributors.
     The contributors are suppossed to be sorted according to their sources.
     Note: the only way to fill the references is to fill them all in increasing order and set the end!
     VtxTrackIndex ref;
     for (int i=0;i<VtxTrackIndex::Source::NSources;i++) {
       ref.setFirstEntryOfSource(i, idxI); // idxI must be >= idxI-1 (if it is =, then source i has not entries
     }
     ref.setEnd(idxLast + 1); // i.e. idxLast+1 = idx0 + TotalNumberOfEntries
  */
 
class VtxTrackRef : public RangeReference<int, int>
{
 public:
  VtxTrackRef() : RangeReference(-1, 0)
  {
    for (int i = VtxTrackIndex::Source::NSources - 1; i--;) {
      mFirstEntrySource[i] = -1; // only 1st source (base reference) is filled at constructor level
    }
  }
 
  void print(bool skipEmpty = true) const;
  std::string asString(bool skipEmpty = true) const;
 
  // get 1st of entry of indices for given source
  int getFirstEntryOfSource(int s) const
  {
    assert(s >= 0 && s < VtxTrackIndex::NSources);
    return s ? mFirstEntrySource[s - 1] : getFirstEntry();
  }
 
  // get number of entries for given source
  int getEntriesOfSource(int s) const
  {
    return (s == VtxTrackIndex::NSources - 1 ? (getFirstEntry() + getEntries()) : getFirstEntryOfSource(s + 1)) - getFirstEntryOfSource(s);
  }
 
  void setFirstEntryOfSource(int s, int i)
  {
    assert(s >= 0 && s < VtxTrackIndex::NSources);
    if (s) {
      mFirstEntrySource[s - 1] = i;
    } else {
      setFirstEntry(i);
    }
  }
 
  void setVtxID(int i) { mVtxID = i; }
  int getVtxID() const { return mVtxID; }
 
  // set the last +1 element index and finalize all references
  void setEnd(int end);
 
 private:
  using RangeReference<int, int>::RangeReference;
  int mVtxID = -1; // vertex ID. The reference for unassigned tracks will have it negative!
  std::array<int, VtxTrackIndex::Source::NSources - 1> mFirstEntrySource{0};
 
  ClassDefNV(VtxTrackRef, 2);
};
 
std::ostream& operator<<(std::ostream& os, const o2::dataformats::VtxTrackRef& v);
 
} // namespace dataformats
} // namespace o2
 
#endif