HdfProxy.h

/*-----------------------------------------------------------------------
Copyright F2I-CONSULTING, (2014-2017)

philippe.verney@f2i-consulting.com

This software is a computer program whose purpose is to access to data formatted using Energistics standards.

This software is governed by the CeCILL-B license under French law and
abiding by the rules of distribution of free software.  You can  use, 
modify and/ or redistribute the software under the terms of the CeCILL-B
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info". 

As a counterpart to the access to the source code and  rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty  and the software's author,  the holder of the
economic rights,  and the successive licensors  have only  limited
liability. 

In this respect, the user's attention is drawn to the risks associated
with loading,  using,  modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean  that it is complicated to manipulate,  and  that  also
therefore means  that it is reserved for developers  and  experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or 
data to be ensured and,  more generally, to use and operate it in the 
same conditions as regards security. 

The fact that you are presently reading this means that you have had
knowledge of the CeCILL-B license and that you accept its terms.
-----------------------------------------------------------------------*/
#pragma once

#include "common/AbstractHdfProxy.h"

namespace common
{
    class DLL_IMPORT_OR_EXPORT HdfProxy : public AbstractHdfProxy
    {
    protected:

        HdfProxy(gsoap_resqml2_0_1::_eml20__EpcExternalPartReference* fromGsoap, const std::string & packageDirAbsolutePath, const std::string & externalFilePath) :
            common::AbstractHdfProxy(fromGsoap, packageDirAbsolutePath, externalFilePath), hdfFile(-1), compressionLevel(0) {}

        HdfProxy(gsoap_eml2_1::_eml21__EpcExternalPartReference* fromGsoap, const std::string & packageDirAbsolutePath, const std::string & externalFilePath) :
            common::AbstractHdfProxy(fromGsoap, packageDirAbsolutePath, externalFilePath), hdfFile(-1), compressionLevel(0) {}

        HdfProxy(const std::string & packageDirAbsolutePath, const std::string & externalFilePath);

        void readArrayNdOfValues(const std::string & datasetName, void* values, const int & datatype);

        void readArrayNdOfValues(
          const std::string & datasetName,
          void* values,
          unsigned long long * numValuesInEachDimension,
          unsigned long long * offsetInEachDimension,
          const unsigned int & numDimensions,
          const int & datatype);

    public:

        ~HdfProxy() {close();}

        void open();

        bool isOpened() const {return hdfFile != -1;}

        void close();

        /*
        * Get the used (native) datatype in a dataset
        * To compare with H5T_NATIVE_INT, H5T_NATIVE_UINT, H5T_NATIVE_FLOAT, etc...
        */
        int getHdfDatatypeInDataset(const std::string & groupName) const;

        int getHdfDatatypeClassInDataset(const std::string & datasetName) const;
        
        void writeItemizedListOfList(const std::string & groupName,
            const std::string & name,
            const int & cumulativeLengthDatatype,
            void * cumulativeLength,
            const unsigned long long & cumulativeLengthSize,
            const int & elementsDatatype,
            void * elements,
            const unsigned long long & elementsSize);

        unsigned int getDimensionCount(const std::string & datasetName);

        signed long long getElementCount(const std::string & datasetName);

        void setCompressionLevel(const unsigned int & newCompressionLevel) {if (newCompressionLevel > 9) compressionLevel = 9; else compressionLevel = newCompressionLevel;}

        void writeArrayNdOfFloatValues(const std::string & groupName,
            const std::string & name,
            float * floatValues,
            unsigned long long * numValuesInEachDimension,
            const unsigned int & numDimensions);

        void writeArrayNdOfDoubleValues(const std::string & groupName,
            const std::string & name,
            double * dblValues,
            unsigned long long * numValuesInEachDimension,
            const unsigned int & numDimensions);

        void writeArrayNdOfCharValues(const std::string & groupName,
            const std::string & name,
            char * intValues,
            unsigned long long * numValuesInEachDimension,
            const unsigned int & numDimensions);

        void writeArrayNdOfIntValues(const std::string & groupName,
            const std::string & name,
            int * intValues,
            unsigned long long * numValuesInEachDimension,
            const unsigned int & numDimensions);

        void writeArrayNdOfGSoapULong64Values(const std::string & groupName,
            const std::string & name,
            ULONG64 * ulong64Values,
            unsigned long long * numValuesInEachDimension,
            const unsigned int & numDimensions);

