Mantid
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
Mantid::DataHandling::DataBlock Class Reference

DataBlock: The DataBlock class holds information about a contiguous block of spectrum numbers. More...

#include <DataBlock.h>

Inheritance diagram for Mantid::DataHandling::DataBlock:
Mantid::DataHandling::DataBlockComposite

Public Member Functions

 DataBlock ()
 
 DataBlock (const Mantid::NeXus::NXInt &data)
 
 DataBlock (int numberOfperiods, size_t numberOfSpectra, size_t numberOfChannels)
 
virtual std::unique_ptr< DataBlockGeneratorgetGenerator () const
 
virtual specnum_t getMaxSpectrumID () const
 
virtual specnum_t getMinSpectrumID () const
 
virtual size_t getNumberOfChannels () const
 
virtual int getNumberOfPeriods () const
 
virtual size_t getNumberOfSpectra () const
 
bool operator== (const DataBlock &other) const
 
virtual void setMaxSpectrumID (specnum_t minSpecID)
 
virtual void setMinSpectrumID (specnum_t minSpecID)
 
virtual ~DataBlock ()=default
 

Protected Attributes

specnum_t m_maxSpectraID
 
specnum_t m_minSpectraID
 
size_t m_numberOfChannels
 
int m_numberOfPeriods
 
size_t m_numberOfSpectra
 

Detailed Description

DataBlock: The DataBlock class holds information about a contiguous block of spectrum numbers.

It contains information about the min and max number of that range as well as the number of channels and periods that are associated with the spectra in the nexus file.

Definition at line 26 of file DataBlock.h.

Constructor & Destructor Documentation

◆ DataBlock() [1/3]

Mantid::DataHandling::DataBlock::DataBlock ( )

Definition at line 17 of file DataBlock.cpp.

◆ DataBlock() [2/3]

Mantid::DataHandling::DataBlock::DataBlock ( const Mantid::NeXus::NXInt data)

Definition at line 21 of file DataBlock.cpp.

◆ DataBlock() [3/3]

Mantid::DataHandling::DataBlock::DataBlock ( int  numberOfperiods,
size_t  numberOfSpectra,
size_t  numberOfChannels 
)

Definition at line 25 of file DataBlock.cpp.

◆ ~DataBlock()

virtual Mantid::DataHandling::DataBlock::~DataBlock ( )
virtualdefault

References std::operator==().

Member Function Documentation

◆ getGenerator()

std::unique_ptr< DataBlockGenerator > Mantid::DataHandling::DataBlock::getGenerator ( ) const
virtual

Reimplemented in Mantid::DataHandling::DataBlockComposite.

Definition at line 43 of file DataBlock.cpp.

References m_maxSpectraID, and m_minSpectraID.

◆ getMaxSpectrumID()

specnum_t Mantid::DataHandling::DataBlock::getMaxSpectrumID ( ) const
virtual

◆ getMinSpectrumID()

specnum_t Mantid::DataHandling::DataBlock::getMinSpectrumID ( ) const
virtual

Reimplemented in Mantid::DataHandling::DataBlockComposite.

Definition at line 29 of file DataBlock.cpp.

References m_minSpectraID.

◆ getNumberOfChannels()

size_t Mantid::DataHandling::DataBlock::getNumberOfChannels ( ) const
virtual

◆ getNumberOfPeriods()

int Mantid::DataHandling::DataBlock::getNumberOfPeriods ( ) const
virtual

◆ getNumberOfSpectra()

size_t Mantid::DataHandling::DataBlock::getNumberOfSpectra ( ) const
virtual

◆ operator==()

bool Mantid::DataHandling::DataBlock::operator== ( const DataBlock other) const

◆ setMaxSpectrumID()

void Mantid::DataHandling::DataBlock::setMaxSpectrumID ( specnum_t  minSpecID)
virtual

◆ setMinSpectrumID()

void Mantid::DataHandling::DataBlock::setMinSpectrumID ( specnum_t  minSpecID)
virtual

Member Data Documentation

◆ m_maxSpectraID

specnum_t Mantid::DataHandling::DataBlock::m_maxSpectraID
protected

Definition at line 58 of file DataBlock.h.

Referenced by getGenerator(), getMaxSpectrumID(), operator==(), and setMaxSpectrumID().

◆ m_minSpectraID

specnum_t Mantid::DataHandling::DataBlock::m_minSpectraID
protected

Definition at line 56 of file DataBlock.h.

Referenced by getGenerator(), getMinSpectrumID(), operator==(), and setMinSpectrumID().

◆ m_numberOfChannels

size_t Mantid::DataHandling::DataBlock::m_numberOfChannels
protected

◆ m_numberOfPeriods

int Mantid::DataHandling::DataBlock::m_numberOfPeriods
protected

◆ m_numberOfSpectra

size_t Mantid::DataHandling::DataBlock::m_numberOfSpectra
protected

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