Implements NXdata Nexus class. More...

#include <NexusClasses.h>

Inheritance diagram for Mantid::NeXus::NXData:

Public Member Functions
std::string	NX_class () const override
	Nexus class id. More...

	NXData (const NXClass &parent, const std::string &name)
	Constructor. More...

template<typename T >
NXDataSetTyped< T >	openData ()
	Opens the dataset within this NXData with signal=1 attribute. More...

NXDouble	openDoubleData ()
	Opens data of double type. More...

NXFloat	openFloatData ()
	Opens data of float type. More...

NXInt	openIntData ()
	Opens data of int type. More...

NXSize	openSizeData ()
	Opens data of size type. More...

NXUInt	openUIntData ()
	Opens data of unsigned int type. More...

Public Member Functions inherited from Mantid::NeXus::NXMainClass
	NXMainClass (const NXClass &parent, const std::string &name)
	Constructor. More...

NXLog	openNXLog (const std::string &name)
	Opens a NXLog class. More...

NXNote	openNXNote (const std::string &name)
	Opens a NXNote class. More...

Public Member Functions inherited from Mantid::NeXus::NXClass
void	close ()
	Close this class. More...

bool	containsDataSet (const std::string &query) const
	Returns whether an individual dataset is present. More...

bool	containsGroup (const std::string &query) const
	Returns whether an individual group (or group) is present. More...

std::vector< NXInfo > &	datasets () const
	Returns a list of all datasets in this NXClass. More...

NXInfo	getDataSetInfo (const std::string &name) const
	Returns NXInfo for a dataset. More...

double	getDouble (const std::string &name) const
	Returns a double. More...

float	getFloat (const std::string &name) const
	Returns a float. More...

int	getInt (const std::string &name) const
	Returns a int. More...

NXClassInfo	getNextEntry ()
	Returns the class information about the next entry (class or dataset) in this class. More...

std::string	getString (const std::string &name) const
	Returns a string. More...

std::vector< NXClassInfo > &	groups () const
	Returns a list of all classes (or groups) in this NXClass. More...

bool	isValid (const std::string &path) const
	Check if a path exists relative to the current class path. More...

std::string	NX_class () const override
	The NX class identifier. More...

	NXClass (const NXClass &parent, const std::string &name)
	Constructor. More...

void	open ()
	Opens this NXClass using NXopengrouppath. Can be slow (or is slow) More...

bool	openLocal (const std::string &nxclass="")
	Opens this NXClass using NXopengroup. More...

NXChar	openNXChar (const std::string &name) const
	Creates and opens a char dataset. More...

template<class NX >
NX	openNXClass (const std::string &name) const
	Templated method for creating derived NX classes. More...

template<class T >
NXDataSetTyped< T >	openNXDataSet (const std::string &name) const
	Templated method for creating datasets. More...

NXDouble	openNXDouble (const std::string &name) const
	Creates and opens a double dataset. More...

NXFloat	openNXFloat (const std::string &name) const
	Creates and opens a float dataset. More...

NXClass	openNXGroup (const std::string &name) const
	Creates and opens an arbitrary (non-standard) class (group). More...

NXInt	openNXInt (const std::string &name) const
	Creates and opens an integer dataset. More...

NXSize	openNXSize (const std::string &name) const
	Creates and opens a size_t dataset. More...

void	reset ()
	Creates a new object in the NeXus file at path path. More...

Public Member Functions inherited from Mantid::NeXus::NXObject
std::string	name () const
	Returns the name of the object. More...

virtual std::string	NX_class () const =0
	Return the NX class name for a class (HDF group) or "SDS" for a data set;. More...

	NXObject (const NXhandle fileID, const NXClass *parent, const std::string &name)
	NXObject constructor. More...

std::string	path () const
	Returns the absolute path to the object. More...

virtual	~NXObject ()=default

Additional Inherited Members
Public Attributes inherited from Mantid::NeXus::NXObject
NXAttributes	attributes
	Attributes. More...

NXhandle	m_fileID
	Nexus file id. More...

Protected Member Functions inherited from Mantid::NeXus::NXClass
void	clear ()
	Deletes content of m_groups and m_datasets. More...

void	readAllInfo ()
	Fills in m_groups and m_datasets. More...

Protected Attributes inherited from Mantid::NeXus::NXClass
std::shared_ptr< std::vector< NXInfo > >	m_datasets
	Holds info about the datasets in this NXClass. More...

std::shared_ptr< std::vector< NXClassInfo > >	m_groups
	Holds info about the child NXClasses. More...

Protected Attributes inherited from Mantid::NeXus::NXObject
bool	m_open
	Set to true if the object has been open. More...

std::string	m_path
	Keeps the absolute path to the object. More...

Detailed Description

Implements NXdata Nexus class.

Definition at line 795 of file NexusClasses.h.

Constructor & Destructor Documentation

◆ NXData()

Mantid::NeXus::NXData::NXData	(	const NXClass &	parent,
		const std::string &	name
	)

Constructor.

Parameters

parent	:: The parent Nexus class. In terms of HDF it is the group containing the NXClass.
name	:: The name of the NXClass relative to its parent

Definition at line 555 of file NexusClasses.cpp.

Member Function Documentation

◆ NX_class()

std::string Mantid::NeXus::NXData::NX_class ( ) const

inlineoverridevirtual

Nexus class id.

Reimplemented from Mantid::NeXus::NXClass.

Definition at line 804 of file NexusClasses.h.

◆ openData()

template<typename T >

NXDataSetTyped< T > Mantid::NeXus::NXData::openData ( )

inline

Opens the dataset within this NXData with signal=1 attribute.

Definition at line 807 of file NexusClasses.h.

References Mantid::NeXus::NXObject::attributes, and Mantid::NeXus::NXDataSet::open().

◆ openDoubleData()

NXDouble Mantid::NeXus::NXData::openDoubleData ( )

inline

Opens data of double type.

Definition at line 824 of file NexusClasses.h.

Referenced by Mantid::DataHandling::LoadILLSANS::getOmegaBinning(), Mantid::DataHandling::LoadILLSANS::loadDataFromD16ScanMonitors(), Mantid::DataHandling::LoadILLDiffraction::loadDataScan(), and Mantid::DataHandling::LoadNexusProcessed::loadNonEventEntry().

◆ openFloatData()

NXFloat Mantid::NeXus::NXData::openFloatData ( )

inline

Opens data of float type.

Definition at line 826 of file NexusClasses.h.

Referenced by Mantid::DataHandling::LoadLLB::loadDataIntoTheWorkSpace().

◆ openIntData()

NXInt Mantid::NeXus::NXData::openIntData ( )

inline

Opens data of int type.

Definition at line 828 of file NexusClasses.h.

◆ openSizeData()

NXSize Mantid::NeXus::NXData::openSizeData ( )

inline

Opens data of size type.

Definition at line 830 of file NexusClasses.h.

◆ openUIntData()

NXUInt Mantid::NeXus::NXData::openUIntData ( )

inline

Opens data of unsigned int type.

Definition at line 832 of file NexusClasses.h.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NXData()

Member Function Documentation

◆ NX_class()

◆ openData()

◆ openDoubleData()

◆ openFloatData()

◆ openIntData()

◆ openSizeData()

◆ openUIntData()