        void writeArrayNd(const std::string & groupName,
            const std::string & name,
            const int & datatype,
            void * values,
            unsigned long long * numValuesInEachDimension,
            const unsigned int & numDimensions);

        void createArrayNd(
            const std::string& groupName,
            const std::string& name,
            const int & datatype,
            unsigned long long* numValuesInEachDimension,
            const unsigned int& numDimensions
        );

        void writeArrayNdSlab(
            const std::string& groupName,
            const std::string& name,
            const int & datatype,
            void* values,
            unsigned long long* numValuesInEachDimension,
            unsigned long long* offsetValuesInEachDimension,
            const unsigned int& numDimensions
        );

        void writeGroupAttributes(const std::string & groupName,
            const std::vector<std::string> & attributeNames,
            const std::vector<std::string> & values);

        void writeGroupAttribute(const std::string & groupName,
            const std::string & attributeName,
            const std::vector<std::string> & values);

        void writeGroupAttributes(const std::string & groupName,
            const std::vector<std::string> & attributeNames,
            const std::vector<double> & values);

        void writeGroupAttributes(const std::string & groupName,
            const std::vector<std::string> & attributeNames,
            const std::vector<int> & values);

        void writeDatasetAttributes(const std::string & datasetName,
            const std::vector<std::string> & attributeNames,
            const std::vector<std::string> & values);

        void writeDatasetAttribute(const std::string & datasetName,
            const std::string & attributeName,
            const std::vector<std::string> & values);

        void writeDatasetAttributes(const std::string & datasetName,
            const std::vector<std::string> & attributeNames,
            const std::vector<double> & values);

        void writeDatasetAttributes(const std::string & datasetName,
            const std::vector<std::string> & attributeNames,
            const std::vector<int> & values);

        std::string readStringAttribute(const std::string & obj_name,
            const std::string & attr_name) const;

        std::vector<std::string> readStringArrayAttribute(const std::string & obj_name,
            const std::string & attr_name) const;

        double readDoubleAttribute(const std::string & obj_name,
            const std::string & attr_name) const;

        LONG64 readLongAttribute(const std::string & obj_name,
            const std::string & attr_name) const;

        void readArrayNdOfDoubleValues(const std::string & datasetName, double* values);

        void readArrayNdOfDoubleValues(
          const std::string & datasetName,
          double* values,
          unsigned long long * numValuesInEachDimension,
          unsigned long long * offsetInEachDimension,
          const unsigned int & numDimensions
          );

        void readArrayNdOfFloatValues(const std::string & datasetName, float* values);

        void readArrayNdOfFloatValues(
            const std::string & datasetName, 
            float* values, 
            unsigned long long * numValuesInEachDimension,
            unsigned long long * offsetInEachDimension,
            const unsigned int & numDimensions
        );

        void readArrayNdOfGSoapLong64Values(const std::string & datasetName, LONG64* values);
    
        void readArrayNdOfGSoapULong64Values(const std::string & datasetName, ULONG64* values);

        void readArrayNdOfLongValues(const std::string & datasetName, long* values);

        void readArrayNdOfLongValues(
            const std::string & datasetName, 
            long* values, 
            unsigned long long * numValuesInEachDimension,
            unsigned long long * offsetInEachDimension,
            const unsigned int & numDimensions
        );

        void readArrayNdOfULongValues(const std::string & datasetName, unsigned long* values);

        void readArrayNdOfIntValues(const std::string & datasetName, int* values);

        void readArrayNdOfIntValues(
            const std::string & datasetName,
            int* values,
            unsigned long long * numValuesInEachDimension,
            unsigned long long * offsetInEachDimension,
            const unsigned int & numDimensions
        );

        void readArrayNdOfUIntValues(const std::string & datasetName, unsigned int* values);

        void readArrayNdOfShortValues(const std::string & datasetName, short* values);

        void readArrayNdOfUShortValues(const std::string & datasetName, unsigned short* values);

        void readArrayNdOfCharValues(const std::string & datasetName, char* values);

        void readArrayNdOfUCharValues(const std::string & datasetName, unsigned char* values);

        std::vector<unsigned long long> readArrayDimensions(const std::string & datasetName);

        bool exist(const std::string & absolutePathInHdfFile) const;

    protected:
        
        virtual int openOrCreateRootGroup();

        int openOrCreateGroupInRootGroup(const std::string & groupName);

        int hdfFile;

        unsigned int compressionLevel;
    };
}