HdfProxy.h

/*-----------------------------------------------------------------------
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"; you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-----------------------------------------------------------------------*/
#pragma once

#include "common/AbstractHdfProxy.h"

namespace COMMON_NS
{
    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_NS::AbstractHdfProxy(fromGsoap, packageDirAbsolutePath, externalFilePath), hdfFile(-1), compressionLevel(0) {}

        HdfProxy(gsoap_eml2_1::_eml21__EpcExternalPartReference* fromGsoap, const std::string & packageDirAbsolutePath, const std::string & externalFilePath) :
            COMMON_NS::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);

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

        void selectArrayNdOfValues(
            const std::string & datasetName,
            unsigned long long * blockCountPerDimension,
            unsigned long long * offsetInEachDimension,
            unsigned long long * strideInEachDimension,
            unsigned long long * blockSizeInEachDimension,
            const unsigned int & numDimensions,
            bool newSelection,
            int & dataset,
            int & filespace);

        void readArrayNdOfValues(
            int dataset,
            int filespace,
            void* values, 
            unsigned long long slabSize, 
            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 readArrayNdOfDoubleValues(
            const std::string & datasetName, double* values,
            unsigned long long * blockCountPerDimension,
            unsigned long long * offsetInEachDimension,
            unsigned long long * strideInEachDimension,
            unsigned long long * blockSizeInEachDimension,
            const unsigned int & numDimensions);

        void readArrayNdOfDoubleValues(
            int dataset,
            int filespace,
            void* values,
            unsigned long long slabSize);

        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;
    };
}