hdf5writer.h

Go to the documentation of this file.

#pragma once
/*+
________________________________________________________________________
 
 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        Bert
 Date:          March 2018
________________________________________________________________________
 
-*/
 
#include "hdf5access.h"
 
 
namespace HDF5
{
 
mExpClass(General) Writer : public Access
{ mODTextTranslationClass(Writer)
public:
 
    uiRetVal            open4Edit(const char*);
 
    virtual void        setCompressionLevel(unsigned)           {}
    virtual H5::Group*  ensureGroup(const char* grpnm,uiRetVal&) = 0;
 
    uiRetVal            createDataSet(const DataSetKey&,const ArrayNDInfo&,
                                      ODDataType);
    uiRetVal            createDataSet(const DataSetKey&,int,ODDataType);
    uiRetVal            createDataSetIfMissing(const DataSetKey&,ODDataType,
                                const ArrayNDInfo& addedsz,
                                const ArrayNDInfo& changedir,
                                PtrMan<ArrayNDInfo>* existsinfo =nullptr);
    uiRetVal            createDataSetIfMissing(const DataSetKey&,ODDataType,
                                int addedsz,int changedir=1,
                                int* existsnrsamples =nullptr);
    uiRetVal            createTextDataSet(const DataSetKey&);
    uiRetVal            resizeDataSet(const DataSetKey&,const ArrayNDInfo&);
 
    uiRetVal            putSlab(const DataSetKey&,const SlabSpec&,const void*);
    uiRetVal            putAll(const DataSetKey&,const void*);
    template <class T>
    uiRetVal            put(const DataSetKey&,const T*,int sz);
    template <class T>
    uiRetVal            put(const DataSetKey&,const TypeSet<T>&);
    uiRetVal            put(const DataSetKey&,const BufferStringSet&);
 
                        // null = root scope
    virtual void        setAttribute(const char* ky,const char* val,
                                     const DataSetKey* =nullptr)        = 0;
    uiRetVal            removeAttribute(const char*,
                                     const DataSetKey* = nullptr);
    uiRetVal            removeAllAttributes(const DataSetKey* = nullptr);
#define mHDF5DeclFns(fnnm,type) \
    virtual void        fnnm##Attribute(const char*,type,\
                                        const DataSetKey* =nullptr)     = 0;
                        mHDF5DeclFns(set,od_int16);
                        mHDF5DeclFns(set,od_uint16);
                        mHDF5DeclFns(set,od_int32);
                        mHDF5DeclFns(set,od_uint32);
                        mHDF5DeclFns(set,od_int64);
                        mHDF5DeclFns(set,od_uint64);
                        mHDF5DeclFns(set,float);
                        mHDF5DeclFns(set,double);
#undef mHDF5DeclFns
    uiRetVal            set(const IOPar&,const DataSetKey* =nullptr);
 
    bool                deleteObject(const DataSetKey&);
 
    virtual bool        isReader() const        { return false; }
    virtual Reader*     createCoupledReader() const                     = 0;
 
    mDeprecated("Set from DataSetKey")
    virtual void        setChunkSize(int)                               = 0;
    mDeprecated("Set per dataset, not globally")
    virtual void        setEditableCreation(bool yn)                    = 0;
 
private:
 
    virtual H5::DataSet*        crDS(const DataSetKey&,const ArrayNDInfo&,
                                     ODDataType,uiRetVal&)              = 0;
    virtual H5::DataSet*        crTxtDS(const DataSetKey&,uiRetVal&)    = 0;
    virtual void        reSzDS(const ArrayNDInfo&,H5::DataSet&,
                                uiRetVal&)                              = 0;
    virtual void        ptSlab(const SlabSpec&,const void*,
                               H5::DataSet&,uiRetVal&)  = 0;
    virtual void        ptAll(const void*,H5::DataSet&,uiRetVal&)       = 0;
    virtual void        ptStrings(const BufferStringSet&,
                                  H5::Group&,H5::DataSet*,
                                  const char* dsnm,uiRetVal&) = 0;
    virtual void        rmAttrib(const char*,H5::H5Object&)             = 0;
    virtual void        rmAllAttribs(H5::H5Object&)                     = 0;
 
    virtual void        ptInfo(const IOPar&,H5::H5Object&,uiRetVal&)    = 0;
 
    virtual bool        rmObj(const DataSetKey&)                        = 0;
 
};
 
 
template <class T>
inline uiRetVal Writer::put( const DataSetKey& dsky, const TypeSet<T>& vals )
{
    return put( dsky, vals.arr(), vals.size() );
}
 
 
template <class T>
inline uiRetVal Writer::put( const DataSetKey& dsky, const T* vals, int sz )
{
    uiRetVal uirv;
    if ( !vals )
        return uirv;
    else if ( !hasDataSet(dsky) )
        uirv = createDataSet( dsky, sz, OD::GetDataRepType<T>() );
    if ( uirv.isOK() )
        uirv = putAll( dsky, vals );
 
    return uirv;
}
 
} // namespace HDF5