QwRootTreeBranchVector Class Reference

A helper class to manage a vector of branch entries for ROOT trees. More...

#include <QwRootFile.h>

Collaboration diagram for QwRootTreeBranchVector:

Data Structures
struct	Entry

Public Types
using	size_type = std::size_t

Public Member Functions
	QwRootTreeBranchVector ()=default
void	reserve (size_type count)
void	shrink_to_fit ()
void	clear ()
size_type	size () const noexcept
bool	empty () const noexcept
template<typename T = uint8_t>
const T &	operator[] (size_type index) const
template<typename T = uint8_t>
T &	operator[] (size_type index)
template<typename T>
T &	value (size_type index)
template<typename T>
const T &	value (size_type index) const
void	SetValue (size_type index, Double_t val)
void	SetValue (size_type index, Float_t val)
void	SetValue (size_type index, Int_t val)
void	SetValue (size_type index, Long64_t val)
void	SetValue (size_type index, Short_t val)
void	SetValue (size_type index, UShort_t val)
void	SetValue (size_type index, UInt_t val)
void	SetValue (size_type index, ULong64_t val)
void *	data () noexcept
const void *	data () const noexcept
size_type	data_size () const noexcept
template<typename T>
T &	back ()
template<typename T>
const T &	back () const
void	push_back (const std::string &name, const char type='D')
void	push_back (const TString &name, const char type='D')
void	push_back (const char *name, const char type='D')
std::string	LeafList (size_type start_index=0) const
std::string	Dump (size_type start_index=0, size_type end_index=0) const

Private Member Functions
std::string	FormatValue (const Entry &entry, size_type index) const

Static Private Member Functions
static std::size_t	GetTypeSize (char type)
static std::size_t	AlignOffset (std::size_t offset)
template<typename T>
static std::string	FormatNumeric (T input)

Private Attributes
std::vector< Entry >	m_entries
std::vector< std::uint8_t >	m_buffer

Detailed Description

A helper class to manage a vector of branch entries for ROOT trees.

This class provides functionality to manage a collection of branch entries, including their names, types, offsets, and sizes. It supports adding new entries, accessing entries by index or name, and generating leaf lists for ROOT trees.

Definition at line 55 of file QwRootFile.h.

Member Typedef Documentation

size_type

using QwRootTreeBranchVector::size_type = std::size_t

Definition at line 64 of file QwRootFile.h.

Constructor & Destructor Documentation

QwRootTreeBranchVector()

QwRootTreeBranchVector::QwRootTreeBranchVector ( )

default

Member Function Documentation

AlignOffset()

static std::size_t QwRootTreeBranchVector::AlignOffset ( std::size_t offset )

inlinestaticprivate

Definition at line 320 of file QwRootFile.h.

                                                 {
    const std::size_t alignment = 4u;
    return (offset + (alignment - 1u)) & ~(alignment - 1u);
  }

Referenced by push_back().

Here is the caller graph for this function:

back() [1/2]

template<typename T>

T & QwRootTreeBranchVector::back ( )

inline

Definition at line 180 of file QwRootFile.h.

            {
    if (m_entries.empty()) {
      throw std::out_of_range("QwRootTreeBranchVector::back() called on empty container");
    }
    const auto& last_entry = m_entries.back();
    return *reinterpret_cast<T*>(m_buffer.data() + last_entry.offset);
  }

References m_buffer, and m_entries.

Referenced by QwHelicityBase::ConstructBranchAndVector(), QwHelicityDecoder::ConstructBranchAndVector(), and QwSubsystemArrayParity::ConstructBranchAndVector().

Here is the caller graph for this function:

back() [2/2]

template<typename T>

const T & QwRootTreeBranchVector::back ( ) const

inline

Definition at line 189 of file QwRootFile.h.

                        {
    if (m_entries.empty()) {
      throw std::out_of_range("QwRootTreeBranchVector::back() called on empty container");
    }
    const auto& last_entry = m_entries.back();
    return *reinterpret_cast<const T*>(m_buffer.data() + last_entry.offset);
  }

References m_buffer, and m_entries.

clear()

void QwRootTreeBranchVector::clear ( )

inline

Definition at line 78 of file QwRootFile.h.

               {
    m_entries.clear();
    m_buffer.clear();
  }

References m_buffer, and m_entries.

data() [1/2]

const void * QwRootTreeBranchVector::data ( ) const

