NexusCPP  3.5.0
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
nxcpp::NexusDataSetInfo Class Reference

#include <nxfile.h>

Inheritance diagram for nxcpp::NexusDataSetInfo:
Inheritance graph
[legend]

Public Member Functions

 NexusDataSetInfo ()
 Constructor. More...
 
 ~NexusDataSetInfo ()
 Destructor. More...
 
void SetInfo (NexusDataType eDataType, int iRank)
 
void Clear ()
 Clears instance. More...
 
Accessors
NexusDataType DataType () const
 Returns the data type. More...
 
int Rank () const
 Returns the data set rank. More...
 
int TotalRank () const
 Returns the whole data set rank. More...
 
int * DimArray () const
 Returns size array of dimensions. More...
 
int * TotalDimArray () const
 
void SetTotalDim (int iTotalRank, int *piTotalDim)
 
int Size () const
 Returns total size. More...
 
bool IsEmpty () const
 Returns 'true' if no data set info is stored. More...
 
unsigned int DatumSize () const
 Returns datum size. More...
 
unsigned int BufferSize () const
 Returns buffer size. More...
 
int * StartArray () const
 Returns array of indices of starting values in Ith dimension. More...
 
int * StartArray ()
 
bool IsSubset () const
 Is the dataset info about a subset? More...
 

Static Public Member Functions

static int DataTypeSize (NexusDataType eDataType)
 Returns size according to a data type. More...
 

Protected Attributes

NexusDataType m_eDataType
 
int m_iRank
 
int m_iTotalRank
 
int * m_piDim
 
int * m_piTotalDim
 
int * m_piStart
 

Detailed Description

NeXus Data set info

This class allow manipulation of NeXus Data sets and subsets

Constructor & Destructor Documentation

◆ NexusDataSetInfo()

nxcpp::NexusDataSetInfo::NexusDataSetInfo ( )

Constructor.

◆ ~NexusDataSetInfo()

nxcpp::NexusDataSetInfo::~NexusDataSetInfo ( )

Destructor.

Member Function Documentation

◆ BufferSize()

unsigned int nxcpp::NexusDataSetInfo::BufferSize ( ) const
inline

Returns buffer size.

◆ Clear()

void nxcpp::NexusDataSetInfo::Clear ( )

Clears instance.

◆ DataType()

NexusDataType nxcpp::NexusDataSetInfo::DataType ( ) const
inline

Returns the data type.

Here is the caller graph for this function:

◆ DataTypeSize()

static int nxcpp::NexusDataSetInfo::DataTypeSize ( NexusDataType  eDataType)
static

Returns size according to a data type.

◆ DatumSize()

unsigned int nxcpp::NexusDataSetInfo::DatumSize ( ) const

Returns datum size.

Here is the caller graph for this function:

◆ DimArray()

int* nxcpp::NexusDataSetInfo::DimArray ( ) const
inline

Returns size array of dimensions.

◆ IsEmpty()

bool nxcpp::NexusDataSetInfo::IsEmpty ( ) const

Returns 'true' if no data set info is stored.

◆ IsSubset()

bool nxcpp::NexusDataSetInfo::IsSubset ( ) const
inline

Is the dataset info about a subset?

◆ Rank()

int nxcpp::NexusDataSetInfo::Rank ( ) const
inline

Returns the data set rank.

◆ SetInfo()

void nxcpp::NexusDataSetInfo::SetInfo ( NexusDataType  eDataType,
int  iRank 
)

Sets datas

Parameters
eDataTypeData type
iRankData rank

◆ SetTotalDim()

void nxcpp::NexusDataSetInfo::SetTotalDim ( int  iTotalRank,
int *  piTotalDim 
)

Set the whole dataset dimension's sizes

Parameters
iTotalRankRank of the whole dataset
piTotalDimDimension sizes of the whole dataset

◆ Size()

int nxcpp::NexusDataSetInfo::Size ( ) const

Returns total size.

◆ StartArray() [1/2]

int* nxcpp::NexusDataSetInfo::StartArray ( ) const
inline

Returns array of indices of starting values in Ith dimension.

◆ StartArray() [2/2]

int* nxcpp::NexusDataSetInfo::StartArray ( )

◆ TotalDimArray()

int* nxcpp::NexusDataSetInfo::TotalDimArray ( ) const
inline

Returns size array of dimensions of the whole dataset

Remarks
can be bigger than the storage array of this NexusDataSetInfo

◆ TotalRank()

int nxcpp::NexusDataSetInfo::TotalRank ( ) const
inline

Returns the whole data set rank.

Member Data Documentation

◆ m_eDataType

NexusDataType nxcpp::NexusDataSetInfo::m_eDataType
protected

◆ m_iRank

int nxcpp::NexusDataSetInfo::m_iRank
protected

◆ m_iTotalRank

int nxcpp::NexusDataSetInfo::m_iTotalRank
protected

◆ m_piDim

int* nxcpp::NexusDataSetInfo::m_piDim
protected

◆ m_piStart

int* nxcpp::NexusDataSetInfo::m_piStart
protected

◆ m_piTotalDim

int* nxcpp::NexusDataSetInfo::m_piTotalDim
protected

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