Mantid
Loading...
Searching...
No Matches
Enumerations | Functions
Mantid::Nexus::IOHelper Namespace Reference

Enumerations

enum class  Narrowing : bool { Allow = true , Prevent = false }
 

Functions

template<typename T , Narrowing narrow = Narrowing::Prevent>
std::vector< T > readNexusSlab (Nexus::File &file, const std::string &entry, DimVector const &start, DimVector const &size)
 Opens the data group if needed, finds the data type, and calls readNexusAnySlab via the RUN_NEXUSIOHELPER_FUNCTION macro.
 
template<typename T , Narrowing narrow = Narrowing::Prevent>
void readNexusSlab (std::vector< T > &out, Nexus::File &file, const std::string &entry, DimVector const &start, DimVector const &size)
 Opens the data group if needed, finds the data type, and calls readNexusAnySlab via the RUN_NEXUSIOHELPER_FUNCTION macro.
 
template<typename T , Narrowing narrow = Narrowing::Prevent>
readNexusValue (Nexus::File &file, const std::string &entry="")
 
template<typename T , Narrowing narrow = Narrowing::Prevent>
std::vector< T > readNexusVector (Nexus::File &file, const std::string &entry="")
 Opens the data group if needed, finds the data type, computes the data size, and calls readNexusAnyVector via the RUN_NEXUSIOHELPER_FUNCTION macro.
 
template<typename T , Narrowing narrow = Narrowing::Prevent>
void readNexusVector (std::vector< T > &out, Nexus::File &file, const std::string &entry="")
 Opens the data group if needed, finds the data type, computes the data size, and calls readNexusAnyVector via the RUN_NEXUSIOHELPER_FUNCTION macro.
 

Enumeration Type Documentation

◆ Narrowing

enum class Mantid::Nexus::IOHelper::Narrowing : bool
strong
Enumerator
Allow 
Prevent 

Definition at line 20 of file NexusIOHelper.h.

Function Documentation

◆ readNexusSlab() [1/2]

template<typename T , Narrowing narrow = Narrowing::Prevent>
std::vector< T > Mantid::Nexus::IOHelper::readNexusSlab ( Nexus::File &  file,
const std::string &  entry,
DimVector const &  start,
DimVector const &  size 
)

Opens the data group if needed, finds the data type, and calls readNexusAnySlab via the RUN_NEXUSIOHELPER_FUNCTION macro.

Definition at line 204 of file NexusIOHelper.h.

References RUN_NEXUSIOHELPER_FUNCTION.

◆ readNexusSlab() [2/2]

template<typename T , Narrowing narrow = Narrowing::Prevent>
void Mantid::Nexus::IOHelper::readNexusSlab ( std::vector< T > &  out,
Nexus::File &  file,
const std::string &  entry,
DimVector const &  start,
DimVector const &  size 
)

Opens the data group if needed, finds the data type, and calls readNexusAnySlab via the RUN_NEXUSIOHELPER_FUNCTION macro.

The provided output buffer is filled.

Definition at line 216 of file NexusIOHelper.h.

References RUN_NEXUSIOHELPER_FUNCTION.

◆ readNexusValue()

template<typename T , Narrowing narrow = Narrowing::Prevent>
T Mantid::Nexus::IOHelper::readNexusValue ( Nexus::File &  file,
const std::string &  entry = "" 
)

Definition at line 224 of file NexusIOHelper.h.

References RUN_NEXUSIOHELPER_FUNCTION.

◆ readNexusVector() [1/2]

template<typename T , Narrowing narrow = Narrowing::Prevent>
std::vector< T > Mantid::Nexus::IOHelper::readNexusVector ( Nexus::File &  file,
const std::string &  entry = "" 
)

Opens the data group if needed, finds the data type, computes the data size, and calls readNexusAnyVector via the RUN_NEXUSIOHELPER_FUNCTION macro.

Version that allows Narrowing.

Definition at line 183 of file NexusIOHelper.h.

References RUN_NEXUSIOHELPER_FUNCTION.

◆ readNexusVector() [2/2]

template<typename T , Narrowing narrow = Narrowing::Prevent>
void Mantid::Nexus::IOHelper::readNexusVector ( std::vector< T > &  out,
Nexus::File &  file,
const std::string &  entry = "" 
)

Opens the data group if needed, finds the data type, computes the data size, and calls readNexusAnyVector via the RUN_NEXUSIOHELPER_FUNCTION macro.

The provided output buffer is filled.

Definition at line 194 of file NexusIOHelper.h.

References RUN_NEXUSIOHELPER_FUNCTION.