inlinenoexcept

Definition at line 176 of file QwRootFile.h.

{ return m_buffer.data(); }

References m_buffer.

data() [2/2]

void * QwRootTreeBranchVector::data ( )

inlinenoexcept

Definition at line 175 of file QwRootFile.h.

{ return m_buffer.data(); }

References m_buffer.

data_size()

size_type QwRootTreeBranchVector::data_size ( ) const

inlinenoexcept

Definition at line 177 of file QwRootFile.h.

{ return m_buffer.size(); }

References m_buffer.

Dump()

std::string QwRootTreeBranchVector::Dump ( size_type start_index = 0, size_type end_index = 0 ) const

inline

Definition at line 245 of file QwRootFile.h.

                                                                           {
    std::ostringstream stream;
    stream << "QwRootTreeBranchVector: " << m_entries.size() << " entries, "
           << m_buffer.size() << " bytes\n";
    size_t end_offset = (end_index == 0 || end_index > m_entries.size()) ?
      m_buffer.size()
      : m_entries[end_index - 1].offset + m_entries[end_index - 1].size;
    stream << "QwRootTreeBranchVector: buffer at 0x" << std::hex << (void*) &m_buffer[0] << '\n';
    stream << "QwRootTreeBranchVector: entries at 0x" << std::hex << (void*) &m_entries[0] << '\n';
    for (size_t offset = m_entries[start_index].offset; offset < end_offset; offset += 4) {
      stream << std::dec
             << "  [" << offset << "] "
             << std::hex
             << " offset=0x" << offset
             << " (0x" << std::setw(4) << std::setfill('0')
                       << offset - m_entries[start_index].offset << ")"
             << " buff=";
      // Little-endian
      for (std::size_t byte = 0; byte < 4; ++byte) {
        stream << std::hex << std::setw(2) << std::setfill('0')
               << static_cast<unsigned int>(m_buffer[offset + byte])
               << " ";
      }
      stream << '\n';
    }
    end_index = (end_index == 0 || end_index > m_entries.size()) ?
      m_entries.size()
      : end_index;
    for (size_type index = start_index; index < end_index; ++index) {
      const auto& entry = m_entries[index];
      stream << std::dec
             << "  [" << index << "] "
             << std::hex
             << " offset=0x" << entry.offset
             << " (0x" << std::setw(4) << std::setfill('0')
                       << entry.offset - m_entries[start_index].offset << ")"
             << " size=0x" << entry.size
             << " buff=0x";
      // Little-endian
      for (std::size_t byte = GetTypeSize(entry.type); byte > 0; --byte) {
        stream << std::hex << std::setw(2) << std::setfill('0')
               << static_cast<unsigned int>((m_buffer.data() + entry.offset)[byte - 1]);
      }
      stream << std::dec
             << " name=" << entry.name << "/" << entry.type
             << " value=" << FormatValue(entry, index);
      stream << '\n';
    }
    return stream.str();
  }

References FormatValue(), GetTypeSize(), m_buffer, and m_entries.

Here is the call graph for this function:

empty()

bool QwRootTreeBranchVector::empty ( ) const

inlinenoexcept

Definition at line 84 of file QwRootFile.h.

{ return m_entries.empty(); }

References m_entries.

FormatNumeric()

template<typename T>

static std::string QwRootTreeBranchVector::FormatNumeric ( T input )

inlinestaticprivate

Definition at line 352 of file QwRootFile.h.

                                          {
    std::ostringstream stream;
    stream << input;
    return stream.str();
  }

Referenced by FormatValue().

Here is the caller graph for this function:

FormatValue()

std::string QwRootTreeBranchVector::FormatValue ( const Entry & entry, size_type index ) const

inlineprivate

Definition at line 328 of file QwRootFile.h.

                                                                   {
    switch (entry.type) {
      case 'D':
        return FormatNumeric(value<double>(index));
      case 'F':
        return FormatNumeric(value<float>(index));
      case 'L':
        return FormatNumeric(value<long long>(index));
      case 'l':
        return FormatNumeric(value<unsigned long long>(index));
      case 'I':
        return FormatNumeric(value<int>(index));
      case 'i':
        return FormatNumeric(value<unsigned int>(index));
      case 'S':
        return FormatNumeric(value<short>(index));
      case 's':
        return FormatNumeric(value<unsigned short>(index));
      default:
        return "<unknown>";
    }
  }

