NDFileHDF5Dataset.h

Go to the documentation of this file.

#ifndef NDFILEHDF5DATASET_H_
#define NDFILEHDF5DATASET_H_

#include <string>
#include <hdf5.h>
#include "NDPluginFile.h"
#include "NDFileHDF5VersionCheck.h"

class NDFileHDF5Dataset
{
  public:
    NDFileHDF5Dataset(asynUser *pAsynUser, const std::string& name, hid_t dataset);
    virtual ~NDFileHDF5Dataset();

    asynStatus configureDims(NDArray *pArray, bool multiframe, int extradimensions, int *extra_dims, int *user_chunking);
    asynStatus extendDataSet(int extradims);
    asynStatus extendDataSet(int extradims, hsize_t *offsets);
    asynStatus verifyChunking(NDArray *pArray);
    void configureCompression(Codec_t codec);
    asynStatus writeFile(NDArray *pArray, hid_t datatype, hid_t dataspace, hsize_t *framesize);
    hid_t getHandle();
    asynStatus flushDataset();
    hsize_t getDim(int index);
    hsize_t getMaxDim(int index);
    hsize_t getOffset(int index);
    hsize_t getVirtualDim(int index);

  private:

    asynUser    *pAsynUser_;   // Pointer to the asynUser structure
    std::string name_;         // Name of this dataset
    hid_t       dataset_;      // Dataset handle
    int         nextRecord_; 
    int         arrayDims[ND_ARRAY_MAX_DIMS];
    bool        multiFrame_;   // Whether this is a multi frame dataset
    int         rank_;         // number of dimensions
    int         extra_rank_;   // number of extra dimensions
    hsize_t     *dims_;        // Array of current dimension sizes. This updates as various dimensions grow.
    hsize_t     *chunkdims_;   // Array of current configured chunk dimension sizes.
    hsize_t     *maxdims_;     // Array of maximum dimension sizes. The value -1 is HDF5 term for infinite.
    hsize_t     *offset_;      // Array of current offset in each dimension. The frame dimensions always have
                               // 0 offset but additional dimensions may grow as new frames are added.
    hsize_t     *virtualdims_; // The desired sizes of the extra (virtual) dimensions: {Y, X, n}
    Codec_t codec;             // Definition of codec used to compress the data.
    char        *ptrDimensionNames[ND_ARRAY_MAX_DIMS]; // Array of strings with human readable names for each dimension
    char        *dimsreport_;  // A string which contain a verbose report of all dimension sizes. The method getDimsReport fill in this
};


#endif