Structure for keeping information about a Nexus data set, such as the dimensions and the type. More...

#include <NexusClasses.h>

Public Member Functions
	NXInfo ()

	NXInfo (Info const &info, std::string const &name)

	operator bool ()
	returns success of an operation

Public Attributes
bool	allGood
	return status

NXDimArray	dims
	sizes along each dimension

std::string	nxname
	name of the object

std::size_t	rank
	number of dimensions of the data

NXnumtype	type
	type of the data, e.g. NX_CHAR, FLOAT32; see NexusFile_fwd.h

Detailed Description

Structure for keeping information about a Nexus data set, such as the dimensions and the type.

Definition at line 36 of file NexusClasses.h.

Constructor & Destructor Documentation

◆ NXInfo() [1/2]

Mantid::Nexus::NXInfo::NXInfo ( )

inline

Definition at line 37 of file NexusClasses.h.

◆ NXInfo() [2/2]

Mantid::Nexus::NXInfo::NXInfo	(	Info const &	info,
		std::string const &	name
	)

Definition at line 23 of file NexusClasses.cpp.

Member Function Documentation

◆ operator bool()

Mantid::Nexus::NXInfo::operator bool ( )

inline

returns success of an operation

Definition at line 44 of file NexusClasses.h.

References allGood.

Member Data Documentation

◆ allGood

bool Mantid::Nexus::NXInfo::allGood

return status

Definition at line 43 of file NexusClasses.h.

Referenced by Mantid::Nexus::NXClass::containsDataSet(), Mantid::Nexus::NXClass::getDataSetInfo(), Mantid::DataHandling::LoadNexusProcessed::loadLeanElasticPeaksEntry(), Mantid::DataHandling::LoadNexusProcessed::loadPeaksEntry(), Mantid::DataHandling::LoadNexusProcessed::loadTableEntry(), operator bool(), and Mantid::DataHandling::LoadNexusProcessed::readBinMasking().

◆ dims

NXDimArray Mantid::Nexus::NXInfo::dims

sizes along each dimension

Definition at line 41 of file NexusClasses.h.

Referenced by Mantid::Nexus::NXDataSet::dim0(), Mantid::Nexus::NXDataSet::dim1(), Mantid::Nexus::NXDataSet::dim2(), Mantid::Nexus::NXDataSet::dim3(), Mantid::DataHandling::LoadNexusProcessed::loadLeanElasticPeaksEntry(), Mantid::DataHandling::LoadNexusProcessed::loadPeaksEntry(), Mantid::DataHandling::LoadNexusProcessed::loadTableEntry(), and Mantid::DataHandling::LoadNexusProcessed::loadVectorColumn().

◆ nxname

std::string Mantid::Nexus::NXInfo::nxname

name of the object

Definition at line 39 of file NexusClasses.h.

Referenced by Mantid::Nexus::NXDataSet::NXDataSet().

◆ rank

std::size_t Mantid::Nexus::NXInfo::rank

number of dimensions of the data

Definition at line 40 of file NexusClasses.h.

Referenced by Mantid::Nexus::NXDataSet::dim0(), Mantid::Nexus::NXDataSet::dim1(), Mantid::Nexus::NXDataSet::dim2(), Mantid::Nexus::NXDataSet::dim3(), and Mantid::DataHandling::LoadNexusProcessed::loadTableEntry().

◆ type

NXnumtype Mantid::Nexus::NXInfo::type

type of the data, e.g. NX_CHAR, FLOAT32; see NexusFile_fwd.h

Definition at line 42 of file NexusClasses.h.

Referenced by Mantid::DataHandling::LoadMuonNexusV2NexusHelper::loadFirstGoodDataFromNexus(), Mantid::DataHandling::LoadMuonNexusV2NexusHelper::loadLastGoodDataFromNexus(), Mantid::DataHandling::LoadNexusProcessed::loadLeanElasticPeaksEntry(), Mantid::DataHandling::LoadNexusProcessed::loadPeaksEntry(), and Mantid::DataHandling::LoadNexusProcessed::loadTableEntry().

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

Framework/Nexus/inc/MantidNexus/NexusClasses.h
Framework/Nexus/src/NexusClasses.cpp

Public Member Functions

Public Attributes