DataBlockGenerator: The DataBlockGenerator class provides increasing int64_t numbers from a collection of intervals which are being input into the generator at construction. More...

#include <DataBlockGenerator.h>

Public Member Functions
	DataBlockGenerator (std::vector< SpectrumPair > intervals)

specnum_t	getValue ()

bool	isDone ()

void	next ()
	Convenience method for incrementing.

DataBlockGenerator &	operator++ ()
	We need to increment through a series of intervals and need to make sure that we skip the gaps.

DataBlockGenerator	operator++ (int)

Public Attributes
std::optional< size_t >	m_currentIntervalIndex

specnum_t	m_currentSpectrum

std::vector< SpectrumPair >	m_intervals

Detailed Description

DataBlockGenerator: The DataBlockGenerator class provides increasing int64_t numbers from a collection of intervals which are being input into the generator at construction.

Definition at line 22 of file DataBlockGenerator.h.

Constructor & Destructor Documentation

◆ DataBlockGenerator()

Mantid::DataHandling::DataBlockGenerator::DataBlockGenerator ( std::vector< SpectrumPair > intervals )

Definition at line 18 of file DataBlockGenerator.cpp.

References m_currentIntervalIndex, m_currentSpectrum, and m_intervals.

Member Function Documentation

◆ getValue()

specnum_t Mantid::DataHandling::DataBlockGenerator::getValue ( )

Definition at line 81 of file DataBlockGenerator.cpp.

References m_currentSpectrum.

◆ isDone()

bool Mantid::DataHandling::DataBlockGenerator::isDone ( )

Definition at line 79 of file DataBlockGenerator.cpp.

References m_currentIntervalIndex.

◆ next()

void Mantid::DataHandling::DataBlockGenerator::next ( )

Convenience method for incrementing.

Definition at line 77 of file DataBlockGenerator.cpp.

◆ operator++() [1/2]

DataBlockGenerator & Mantid::DataHandling::DataBlockGenerator::operator++ ( )

We need to increment through a series of intervals and need to make sure that we skip the gaps.

This does assume that the intervals are ordered.

Definition at line 40 of file DataBlockGenerator.cpp.

References m_currentIntervalIndex, m_currentSpectrum, and m_intervals.

◆ operator++() [2/2]

DataBlockGenerator Mantid::DataHandling::DataBlockGenerator::operator++ ( int )

Definition at line 68 of file DataBlockGenerator.cpp.

References m_intervals.

Member Data Documentation

◆ m_currentIntervalIndex

std::optional<size_t> Mantid::DataHandling::DataBlockGenerator::m_currentIntervalIndex

Definition at line 36 of file DataBlockGenerator.h.

Referenced by DataBlockGenerator(), isDone(), and operator++().

◆ m_currentSpectrum

specnum_t Mantid::DataHandling::DataBlockGenerator::m_currentSpectrum

Definition at line 34 of file DataBlockGenerator.h.

Referenced by DataBlockGenerator(), getValue(), and operator++().

◆ m_intervals

std::vector<SpectrumPair> Mantid::DataHandling::DataBlockGenerator::m_intervals

Definition at line 33 of file DataBlockGenerator.h.

Referenced by DataBlockGenerator(), operator++(), and operator++().

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

Framework/DataHandling/inc/MantidDataHandling/DataBlockGenerator.h
Framework/DataHandling/src/DataBlockGenerator.cpp

Public Member Functions

Public Attributes