References FormatNumeric(), QwRootTreeBranchVector::Entry::type, and value().

Referenced by Dump().

Here is the call graph for this function:

Here is the caller graph for this function:

GetTypeSize()

static std::size_t QwRootTreeBranchVector::GetTypeSize ( char type )

inlinestaticprivate

Definition at line 297 of file QwRootFile.h.

                                          {
    switch (type) {
      case 'D':
        return sizeof(double);
      case 'F':
        return sizeof(float);
      case 'L':
        return sizeof(long long);
      case 'l':
        return sizeof(unsigned long long);
      case 'I':
        return sizeof(int);
      case 'i':
        return sizeof(unsigned int);
      case 'S':
        return sizeof(short);
      case 's':
        return sizeof(unsigned short);
      default:
        throw std::invalid_argument("Unsupported branch type code: " + std::string(1, type));
    }
  }

Referenced by Dump(), and push_back().

Here is the caller graph for this function:

LeafList()

std::string QwRootTreeBranchVector::LeafList ( size_type start_index = 0 ) const

inline

Definition at line 230 of file QwRootFile.h.

                                                      {
    static const std::string separator = ":";
    std::ostringstream stream;
    bool first = true;
    for (size_type index = start_index; index < m_entries.size(); ++index) {
      const auto& entry = m_entries[index];
      if (!first) {
        stream << separator;
      }
      stream << entry.name << "/" << entry.type;
      first = false;
    }
    return stream.str();
  }

References m_entries.

Referenced by QwADC18_Channel::ConstructBranchAndVector(), QwBeamMod::ConstructBranchAndVector(), QwEPICSEvent::ConstructBranchAndVector(), QwMollerADC_Channel::ConstructBranchAndVector(), QwPMT_Channel::ConstructBranchAndVector(), and QwVQWK_Channel::ConstructBranchAndVector().

Here is the caller graph for this function:

operator[]() [1/2]

template<typename T = uint8_t>

T & QwRootTreeBranchVector::operator[] ( size_type index )

inline

Definition at line 92 of file QwRootFile.h.

                                 {
    return value<T>(index);
  }

References value().

Here is the call graph for this function:

operator[]() [2/2]

template<typename T = uint8_t>

const T & QwRootTreeBranchVector::operator[] ( size_type index ) const

inline

Definition at line 87 of file QwRootFile.h.

                                             {
    return value<T>(index);
  }

References value().

Here is the call graph for this function:

push_back() [1/3]

void QwRootTreeBranchVector::push_back ( const char * name, const char type = 'D' )

inline

Definition at line 226 of file QwRootFile.h.

                                                          {
    push_back(std::string(name), type);
  }

References push_back().

Here is the call graph for this function:

push_back() [2/3]

void QwRootTreeBranchVector::push_back ( const std::string & name, const char type = 'D' )

inline

Definition at line 197 of file QwRootFile.h.

                                                               {
    const std::size_t entry_size = GetTypeSize(type);
    const std::size_t offset = AlignOffset(m_buffer.size());
 
    if (offset > m_buffer.capacity()) {
      throw std::out_of_range("QwRootTreeBranchVector::push_back() requires buffer resize beyond reserved capacity");
    }
    if (offset > m_buffer.size()) {
      m_buffer.resize(offset, 0u);
    }
 
    Entry entry{name, offset, entry_size, type};
    m_entries.push_back(entry);
 
    const std::size_t required = offset + entry_size;
    if (required > m_buffer.capacity()) {
      throw std::out_of_range("QwRootTreeBranchVector::push_back() requires buffer resize beyond reserved capacity");
    }
    if (required > m_buffer.size()) {
      m_buffer.resize(required, 0u);
    }
  }

References AlignOffset(), GetTypeSize(), m_buffer, and m_entries.

Referenced by QwADC18_Channel::ConstructBranchAndVector(), QwBeamMod::ConstructBranchAndVector(), QwEPICSEvent::ConstructBranchAndVector(), QwHelicityBase::ConstructBranchAndVector(), QwHelicityDecoder::ConstructBranchAndVector(), QwMollerADC_Channel::ConstructBranchAndVector(), QwPMT_Channel::ConstructBranchAndVector(), QwScaler_Channel< data_mask, data_shift >::ConstructBranchAndVector(), QwSubsystemArray::ConstructBranchAndVector(), QwSubsystemArrayParity::ConstructBranchAndVector(), QwVQWK_Channel::ConstructBranchAndVector(), push_back(), and push_back().

