NXnumtype Class Reference

The primitive types published by this API. More...

#include <NexusFile_fwd.h>

Public Member Functions
	NXnumtype ()
	NXnumtype (int const val)
	operator int () const
	operator std::string () const
NXnumtype &	operator= (int const)

Static Public Attributes
static unsigned short constexpr	BAD = 0xFFu
static unsigned short constexpr	BINARY = 0xF1u
static unsigned short constexpr	CHAR = 0xF0u
static unsigned short constexpr	FLOAT32 = 0x24u
static unsigned short constexpr	FLOAT64 = 0x28u
static unsigned short constexpr	INT16 = 0x12u
static unsigned short constexpr	INT32 = 0x14u
static unsigned short constexpr	INT64 = 0x18u
static unsigned short constexpr	INT8 = 0x11u
static unsigned short constexpr	UINT16 = 0x02u
static unsigned short constexpr	UINT32 = 0x04u
static unsigned short constexpr	UINT64 = 0x08u
static unsigned short constexpr	UINT8 = 0x01u

Static Private Member Functions
static int	validate_val (int const x)

Private Attributes
int	m_val

Detailed Description

The primitive types published by this API.

• FLOAT32 32-bit float.
• FLOAT64 64-bit double
• INT8 byte-width integer – int8_t
• UINT8 byte-width unsigned integer – uint8_t
• INT16 double-byte-width integer – int16_t
• UINT16 double-byte-width unsigned integer – uint16_t
• INT32 quad-byte-width integer – int32_t
• UINT32 quad-byte-width unsigned integer – uint32_t
• INT64 eight-byte-width integer – int8_t if available on the machine
• UINT64 eight-byte-width integer – uint8_t if available on the machine
• BINARY lump of binary data, same as UINT8

Definition at line 67 of file NexusFile_fwd.h.

Constructor & Destructor Documentation

NXnumtype() [1/2]

NXnumtype::NXnumtype

(

)

NXnumtype() [2/2]

NXnumtype::NXnumtype

(

int const

val

)

Member Function Documentation

operator int()

NXnumtype::operator int

(

)

const

operator std::string()

NXnumtype::operator std::string

(

)

const

operator=()

NXnumtype & NXnumtype::operator=

(

int const

)

validate_val()

static int NXnumtype::validate_val ( int const  x )

staticprivate

Member Data Documentation

BAD

unsigned short constexpr NXnumtype::BAD = 0xFFu

staticconstexpr

Definition at line 83 of file NexusFile_fwd.h.

Referenced by hdf5ToNXType().

BINARY

unsigned short constexpr NXnumtype::BINARY = 0xF1u

staticconstexpr

Definition at line 82 of file NexusFile_fwd.h.

Referenced by hdf5ToNXType().

CHAR

unsigned short constexpr NXnumtype::CHAR = 0xF0u

staticconstexpr

Definition at line 81 of file NexusFile_fwd.h.

Referenced by Mantid::Nexus::NXDataSet::getAttributes(), hdf5ToNXType(), Mantid::DataHandling::LoadEventNexus::loadEntryMetadata(), Mantid::DataHandling::LoadNexusProcessed::loadTableEntry(), NXgetattr(), nxToHDF5Type(), Mantid::DataHandling::LoadHelper::recurseAndAddNexusFieldsToWsRun(), Mantid::DataObjects::LeanElasticPeaksWorkspace::saveNexus(), Mantid::DataObjects::PeaksWorkspace::saveNexus(), Mantid::Kernel::TimeSeriesProperty< TYPE >::saveProperty(), Mantid::Nexus::NexusFileIO::writeNexusProcessedData2D(), and Mantid::Nexus::NexusFileIO::writeNexusTableWorkspace().

FLOAT32

unsigned short constexpr NXnumtype::FLOAT32 = 0x24u

staticconstexpr

Definition at line 71 of file NexusFile_fwd.h.

Referenced by Mantid::DataHandling::LoadBankFromDiskTask::loadEventWeights(), Mantid::DataHandling::LoadMuonNexusV2NexusHelper::loadFirstGoodDataFromNexus(), Mantid::DataHandling::LoadMuonNexusV2NexusHelper::loadLastGoodDataFromNexus(), Mantid::DataHandling::LoadNexusLogs::loadSELog(), Mantid::DataHandling::LoadNexusProcessed::loadTableEntry(), nxToHDF5Type(), Mantid::DataObjects::BoxControllerNeXusIO::prepareNxSdata_CurVersion(), Mantid::DataObjects::BoxControllerNeXusIO::prepareNxSToWrite_CurVersion(), Mantid::DataHandling::LoadHelper::recurseAndAddNexusFieldsToWsRun(), Mantid::DataObjects::MDBoxFlatTree::saveAffineTransformMatrix(), Mantid::Nexus::NexusFileIO::writeNexusProcessedDataEventCombined(), and Mantid::Nexus::NexusFileIO::writeNexusTableWorkspace().

FLOAT64

unsigned short constexpr NXnumtype::FLOAT64 = 0x28u

staticconstexpr

Definition at line 72 of file NexusFile_fwd.h.

