Implements NXentry Nexus class. More...

#include <NexusClasses.h>

Inheritance diagram for Mantid::NeXus::NXEntry:

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

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

NXData	openNXData (const std::string &name) const
	Opens a NXData. More...

NXInstrument	openNXInstrument (const std::string &name) const
	Opens a NXInstrument. 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 NXentry Nexus class.

Definition at line 898 of file NexusClasses.h.

Constructor & Destructor Documentation

◆ NXEntry()

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

inline

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 905 of file NexusClasses.h.

Member Function Documentation

◆ NX_class()

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

inlineoverridevirtual

Nexus class id.

Reimplemented from Mantid::NeXus::NXClass.

Definition at line 907 of file NexusClasses.h.

◆ openNXData()

NXData Mantid::NeXus::NXEntry::openNXData ( const std::string & name ) const

inline

Opens a NXData.

Parameters

name	:: The name of the class

Returns: the nxdata entry

Definition at line 912 of file NexusClasses.h.

◆ openNXInstrument()

NXInstrument Mantid::NeXus::NXEntry::openNXInstrument ( const std::string & name ) const

inline

Opens a NXInstrument.

Parameters

name	:: The name of the class

Returns: the instrument

Definition at line 917 of file NexusClasses.h.

Referenced by Mantid::DataHandling::LoadMuonNexus2::doExec(), and Mantid::DataHandling::LoadNexusProcessed2::extractMappingInfoNew().

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

Framework/Nexus/inc/MantidNexus/NexusClasses.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NXEntry()

Member Function Documentation

◆ NX_class()

◆ openNXData()

◆ openNXInstrument()