TrackStateType.hpp

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file TrackStateType.hpp

// This file is part of the Acts project.
//
// Copyright (C) 2023 CERN for the benefit of the Acts project
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

#pragma once

#include <bitset>
#include <cassert>
#include <cstddef>
#include <cstdint>
#include <limits>
#include <ostream>

namespace Acts {

enum TrackStateFlag {
  MeasurementFlag = 0,
  ParameterFlag = 1,
  OutlierFlag = 2,
  HoleFlag = 3,
  MaterialFlag = 4,
  SharedHitFlag = 5,
  NumTrackStateFlags = 6
};

class ConstTrackStateType;

class TrackStateType {
 public:
  using raw_type = std::uint64_t;
  static constexpr std::size_t kRawBits =
      std::numeric_limits<std::make_unsigned<raw_type>::type>::digits;
  TrackStateType(raw_type& raw) : m_raw{&raw} {}

  TrackStateType& operator=(const TrackStateType& other) {
    assert(other.m_raw != nullptr);
    *m_raw = *other.m_raw;
    return *this;
  }

  TrackStateType& operator=(const ConstTrackStateType& other);

  operator ConstTrackStateType();

  bool test(std::size_t pos) const {
    assert(m_raw != nullptr);
    std::bitset<kRawBits> bs{*m_raw};
    return bs.test(pos);
  }

  void set(std::size_t pos, bool value = true) {
    assert(m_raw != nullptr);
    std::bitset<kRawBits> bs{*m_raw};
    bs.set(pos, value);
    *m_raw = bs.to_ullong();
  }

  void reset(std::size_t pos) { set(pos, false); }

 private:
  raw_type* m_raw{nullptr};
};

class ConstTrackStateType {
 public:
  using raw_type = std::uint64_t;
  static constexpr std::size_t kRawBits =
      std::numeric_limits<std::make_unsigned<raw_type>::type>::digits;

  ConstTrackStateType(const raw_type& raw) : m_raw{&raw} {}

  bool test(std::size_t pos) const {
    assert(m_raw != nullptr);
    std::bitset<kRawBits> bs{*m_raw};
    return bs.test(pos);
  }

  friend std::ostream& operator<<(std::ostream& os, ConstTrackStateType t) {
    assert(t.m_raw != nullptr);
    std::bitset<kRawBits> bs{*t.m_raw};
    std::bitset<TrackStateFlag::NumTrackStateFlags> trunc;
    for (size_t i = 0; i < TrackStateFlag::NumTrackStateFlags; i++) {
      trunc[i] = bs[i];
    }
    // MeasurementParameterOutlierHoleMaterialSharedhit
    os << "MPOHMS=" << trunc;
    return os;
  }

 private:
  friend class TrackStateType;
  const raw_type* m_raw{nullptr};
};

inline TrackStateType& TrackStateType::operator=(
    const ConstTrackStateType& other) {
  assert(other.m_raw != nullptr);
  *m_raw = *other.m_raw;
  return *this;
}
inline TrackStateType::operator ConstTrackStateType() {
  return {*m_raw};
}

}  // namespace Acts