Fields.h

Go to the documentation of this file.

// Copyright (C) 2022 ASTRON (Netherlands Institute for Radio Astronomy)
// SPDX-License-Identifier: GPL-3.0-or-later
 
#ifndef DP3_COMMON_FIELDS_H_
#define DP3_COMMON_FIELDS_H_
 
#include <bitset>
#include <iosfwd>
 
namespace dp3 {
namespace common {
 
class Fields {
 public:
  enum class Single {
    kData,     
    kFlags,    
    kWeights,  
    kUvw,      
    kCount     
  };
 
  constexpr Fields() : value_() {}
 
  constexpr explicit Fields(Single field)
      : value_(1 << static_cast<int>(field)) {}
 
  constexpr bool Data() const {
    return value_[static_cast<int>(Single::kData)];
  }
 
  constexpr bool Flags() const {
    return value_[static_cast<int>(Single::kFlags)];
  }
 
  constexpr bool Weights() const {
    return value_[static_cast<int>(Single::kWeights)];
  }
 
  constexpr bool Uvw() const { return value_[static_cast<int>(Single::kUvw)]; }
 
  Fields& operator|=(const Fields& other) {
    value_ |= other.value_;
    return *this;
  }
 
  Fields& UpdateRequirements(const Fields& required, const Fields& provided) {
    std::bitset<static_cast<int>(Single::kCount)> to_reset =
        provided.value_ & ~required.value_;
    value_ |= required.value_;
    value_ &= ~to_reset;
    return *this;
  }
 
  friend Fields operator|(const Fields& left, const Fields& right) {
    Fields fields(left);
    fields |= right;
    return fields;
  }
 
  friend bool operator==(const Fields& left, const Fields& right) {
    return left.value_ == right.value_;
  }
 
  friend bool operator!=(const Fields& left, const Fields& right) {
    return left.value_ != right.value_;
  }
 
  friend std::ostream& operator<<(std::ostream&, const Fields& fields);
 
 private:
  // Using a bitset instead of individual booleans simplifies adding more
  // fields in the future.
  std::bitset<static_cast<int>(Single::kCount)> value_;
};
 
}  // namespace common
}  // namespace dp3
 
#endif  // DP3_COMMON_FIELDS_H_