Here is the call graph for this function:

Here is the caller graph for this function:

push_back() [3/3]

void QwRootTreeBranchVector::push_back ( const TString & name, const char type = 'D' )

inline

Definition at line 221 of file QwRootFile.h.

                                                             {
    push_back(std::string(name.Data()), type);
  }

References push_back().

Here is the call graph for this function:

reserve()

void QwRootTreeBranchVector::reserve ( size_type count )

inline

Definition at line 68 of file QwRootFile.h.

                                {
    m_entries.reserve(count);
    m_buffer.reserve(sizeof(double)*count);
  }

References m_buffer, and m_entries.

SetValue() [1/8]

void QwRootTreeBranchVector::SetValue ( size_type index, Double_t val )

inline

Definition at line 110 of file QwRootFile.h.

                                               {
    const auto& entry = m_entries.at(index);
    if (entry.type != 'D') {
      throw std::invalid_argument("Type mismatch: entry type '" + std::string(1, entry.type) + "' cannot store double value '" + entry.name + "'");
    }
    this->value<Double_t>(index) = val;
  }

References m_entries, and value().

Referenced by QwADC18_Channel::FillTreeVector(), QwBeamMod::FillTreeVector(), QwEPICSEvent::FillTreeVector(), QwHelicityBase::FillTreeVector(), QwHelicityDecoder::FillTreeVector(), QwMollerADC_Channel::FillTreeVector(), QwPMT_Channel::FillTreeVector(), QwScaler_Channel< data_mask, data_shift >::FillTreeVector(), QwSubsystemArray::FillTreeVector(), QwSubsystemArrayParity::FillTreeVector(), and QwVQWK_Channel::FillTreeVector().

Here is the call graph for this function:

Here is the caller graph for this function:

SetValue() [2/8]

void QwRootTreeBranchVector::SetValue ( size_type index, Float_t val )

inline

Definition at line 118 of file QwRootFile.h.

                                              {
    const auto& entry = m_entries.at(index);
    if (entry.type != 'F') {
      throw std::invalid_argument("Type mismatch: entry type '" + std::string(1, entry.type) + "' cannot store float value '" + entry.name + "'");
    }
    this->value<Float_t>(index) = val;
  }

References m_entries, and value().

Here is the call graph for this function:

SetValue() [3/8]

void QwRootTreeBranchVector::SetValue ( size_type index, Int_t val )

inline

Definition at line 126 of file QwRootFile.h.

                                            {
    const auto& entry = m_entries.at(index);
    if (entry.type != 'I') {
      throw std::invalid_argument("Type mismatch: entry type '" + std::string(1, entry.type) + "' cannot store int value '" + entry.name + "'");
    }
    this->value<Int_t>(index) = val;
  }

References m_entries, and value().

Here is the call graph for this function:

SetValue() [4/8]

void QwRootTreeBranchVector::SetValue ( size_type index, Long64_t val )

inline

Definition at line 134 of file QwRootFile.h.

                                               {
    const auto& entry = m_entries.at(index);
    if (entry.type != 'L') {
      throw std::invalid_argument("Type mismatch: entry type '" + std::string(1, entry.type) + "' cannot store long long value '" + entry.name + "'");
    }
    this->value<Long64_t>(index) = val;
  }

References m_entries, and value().

Here is the call graph for this function:

SetValue() [5/8]

void QwRootTreeBranchVector::SetValue ( size_type index, Short_t val )

inline

Definition at line 142 of file QwRootFile.h.

                                              {
    const auto& entry = m_entries.at(index);
    if (entry.type != 'S') {
      throw std::invalid_argument("Type mismatch: entry type '" + std::string(1, entry.type) + "' cannot store short value '" + entry.name + "'");
    }
    this->value<Short_t>(index) = val;
  }

References m_entries, and value().

Here is the call graph for this function:

SetValue() [6/8]

void QwRootTreeBranchVector::SetValue ( size_type index, UInt_t val )

inline

Definition at line 159 of file QwRootFile.h.

                                             {
    const auto& entry = m_entries.at(index);
    if (entry.type != 'i') {
      throw std::invalid_argument("Type mismatch: entry type '" + std::string(1, entry.type) + "' cannot store unsigned int value '" + entry.name + "'");
    }
    this->value<UInt_t>(index) = val;
  }

