AbstractHdfProxy.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/EpcExternalPartReference.h"
#include "resqml2/AbstractRepresentation.h"
#include "prodml2_0/DasAcquisition.h"

#define CUMULATIVE_LENGTH_DS_NAME "cumulativeLength"
#define ELEMENTS_DS_NAME "elements"

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

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

        AbstractHdfProxy(gsoap_resqml2_0_1::_eml20__EpcExternalPartReference* fromGsoap, const std::string & packageDirAbsolutePath, const std::string & externalFilePath) :
            EpcExternalPartReference(fromGsoap, packageDirAbsolutePath, externalFilePath) {}

        AbstractHdfProxy(gsoap_eml2_1::_eml21__EpcExternalPartReference* fromGsoap, const std::string & packageDirAbsolutePath, const std::string & externalFilePath) :
            EpcExternalPartReference(fromGsoap, packageDirAbsolutePath, externalFilePath) {}

        void initGsoapProxy(soap* soapContext, const std::string & guid, const std::string & title, const EmlVersion & emlVersion);

    public:  
        virtual ~AbstractHdfProxy() {}

        virtual void open() = 0;

        virtual bool isOpened() const = 0;

        virtual void close() = 0;

        virtual int getHdfDatatypeInDataset(const std::string & datasetName) const = 0;

        virtual int getHdfDatatypeClassInDataset(const std::string & datasetName) const = 0;

        virtual 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) = 0;

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

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

        virtual void setCompressionLevel(const unsigned int & newCompressionLevel) = 0;

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

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

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

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

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

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

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

        virtual 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
          ) = 0;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        virtual bool exist(const std::string & absolutePathInHdfFile) const = 0;
  
        friend void resqml2::AbstractRepresentation::setHdfProxy(common::AbstractHdfProxy * proxy);
        friend void resqml2::AbstractProperty::setHdfProxy(common::AbstractHdfProxy * proxy);
        friend void prodml2_0::DasAcquisition::setHdfProxy(common::AbstractHdfProxy * proxy);

    };
}