OpendTect  6.6
Public Types | Public Member Functions | Static Protected Member Functions | Private Member Functions | List of all members
HDF5::Reader Class Referenceabstract
General

Reads HDF5 file data. More...

Inheritance diagram for HDF5::Reader:
[legend]

Public Types

typedef TypeSet< NDPosBuf > NDPosBufSet
 

Public Member Functions

size_type dimSize (const DataSetKey &, dim_idx_type, uiRetVal &) const
 
uiRetVal get (const DataSetKey &, BufferStringSet &) const
 
template<class T >
uiRetVal get (const DataSetKey &, TypeSet< T > &) const
 
uiRetVal get (IOPar &, const DataSetKey *=nullptr) const
 
uiRetVal getAll (const DataSetKey &, void *) const
 Get the entire data set in current scope. More...
 
virtual bool getAttribute (const char *, BufferString &, const DataSetKey *=nullptr) const =0
 
virtual bool getAttribute (const char *, double &, const DataSetKey *=nullptr) const =0
 
virtual bool getAttribute (const char *, float &, const DataSetKey *=nullptr) const =0
 
virtual bool getAttribute (const char *, od_int16 &, const DataSetKey *=nullptr) const =0
 
virtual bool getAttribute (const char *, od_int32 &, const DataSetKey *=nullptr) const =0
 
virtual bool getAttribute (const char *, od_int64 &, const DataSetKey *=nullptr) const =0
 
virtual bool getAttribute (const char *, od_uint16 &, const DataSetKey *=nullptr) const =0
 
virtual bool getAttribute (const char *, od_uint32 &, const DataSetKey *=nullptr) const =0
 
virtual bool getAttribute (const char *, od_uint64 &, const DataSetKey *=nullptr) const =0
 
uiRetVal getAttributeNames (BufferStringSet &, const DataSetKey *=nullptr) const
 
virtual void getDataSets (const char *fullgrpnm, BufferStringSet &) const =0
 Pass a full group name. More...
 
ArrayNDInfo * getDataSizes (const DataSetKey &, uiRetVal &) const
 
ODDataType getDataType (const DataSetKey &, uiRetVal &) const
 
virtual void getGroups (BufferStringSet &) const =0
 All groups with full names (recursive) More...
 
virtual int getNrAttributes (const DataSetKey *=nullptr) const =0
 
nr_dims_type getNrDims (const DataSetKey &, uiRetVal &) const
 
uiRetVal getSlab (const DataSetKey &, const SlabSpec &, void *) const
 
uiRetVal getValue (const DataSetKey &, NDPos, void *) const
 Get a single point value. More...
 
uiRetVal getValues (const DataSetKey &, const NDPosBufSet &, void *) const
 Get a set of distinct points' values. More...
 
virtual bool hasAttribute (const char *, const DataSetKey *=nullptr) const =0
 
virtual bool isReader () const
 
nr_dims_type nrDims () const
 
virtual uiRetVal readJSonAttribute (const char *, OD::JSON::ValueSet &, const DataSetKey *=nullptr) const =0
 
- Public Member Functions inherited from HDF5::Access
virtual ~Access ()
 
virtual od_int64 curGroupID () const =0
 
virtual const char * fileName () const =0
 
H5::H5File * getHDF5File ()
 
bool hasDataSet (const DataSetKey &) const
 
bool hasGroup (const char *grpnm) const
 
bool isOpen () const
 
uiRetVal open (const char *)
 
uiString sCantSetScope (const DataSetKey &) const
 
virtual DataSetKey scope () const =0
 

Static Protected Member Functions

static uiString sBadDataSpace ()
 
- Static Protected Member Functions inherited from HDF5::Access
static uiString sFileNotOpen ()
 
static uiString sHDF5Err (const uiString &)
 
static const char * sNeedScope ()
 
static const char * sNoDataPassed ()
 
static const char * sOpenFileFirst ()
 

Private Member Functions

size_type dimSize (const H5::DataSet &, dim_idx_type) const
 
virtual void gtAll (const H5::DataSet &, void *, uiRetVal &) const =0
 
virtual void gtAttribNames (const H5::H5Object &, BufferStringSet &) const =0
 
virtual ArrayNDInfo * gtDataSizes (const H5::DataSet &) const =0
 
virtual ODDataType gtDataType (const H5::DataSet &) const =0
 
virtual void gtInfo (const H5::H5Object &, IOPar &, uiRetVal &) const =0
 
virtual nr_dims_type gtNrDims () const =0
 
virtual void gtSlab (const H5::DataSet &, const SlabSpec &, void *, uiRetVal &) const =0
 
virtual void gtStrings (const H5::DataSet &, BufferStringSet &, uiRetVal &) const =0
 
virtual void gtValues (const H5::DataSet &, const NDPosBufSet &, void *, uiRetVal &) const =0
 

Additional Inherited Members

