AbstractHdfProxy.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 "EpcExternalPartReference.h"
#include "../common/HidtType.h"
 
#define CUMULATIVE_LENGTH_DS_NAME "cumulativeLength"
#define ELEMENTS_DS_NAME "elements"
 
namespace EML2_NS
{
    class AbstractHdfProxy : public EpcExternalPartReference
    {
    public:  
        DLL_IMPORT_OR_EXPORT virtual ~AbstractHdfProxy() = default;
 
        DLL_IMPORT_OR_EXPORT void setRootPath(const std::string& rootPath) { packageDirectoryAbsolutePath = rootPath; }
 
        DLL_IMPORT_OR_EXPORT void setRelativePath(const std::string& relPath) { relativeFilePath = relPath; }
 
        DLL_IMPORT_OR_EXPORT void setOpeningMode(COMMON_NS::DataObjectRepository::openingMode openingMode_) { openingMode = openingMode_; }
 
        DLL_IMPORT_OR_EXPORT const std::string& getRelativePath() const { return relativeFilePath; }
 
        virtual void open() = 0;
 
        DLL_IMPORT_OR_EXPORT virtual bool isOpened() const = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void close() = 0;
 
        DLL_IMPORT_OR_EXPORT virtual COMMON_NS::AbstractObject::hdfDatatypeEnum getHdfDatatypeInDataset(const std::string & datasetName) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual int getHdfDatatypeClassInDataset(const std::string & datasetName) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual 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) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual unsigned int getDimensionCount(const std::string & datasetName) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual std::vector<unsigned long long> getElementCountPerDimension(const std::string & datasetName) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual signed long long getElementCount(const std::string & datasetName) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void setCompressionLevel(unsigned int newCompressionLevel) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void writeArrayNdOfFloatValues(const std::string & groupName,
          const std::string & name,
          const float * floatValues,
          const unsigned long long * numValuesInEachDimension,
          unsigned int numDimensions) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void writeArrayNdOfDoubleValues(const std::string & groupName,
          const std::string & name,
          const double * dblValues,
          const unsigned long long * numValuesInEachDimension,
          unsigned int numDimensions) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void writeArrayNdOfCharValues(const std::string & groupName,
            const std::string & name,
            const char * intValues,
            const unsigned long long * numValuesInEachDimension,
            unsigned int numDimensions) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void writeArrayNdOfIntValues(const std::string & groupName,
          const std::string & name,
          const int * intValues,
          const unsigned long long * numValuesInEachDimension,
          unsigned int numDimensions) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void writeArrayNdOfInt64Values(const std::string & groupName,
            const std::string & name,
            const int64_t * values,
            const unsigned long long * numValuesInEachDimension,
            unsigned int numDimensions) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void writeArrayNdOfUInt64Values(const std::string & groupName,
            const std::string & name,
            const uint64_t * values,
            const unsigned long long * numValuesInEachDimension,
            unsigned int numDimensions) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual 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) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void createArrayNd(
          const std::string& groupName,
          const std::string& name,
          hdf5_hid_t datatype,
          const unsigned long long* numValuesInEachDimension,
          unsigned int numDimensions
          ) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual 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
          ) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void writeGroupAttributes(const std::string & groupName,
            const std::vector<std::string> & attributeNames,
            const std::vector<std::string> & values) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void writeGroupAttribute(const std::string & groupName,
            const std::string & attributeName,
            const std::vector<std::string> & values) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void writeGroupAttributes(const std::string & groupName,
            const std::vector<std::string> & attributeNames,
            const std::vector<double> & values) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void writeGroupAttributes(const std::string & groupName,
            const std::vector<std::string> & attributeNames,
            const std::vector<int> & values) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void writeDatasetAttributes(const std::string & datasetName,
            const std::vector<std::string> & attributeNames,
            const std::vector<std::string> & values) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void writeDatasetAttribute(const std::string & datasetName,
            const std::string & attributeName,
            const std::vector<std::string> & values) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void writeDatasetAttributes(const std::string & datasetName,
            const std::vector<std::string> & attributeNames,
            const std::vector<double> & values) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void writeDatasetAttributes(const std::string & datasetName,
            const std::vector<std::string> & attributeNames,
            const std::vector<int> & values) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual std::string readStringAttribute(const std::string & obj_name,
            const std::string & attr_name) const = 0;
 
        DLL_IMPORT_OR_EXPORT virtual std::vector<std::string> readStringArrayAttribute(const std::string & obj_name,
            const std::string & attr_name) const = 0;
 
        DLL_IMPORT_OR_EXPORT virtual double readDoubleAttribute(const std::string & obj_name,
            const std::string & attr_name) const = 0;
 
        DLL_IMPORT_OR_EXPORT virtual int64_t readLongAttribute(const std::string & obj_name,
            const std::string & attr_name) const = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void readArrayNdOfDoubleValues(const std::string & datasetName, double* values) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void readArrayNdOfDoubleValues(
          const std::string & datasetName,
          double* values,
          unsigned long long const * numValuesInEachDimension,
          unsigned long long const * offsetInEachDimension,
          unsigned int numDimensions
          ) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual 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) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual 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) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void readArrayNdOfDoubleValues(
            hdf5_hid_t dataset,
            hdf5_hid_t filespace,
            void* values,
            unsigned long long slabSize) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void readArrayNdOfFloatValues(const std::string & datasetName, float* values) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void readArrayNdOfFloatValues(
          const std::string & datasetName,
          float* values,
          unsigned long long const * numValuesInEachDimension,
          unsigned long long const * offsetInEachDimension,
          unsigned int numDimensions
          ) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void readArrayNdOfInt64Values(const std::string & datasetName, int64_t* values) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void readArrayNdOfInt64Values(
            const std::string & datasetName,
            int64_t* values,
            unsigned long long const * numValuesInEachDimension,
            unsigned long long const * offsetInEachDimension,
            unsigned int numDimensions) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void readArrayNdOfUInt64Values(const std::string & datasetName, uint64_t* values) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void readArrayNdOfIntValues(const std::string & datasetName, int* values) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void readArrayNdOfIntValues(
            const std::string & datasetName,
            int* values,
            unsigned long long const * numValuesInEachDimension,
            unsigned long long const * offsetInEachDimension,
            unsigned int numDimensions
        ) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void readArrayNdOfUIntValues(const std::string & datasetName, unsigned int* values) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void readArrayNdOfShortValues(const std::string & datasetName, short* values) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void readArrayNdOfUShortValues(const std::string & datasetName, unsigned short* values) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void readArrayNdOfCharValues(const std::string & datasetName, char* values) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void readArrayNdOfUCharValues(const std::string & datasetName, unsigned char* values) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual std::vector<unsigned long long> readArrayDimensions(const std::string & datasetName) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual bool exist(const std::string & absolutePathInHdfFile) const = 0;
 
        DLL_IMPORT_OR_EXPORT virtual bool isCompressed(const std::string & datasetName) = 0;
        
        DLL_IMPORT_OR_EXPORT void setMaxChunkSize(unsigned int newMaxChunkSize) { maxChunkSize = newMaxChunkSize; }
 
        DLL_IMPORT_OR_EXPORT virtual std::vector<unsigned long long> getElementCountPerChunkDimension(const std::string & datasetName) = 0;
 
        DLL_IMPORT_OR_EXPORT void initGsoapProxy(COMMON_NS::DataObjectRepository* repo, const std::string& guid, const std::string& title, unsigned int emlVersion);
 
    protected:
 
        AbstractHdfProxy(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : EpcExternalPartReference(partialObject), openingMode(COMMON_NS::DataObjectRepository::openingMode::READ_ONLY) {}
        AbstractHdfProxy(const COMMON_NS::DataObjectReference& dor) : EpcExternalPartReference(dor), openingMode(COMMON_NS::DataObjectRepository::openingMode::READ_ONLY) {}
 
        std::string packageDirectoryAbsolutePath;
        std::string relativeFilePath;
        COMMON_NS::DataObjectRepository::openingMode openingMode;
        unsigned int maxChunkSize = 1000000;
 
        DLL_IMPORT_OR_EXPORT AbstractHdfProxy(const std::string & packageDirAbsolutePath, const std::string & externalFilePath, COMMON_NS::DataObjectRepository::openingMode hdfPermissionAccess = COMMON_NS::DataObjectRepository::openingMode::READ_ONLY) :
            packageDirectoryAbsolutePath(packageDirAbsolutePath), relativeFilePath(externalFilePath), openingMode(hdfPermissionAccess) {}
 
        AbstractHdfProxy(gsoap_resqml2_0_1::_eml20__EpcExternalPartReference* fromGsoap) :
            EpcExternalPartReference(fromGsoap), openingMode(COMMON_NS::DataObjectRepository::openingMode::READ_ONLY) {}
 
        AbstractHdfProxy(gsoap_eml2_1::_eml21__EpcExternalPartReference* fromGsoap) :
            EpcExternalPartReference(fromGsoap), openingMode(COMMON_NS::DataObjectRepository::openingMode::READ_ONLY) {}
 
        AbstractHdfProxy(gsoap_eml2_3::_eml23__EpcExternalPartReference* fromGsoap) :
            EpcExternalPartReference(fromGsoap), openingMode(COMMON_NS::DataObjectRepository::openingMode::READ_ONLY) {}
    };
}