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 "AbstractHdfProxy.h"
 
#include <unordered_map>
 
namespace EML2_NS
{
    class HdfProxy : public AbstractHdfProxy
    {
    public:
 
        HdfProxy(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : AbstractHdfProxy(partialObject), hdfFile(-1), compressionLevel(0) {}
 
        HdfProxy(const COMMON_NS::DataObjectReference& dor) : AbstractHdfProxy(dor), hdfFile(-1), compressionLevel(0) {}
 
        virtual ~HdfProxy() { close(); }
 
        void open() override;
 
        DLL_IMPORT_OR_EXPORT bool isOpened() const final { return hdfFile != -1; }
 
        void close() final;
 
        COMMON_NS::AbstractObject::hdfDatatypeEnum getHdfDatatypeInDataset(const std::string& groupName) final;
 
        int getHdfDatatypeClassInDataset(const std::string& datasetName) final;
 
        void writeItemizedListOfList(const std::string& groupName,
            const std::string& name,
            hdf5_hid_t cumulativeLengthDatatype,
            const void* cumulativeLength,
            unsigned long long cumulativeLengthSize,
            hdf5_hid_t elementsDatatype,
            const void* elements,
            unsigned long long elementsSize) final;
 
        unsigned int getDimensionCount(const std::string& datasetName) final;
 
        std::vector<unsigned long long> getElementCountPerDimension(const std::string & datasetName) final;
 
        signed long long getElementCount(const std::string& datasetName) final;
 
        DLL_IMPORT_OR_EXPORT void setCompressionLevel(unsigned int newCompressionLevel) final {
            compressionLevel = newCompressionLevel > 9 ? 9 : newCompressionLevel;
        }
 
        void writeArrayNdOfFloatValues(const std::string& groupName,
            const std::string& name,
            const float* floatValues,
            const unsigned long long* numValuesInEachDimension,
            unsigned int numDimensions) final;
 
        void writeArrayNdOfDoubleValues(const std::string& groupName,
            const std::string& name,
            const double* dblValues,
            const unsigned long long* numValuesInEachDimension,
            unsigned int numDimensions) final;
 
        void writeArrayNdOfCharValues(const std::string& groupName,
            const std::string& name,
            const char* intValues,
            const unsigned long long* numValuesInEachDimension,
            unsigned int numDimensions) final;
 
        void writeArrayNdOfIntValues(const std::string& groupName,
            const std::string& name,
            const int* intValues,
            const unsigned long long* numValuesInEachDimension,
            unsigned int numDimensions) final;
 
        void writeArrayNdOfInt64Values(const std::string & groupName,
            const std::string & name,
            const int64_t * values,
            const unsigned long long * numValuesInEachDimension,
            unsigned int numDimensions) final;
 
        void writeArrayNdOfUInt64Values(const std::string& groupName,
            const std::string& name,
            const uint64_t * values,
            const unsigned long long* numValuesInEachDimension,
            unsigned int numDimensions) final;
 
        void writeArrayNd(const std::string& groupName,
            const std::string& name,
            hdf5_hid_t datatype,
            const void* values,
            const unsigned long long* numValuesInEachDimension,
            unsigned int numDimensions) final;
 
        void createArrayNd(
            const std::string& groupName,
            const std::string& name,
            hdf5_hid_t datatype,
            const unsigned long long* numValuesInEachDimension,
            unsigned int numDimensions
        ) final;
 
        void writeArrayNdSlab(
            const std::string& groupName,
            const std::string& name,
            hdf5_hid_t datatype,
            const void* values,
            const unsigned long long* numValuesInEachDimension,
            const unsigned long long* offsetValuesInEachDimension,
            unsigned int numDimensions
        ) final;
 
        void writeGroupAttributes(const std::string& groupName,
            const std::vector<std::string>& attributeNames,
            const std::vector<std::string>& values) final;
 
        void writeGroupAttribute(const std::string& groupName,
            const std::string& attributeName,
            const std::vector<std::string>& values) final;
 
        void writeGroupAttributes(const std::string& groupName,
            const std::vector<std::string>& attributeNames,
            const std::vector<double>& values) final;
 
        void writeGroupAttributes(const std::string& groupName,
            const std::vector<std::string>& attributeNames,
            const std::vector<int>& values) final;
 
        void writeDatasetAttributes(const std::string& datasetName,
            const std::vector<std::string>& attributeNames,
            const std::vector<std::string>& values) final;
 
        void writeDatasetAttribute(const std::string& datasetName,
            const std::string& attributeName,
            const std::vector<std::string>& values) final;
 
        void writeDatasetAttributes(const std::string& datasetName,
            const std::vector<std::string>& attributeNames,
            const std::vector<double>& values) final;
 
        void writeDatasetAttributes(const std::string& datasetName,
            const std::vector<std::string>& attributeNames,
            const std::vector<int>& values) final;
 
        std::string readStringAttribute(const std::string& obj_name,
            const std::string& attr_name) const final;
 
        std::vector<std::string> readStringArrayAttribute(const std::string& obj_name,
            const std::string& attr_name) const final;
 
        double readDoubleAttribute(const std::string& obj_name,
            const std::string& attr_name) const final;
 
        int64_t readLongAttribute(const std::string& obj_name,
            const std::string& attr_name) const final;
 
        void readArrayNdOfDoubleValues(const std::string& datasetName, double* values) final;
 
        void readArrayNdOfDoubleValues(
            const std::string& datasetName,
            double* values,
            unsigned long long const* numValuesInEachDimension,
            unsigned long long const* offsetInEachDimension,
            unsigned int numDimensions
        ) final;
 
        void readArrayNdOfDoubleValues(
            const std::string& datasetName, double* values,
            unsigned long long const* blockCountPerDimension,
            unsigned long long const* offsetInEachDimension,
            unsigned long long const* strideInEachDimension,
            unsigned long long const* blockSizeInEachDimension,
            unsigned int numDimensions) final;
 
        void selectArrayNdOfValues(
            const std::string& datasetName,
            unsigned long long const* blockCountPerDimension,
            unsigned long long const* offsetInEachDimension,
            unsigned long long const* strideInEachDimension,
            unsigned long long const* blockSizeInEachDimension,
            unsigned int numDimensions,
            bool newSelection,
            hdf5_hid_t& dataset,
            hdf5_hid_t& filespace) final;
 
        void readArrayNdOfDoubleValues(
            hdf5_hid_t dataset,
            hdf5_hid_t filespace,
            void* values,
            unsigned long long slabSize) final;
 
        void readArrayNdOfFloatValues(const std::string& datasetName, float* values) final;
 
        void readArrayNdOfFloatValues(
            const std::string& datasetName,
            float* values,
            unsigned long long const* numValuesInEachDimension,
            unsigned long long const* offsetInEachDimension,
            unsigned int numDimensions
        ) final;
 
        void readArrayNdOfInt64Values(const std::string& datasetName, int64_t* values) final;
 
        void readArrayNdOfInt64Values(
            const std::string& datasetName,
            int64_t* values,
            unsigned long long const* numValuesInEachDimension,
            unsigned long long const* offsetInEachDimension,
            unsigned int numDimensions) final;
 
        void readArrayNdOfUInt64Values(const std::string& datasetName, uint64_t* values) final;
 
        void readArrayNdOfIntValues(const std::string& datasetName, int* values) final;
 
        void readArrayNdOfIntValues(
            const std::string& datasetName,
            int* values,
            unsigned long long const* numValuesInEachDimension,
            unsigned long long const* offsetInEachDimension,
            unsigned int numDimensions
        ) final;
 
        void readArrayNdOfUIntValues(const std::string& datasetName, unsigned int* values) final;
 
        void readArrayNdOfShortValues(const std::string& datasetName, short* values) final;
 
        void readArrayNdOfUShortValues(const std::string& datasetName, unsigned short* values) final;
 
        void readArrayNdOfCharValues(const std::string& datasetName, char* values) final;
 
        void readArrayNdOfUCharValues(const std::string& datasetName, unsigned char* values) final;
 
        std::vector<unsigned long long> readArrayDimensions(const std::string& datasetName) final;
 
        bool exist(const std::string& absolutePathInHdfFile) const final;
 
        bool isCompressed(const std::string& datasetName) final;
 
        std::vector<unsigned long long> getElementCountPerChunkDimension(const std::string & datasetName) final;
 
    protected:
 
        HdfProxy(gsoap_resqml2_0_1::_eml20__EpcExternalPartReference* fromGsoap) :
            AbstractHdfProxy(fromGsoap), hdfFile(-1), compressionLevel(0), openedGroups() {}
 
        HdfProxy(gsoap_eml2_1::_eml21__EpcExternalPartReference* fromGsoap) :
            AbstractHdfProxy(fromGsoap), hdfFile(-1), compressionLevel(0), openedGroups() {}
 
        HdfProxy(gsoap_eml2_3::_eml23__EpcExternalPartReference* fromGsoap) :
            AbstractHdfProxy(fromGsoap), hdfFile(-1), compressionLevel(0), openedGroups() {}
 
        HdfProxy(const std::string & packageDirAbsolutePath, const std::string & externalFilePath, COMMON_NS::DataObjectRepository::openingMode hdfPermissionAccess = COMMON_NS::DataObjectRepository::openingMode::READ_ONLY);
 
        void readArrayNdOfValues(const std::string& datasetName, void* values, hdf5_hid_t datatype);
 
        void readArrayNdOfValues(
            const std::string& datasetName,
            void* values,
            unsigned long long const* numValuesInEachDimension,
            unsigned long long const* offsetInEachDimension,
            unsigned int numDimensions,
            hdf5_hid_t datatype);
 
        void readArrayNdOfValues(
            const std::string& datasetName,
            void* values,
            unsigned long long const* blockCountPerDimension,
            unsigned long long const* offsetInEachDimension,
            unsigned long long const* strideInEachDimension,
            unsigned long long const* blockSizeInEachDimension,
            unsigned int numDimensions,
            hdf5_hid_t datatype);
 
        void readArrayNdOfValues(
            hdf5_hid_t dataset,
            hdf5_hid_t filespace,
            void* values,
            unsigned long long slabSize,
            hdf5_hid_t datatype);
 
        void writeUuidAttribute();
 
        hdf5_hid_t openOrCreateGroup(const std::string& groupName);
 
        hdf5_hid_t hdfFile;
 
        unsigned int compressionLevel;
 
        std::unordered_map< std::string, hdf5_hid_t > openedGroups;
 
    private:
 
        std::vector<unsigned long long> reduceForChunking(hdf5_hid_t datatype,
            const unsigned long long * numValuesInEachDimension,
            unsigned int numDimensions) const;
    };
}