- Static Public Member Functions inherited from HDF5::Access
static bool isEnabled (const char *fortype=0)
 
static bool isEnvBlocked (const char *fortype=0)
 
static bool isHDF5File (const char *)
 
static uiString sCannotReadDataSet (const DataSetKey &)
 
static uiString sDataSetNotFound (const DataSetKey &)
 
static const char * sFileExtension ()
 
static uiString sHDF5FileNoLongerAccessibe ()
 
static uiString sHDF5NotAvailable ()
 
static uiString sHDF5NotAvailable (const char *fnm)
 
static uiString sHDF5PackageDispName ()
 
static uiString sNotHDF5File (const char *)
 
static const char * sSettingsEnabKey ()
 
- Public Attributes inherited from HDF5::Access
 mTypeDefArrNDTypes
 
- Protected Member Functions inherited from HDF5::Access
 Access ()
 
virtual void closeFile ()=0
 
virtual H5::DataSet * getDSScope (const DataSetKey &) const =0
 Returns (new) scope. null for root scope. More...
 
virtual H5::Group * getGrpScope (const DataSetKey *) const =0
 
virtual H5::H5Object * getScope (const DataSetKey *) const =0
 
virtual void openFile (const char *, uiRetVal &, bool ed)=0
 
virtual H5::DataSet * setDSScope (const DataSetKey &)=0
 
virtual H5::Group * setGrpScope (const DataSetKey *)=0
 
virtual H5::H5Object * setScope (const DataSetKey *)=0
 
- Protected Attributes inherited from HDF5::Access
H5::H5File * file_
 
bool myfile_
 

Detailed Description

Reads HDF5 file data.

You can only get actual data after you set the scope, i.e. you have to select the 'current' DataSet using the DataSetKey. Leave the dataset name empty only for retrieving attributes for the entire group.

<>

Member Typedef Documentation

◆ NDPosBufSet

typedef TypeSet<NDPosBuf> HDF5::Reader::NDPosBufSet

Member Function Documentation

◆ dimSize() [1/2]

size_type HDF5::Reader::dimSize ( const DataSetKey &  ,
dim_idx_type  ,
uiRetVal &   
) const

◆ dimSize() [2/2]

size_type HDF5::Reader::dimSize ( const H5::DataSet &  ,
dim_idx_type   
) const
private

◆ get() [1/3]

uiRetVal HDF5::Reader::get ( const DataSetKey &  ,
BufferStringSet &   
) const

◆ get() [2/3]

template<class T >
uiRetVal HDF5::Reader::get ( const DataSetKey &  dsky,
TypeSet< T > &  vals 
) const
inline

◆ get() [3/3]

uiRetVal HDF5::Reader::get ( IOPar &  ,
const DataSetKey *  = nullptr 
) const

◆ getAll()

uiRetVal HDF5::Reader::getAll ( const DataSetKey &  ,
void *   
) const

Get the entire data set in current scope.

◆ getAttribute() [1/9]

virtual bool HDF5::Reader::getAttribute ( const char *  ,
BufferString &  ,
const DataSetKey *  = nullptr 
) const
pure virtual

Implemented in HDF5::ReaderImpl.

◆ getAttribute() [2/9]

virtual bool HDF5::Reader::getAttribute ( const char *  ,
double &  ,
const DataSetKey *  = nullptr 
) const
pure virtual

Implemented in HDF5::ReaderImpl.

◆ getAttribute() [3/9]

virtual bool HDF5::Reader::getAttribute ( const char *  ,
float &  ,
const DataSetKey *  = nullptr 
) const
pure virtual

Implemented in HDF5::ReaderImpl.

◆ getAttribute() [4/9]

virtual bool HDF5::Reader::getAttribute ( const char *  ,
od_int16 &  ,
const DataSetKey *  = nullptr 
) const
pure virtual

Implemented in HDF5::ReaderImpl.

◆ getAttribute() [5/9]

virtual bool HDF5::Reader::getAttribute ( const char *  ,
od_int32 &  ,
const DataSetKey *  = nullptr 
) const
pure virtual

Implemented in HDF5::ReaderImpl.

◆ getAttribute() [6/9]

virtual bool HDF5::Reader::getAttribute ( const char *  ,
od_int64 &  ,
const DataSetKey *  = nullptr 
) const
pure virtual

Implemented in HDF5::ReaderImpl.

◆ getAttribute() [7/9]

virtual bool HDF5::Reader::getAttribute ( const char *  ,
od_uint16 &  ,
const DataSetKey *  = nullptr 
) const
pure virtual

Implemented in HDF5::ReaderImpl.

◆ getAttribute() [8/9]

virtual bool HDF5::Reader::getAttribute ( const char *  ,
od_uint32 &  ,
const DataSetKey *  = nullptr 
) const
pure virtual

Implemented in HDF5::ReaderImpl.