Referenced by Mantid::DataHandling::BankPulseTimes::BankPulseTimes(), Mantid::MDAlgorithms::SaveMD::doSaveHisto(), Mantid::MDAlgorithms::SaveMD2::doSaveHisto(), Mantid::DataHandling::SaveNXSPE::exec(), Mantid::MDAlgorithms::LoadMD::loadHisto(), Mantid::DataHandling::LoadNexusProcessed::loadLeanElasticPeaksEntry(), Mantid::DataHandling::LoadNexusProcessed::loadPeaksEntry(), Mantid::DataHandling::LoadNexusProcessed::loadTableEntry(), nxToHDF5Type(), Mantid::DataObjects::BoxControllerNeXusIO::prepareNxSdata_CurVersion(), Mantid::DataObjects::BoxControllerNeXusIO::prepareNxSToWrite_CurVersion(), Mantid::DataHandling::LoadHelper::recurseAndAddNexusFieldsToWsRun(), Mantid::Kernel::V3D::saveNexus(), Mantid::DataHandling::SaveNXTomo::setupFile(), Mantid::Nexus::NexusFileIO::writeNexusBinMasking(), Mantid::Nexus::NexusFileIO::writeNexusProcessedData2D(), Mantid::Nexus::NexusFileIO::writeNexusProcessedDataEventCombined(), and Mantid::Nexus::NexusFileIO::writeNexusTableWorkspace().

INT16

unsigned short constexpr NXnumtype::INT16 = 0x12u

staticconstexpr

Definition at line 74 of file NexusFile_fwd.h.

Referenced by Mantid::Nexus::NXDataSet::getAttributes(), nxToHDF5Type(), and Mantid::DataHandling::LoadHelper::recurseAndAddNexusFieldsToWsRun().

INT32

unsigned short constexpr NXnumtype::INT32 = 0x14u

staticconstexpr

Definition at line 75 of file NexusFile_fwd.h.

Referenced by Mantid::Nexus::NXDataSet::getAttributes(), Mantid::DataHandling::LoadMuonNexusV2NexusHelper::loadFirstGoodDataFromNexus(), Mantid::DataHandling::LoadMuonNexusV2NexusHelper::loadLastGoodDataFromNexus(), Mantid::DataHandling::LoadNexusProcessed::loadTableEntry(), nxToHDF5Type(), Mantid::DataHandling::LoadHelper::recurseAndAddNexusFieldsToWsRun(), Mantid::Nexus::NexusFileIO::writeNexusBinMasking(), and Mantid::Nexus::NexusFileIO::writeNexusTableWorkspace().

INT64

unsigned short constexpr NXnumtype::INT64 = 0x18u

staticconstexpr

Definition at line 76 of file NexusFile_fwd.h.

Referenced by Mantid::DataHandling::LoadNexusProcessed::loadTableEntry(), nxToHDF5Type(), Mantid::Nexus::NexusFileIO::writeNexusProcessedDataEventCombined(), and Mantid::Nexus::NexusFileIO::writeNexusTableWorkspace().

INT8

unsigned short constexpr NXnumtype::INT8 = 0x11u

staticconstexpr

Definition at line 73 of file NexusFile_fwd.h.

Referenced by Mantid::MDAlgorithms::SaveMD::doSaveHisto(), Mantid::MDAlgorithms::SaveMD2::doSaveHisto(), Mantid::MDAlgorithms::LoadMD::loadHisto(), and nxToHDF5Type().

m_val

int NXnumtype::m_val

private

Definition at line 86 of file NexusFile_fwd.h.

UINT16

unsigned short constexpr NXnumtype::UINT16 = 0x02u

staticconstexpr

Definition at line 78 of file NexusFile_fwd.h.

Referenced by Mantid::Nexus::NXDataSet::getAttributes(), nxToHDF5Type(), and Mantid::DataHandling::LoadHelper::recurseAndAddNexusFieldsToWsRun().

UINT32

unsigned short constexpr NXnumtype::UINT32 = 0x04u

staticconstexpr

Definition at line 79 of file NexusFile_fwd.h.

Referenced by Mantid::DataHandling::LoadNexusProcessed::loadTableEntry(), nxToHDF5Type(), and Mantid::Nexus::NexusFileIO::writeNexusTableWorkspace().

UINT64

unsigned short constexpr NXnumtype::UINT64 = 0x08u

staticconstexpr

Definition at line 80 of file NexusFile_fwd.h.

Referenced by Mantid::DataHandling::BankPulseTimes::BankPulseTimes(), Mantid::DataHandling::DetermineChunking::exec(), Mantid::DataHandling::LoadNexusProcessed::loadTableEntry(), Mantid::DataHandling::numEvents(), nxToHDF5Type(), Mantid::Nexus::NexusFileIO::writeNexusBinMasking(), and Mantid::Nexus::NexusFileIO::writeNexusTableWorkspace().

UINT8

unsigned short constexpr NXnumtype::UINT8 = 0x01u

staticconstexpr

Definition at line 77 of file NexusFile_fwd.h.

Referenced by Mantid::DataHandling::LoadNexusProcessed::loadTableEntry(), nxToHDF5Type(), Mantid::DataHandling::SaveNXTomo::writeLogValues(), and Mantid::Nexus::NexusFileIO::writeNexusTableWorkspace().

---

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

• Framework/Nexus/inc/MantidNexus/NexusFile_fwd.h