References m_entries, and value().

Here is the call graph for this function:

SetValue() [7/8]

void QwRootTreeBranchVector::SetValue ( size_type index, ULong64_t val )

inline

Definition at line 167 of file QwRootFile.h.

                                                {
    const auto& entry = m_entries.at(index);
    if (entry.type != 'l') {
      throw std::invalid_argument("Type mismatch: entry type '" + std::string(1, entry.type) + "' cannot store long long value '" + entry.name + "'");
    }
    this->value<ULong64_t>(index) = val;
  }

References m_entries, and value().

Here is the call graph for this function:

SetValue() [8/8]

void QwRootTreeBranchVector::SetValue ( size_type index, UShort_t val )

inline

Definition at line 151 of file QwRootFile.h.

                                               {
    const auto& entry = m_entries.at(index);
    if (entry.type != 's') {
      throw std::invalid_argument("Type mismatch: entry type '" + std::string(1, entry.type) + "' cannot store short value '" + entry.name + "'");
    }
    this->value<UShort_t>(index) = val;
  }

References m_entries, and value().

Here is the call graph for this function:

shrink_to_fit()

void QwRootTreeBranchVector::shrink_to_fit ( )

inline

Definition at line 73 of file QwRootFile.h.

                       {
    m_entries.shrink_to_fit();
    m_buffer.shrink_to_fit();
  }

References m_buffer, and m_entries.

size()

size_type QwRootTreeBranchVector::size ( ) const

inlinenoexcept

Definition at line 83 of file QwRootFile.h.

{ return m_entries.size(); }

References m_entries.

Referenced by QwADC18_Channel::ConstructBranchAndVector(), QwBeamMod::ConstructBranchAndVector(), QwEPICSEvent::ConstructBranchAndVector(), QwHelicityBase::ConstructBranchAndVector(), QwHelicityDecoder::ConstructBranchAndVector(), QwMollerADC_Channel::ConstructBranchAndVector(), QwPMT_Channel::ConstructBranchAndVector(), QwScaler_Channel< data_mask, data_shift >::ConstructBranchAndVector(), QwSubsystemArray::ConstructBranchAndVector(), QwSubsystemArrayParity::ConstructBranchAndVector(), QwVQWK_Channel::ConstructBranchAndVector(), QwADC18_Channel::FillTreeVector(), QwMollerADC_Channel::FillTreeVector(), QwPMT_Channel::FillTreeVector(), QwScaler_Channel< data_mask, data_shift >::FillTreeVector(), QwSubsystemArrayParity::FillTreeVector(), and QwVQWK_Channel::FillTreeVector().

Here is the caller graph for this function:

value() [1/2]

template<typename T>

T & QwRootTreeBranchVector::value ( size_type index )

inline

Definition at line 97 of file QwRootFile.h.

                            {
    auto& entry = m_entries.at(index);
    return *reinterpret_cast<T*>(m_buffer.data() + entry.offset);
  }

References m_buffer, and m_entries.

Referenced by FormatValue(), operator[](), operator[](), SetValue(), SetValue(), SetValue(), SetValue(), SetValue(), SetValue(), SetValue(), and SetValue().

Here is the caller graph for this function:

value() [2/2]

template<typename T>

const T & QwRootTreeBranchVector::value ( size_type index ) const

inline

Definition at line 103 of file QwRootFile.h.

                                        {
    const auto& entry = m_entries.at(index);
    return *reinterpret_cast<const T*>(m_buffer.data() + entry.offset);
  }

References m_buffer, and m_entries.

Field Documentation

m_buffer

std::vector<std::uint8_t> QwRootTreeBranchVector::m_buffer

private

Definition at line 326 of file QwRootFile.h.

Referenced by back(), back(), clear(), data(), data(), data_size(), Dump(), push_back(), reserve(), shrink_to_fit(), value(), and value().

m_entries

std::vector<Entry> QwRootTreeBranchVector::m_entries

private

Definition at line 325 of file QwRootFile.h.

Referenced by back(), back(), clear(), Dump(), empty(), LeafList(), push_back(), reserve(), SetValue(), SetValue(), SetValue(), SetValue(), SetValue(), SetValue(), SetValue(), SetValue(), shrink_to_fit(), size(), value(), and value().

---

The documentation for this class was generated from the following file:

• QwRootFile.h