◆ getAttribute() [9/9]

virtual bool HDF5::Reader::getAttribute ( const char *  ,
od_uint64 &  ,
const DataSetKey *  = nullptr 
) const
pure virtual

Implemented in HDF5::ReaderImpl.

◆ getAttributeNames()

uiRetVal HDF5::Reader::getAttributeNames ( BufferStringSet &  ,
const DataSetKey *  = nullptr 
) const

◆ getDataSets()

virtual void HDF5::Reader::getDataSets ( const char *  fullgrpnm,
BufferStringSet &   
) const
pure virtual

Pass a full group name.

Implemented in HDF5::ReaderImpl.

◆ getDataSizes()

ArrayNDInfo* HDF5::Reader::getDataSizes ( const DataSetKey &  ,
uiRetVal &   
) const

◆ getDataType()

ODDataType HDF5::Reader::getDataType ( const DataSetKey &  ,
uiRetVal &   
) const

◆ getGroups()

virtual void HDF5::Reader::getGroups ( BufferStringSet &  ) const
pure virtual

All groups with full names (recursive)

Implemented in HDF5::ReaderImpl.

◆ getNrAttributes()

virtual int HDF5::Reader::getNrAttributes ( const DataSetKey *  = nullptr) const
pure virtual

Implemented in HDF5::ReaderImpl.

◆ getNrDims()

nr_dims_type HDF5::Reader::getNrDims ( const DataSetKey &  ,
uiRetVal &   
) const

◆ getSlab()

uiRetVal HDF5::Reader::getSlab ( const DataSetKey &  ,
const SlabSpec &  ,
void *   
) const

◆ getValue()

uiRetVal HDF5::Reader::getValue ( const DataSetKey &  ,
NDPos  ,
void *   
) const

Get a single point value.

◆ getValues()

uiRetVal HDF5::Reader::getValues ( const DataSetKey &  ,
const NDPosBufSet &  ,
void *   
) const

Get a set of distinct points' values.

◆ gtAll()

virtual void HDF5::Reader::gtAll ( const H5::DataSet &  ,
void *  ,
uiRetVal &   
) const
privatepure virtual

Implemented in HDF5::ReaderImpl.

◆ gtAttribNames()

virtual void HDF5::Reader::gtAttribNames ( const H5::H5Object &  ,
BufferStringSet &   
) const
privatepure virtual

Implemented in HDF5::ReaderImpl.

◆ gtDataSizes()

virtual ArrayNDInfo* HDF5::Reader::gtDataSizes ( const H5::DataSet &  ) const
privatepure virtual

Implemented in HDF5::ReaderImpl.

◆ gtDataType()

virtual ODDataType HDF5::Reader::gtDataType ( const H5::DataSet &  ) const
privatepure virtual

Implemented in HDF5::ReaderImpl.

◆ gtInfo()

virtual void HDF5::Reader::gtInfo ( const H5::H5Object &  ,
IOPar &  ,
uiRetVal &   
) const
privatepure virtual

Implemented in HDF5::ReaderImpl.

◆ gtNrDims()

virtual nr_dims_type HDF5::Reader::gtNrDims ( ) const
privatepure virtual

Implemented in HDF5::ReaderImpl.

◆ gtSlab()

virtual void HDF5::Reader::gtSlab ( const H5::DataSet &  ,
const SlabSpec &  ,
void *  ,
uiRetVal &   
) const
privatepure virtual

Implemented in HDF5::ReaderImpl.

◆ gtStrings()

virtual void HDF5::Reader::gtStrings ( const H5::DataSet &  ,
BufferStringSet &  ,
uiRetVal &   
) const
privatepure virtual

Implemented in HDF5::ReaderImpl.

◆ gtValues()

virtual void HDF5::Reader::gtValues ( const H5::DataSet &  ,
const NDPosBufSet &  ,
void *  ,
uiRetVal &   
) const
privatepure virtual

Implemented in HDF5::ReaderImpl.

◆ hasAttribute()

virtual bool HDF5::Reader::hasAttribute ( const char *  ,
const DataSetKey *  = nullptr 
) const
pure virtual

Implemented in HDF5::ReaderImpl.

◆ isReader()

virtual bool HDF5::Reader::isReader ( ) const
inlinevirtual

Implements HDF5::Access.

◆ nrDims()

nr_dims_type HDF5::Reader::nrDims ( ) const
inline

◆ readJSonAttribute()

virtual uiRetVal HDF5::Reader::readJSonAttribute ( const char *  ,
OD::JSON::ValueSet &  ,
const DataSetKey *  = nullptr 
) const
pure virtual

Implemented in HDF5::ReaderImpl.

◆ sBadDataSpace()

static uiString HDF5::Reader::sBadDataSpace ( )
inlinestaticprotected

Generated at for the OpendTect seismic interpretation project. Copyright (C): dGB Beheer B.V. 1995-2022