AbstractValuesProperty.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 <limits>
#include "resqml2/AbstractProperty.h"

namespace resqml2
{
    class DLL_IMPORT_OR_EXPORT AbstractValuesProperty : public AbstractProperty
    {
    protected:
        std::string getPathInHdfFileOfPatch(const unsigned int & patchIndex, LONG64 & nullValue) const;

        std::string pushBackRefToExistingIntegerDataset(common::AbstractHdfProxy* hdfProxy, const std::string & datasetName = "", const long & nullValue = (std::numeric_limits<long>::max)());

    public:

        enum hdfDatatypeEnum { UNKNOWN = 0, DOUBLE = 1, FLOAT = 2, LONG = 3, ULONG = 4, INT = 5, UINT = 6, SHORT = 7, USHORT = 8, CHAR = 9, UCHAR = 10};

        AbstractValuesProperty(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : AbstractProperty(partialObject) {}

        AbstractValuesProperty() {}

        AbstractValuesProperty(gsoap_resqml2_0_1::resqml2__AbstractValuesProperty* fromGsoap) : resqml2::AbstractProperty(fromGsoap) {}

        virtual ~AbstractValuesProperty() {}

        unsigned int getPatchCount() const;

        AbstractValuesProperty::hdfDatatypeEnum getValuesHdfDatatype() const;

        virtual std::string pushBackRefToExistingDataset(common::AbstractHdfProxy* hdfProxy, const std::string & datasetName = "", const long & nullValue = (std::numeric_limits<long>::max)()) = 0;

        long getLongValuesOfPatch(const unsigned int & patchIndex, long * values);

        long getNullValueOfPatch(const unsigned int & patchIndex);

        unsigned long getULongValuesOfPatch(const unsigned int & patchIndex, unsigned long * values);

        int getIntValuesOfPatch(const unsigned int & patchIndex, int * values);

        int getIntValuesOfPatch(
            const unsigned int& patchIndex,
            int* values,
            unsigned long long* numValuesInEachDimension,
            unsigned long long* offsetInEachDimension,
            const unsigned int& numArrayDimensions
        );

        void getIntValuesOf3dPatch(
            const unsigned int& patchIndex,
            int* values,
            const unsigned int& valueCountInFastestDim,
            const unsigned int& valueCountInMiddleDim,
            const unsigned int& valueCountInSlowestDim,
            const unsigned int& offsetInFastestDim,
            const unsigned int& offsetInMiddleDim,
            const unsigned int& offsetInSlowestDim
        );

        unsigned int getUIntValuesOfPatch(const unsigned int & patchIndex, unsigned int * values);
        
        short getShortValuesOfPatch(const unsigned int & patchIndex, short * values);

        unsigned short getUShortValuesOfPatch(const unsigned int & patchIndex, unsigned short * values);

        char getCharValuesOfPatch(const unsigned int & patchIndex, char * values);

        unsigned char getUCharValuesOfPatch(const unsigned int & patchIndex, unsigned char * values);

        unsigned int getValuesCountOfPatch (const unsigned int & patchIndex);

        unsigned int getValuesCountOfDimensionOfPatch(const unsigned int & dimIndex, const unsigned int & patchIndex);

        unsigned int getDimensionsCountOfPatch(const unsigned int & patchIndex);

        void pushBackFacet(const gsoap_resqml2_0_1::resqml2__Facet & facet, const std::string & facetValue);

        unsigned int getFacetCount() const;

        gsoap_resqml2_0_1::resqml2__Facet getFacet(const unsigned int & index) const;

        std::string getFacetValue(const unsigned int & index) const;

        //***************************
        //*** For hyperslabbing *****
        //***************************

        void createLongHdf5ArrayOfValues(
            unsigned long long* numValues, 
            const unsigned int& numArrayDimensions, 
            common::AbstractHdfProxy* proxy
        );

        void createLongHdf5Array3dOfValues(
            const unsigned int& valueCountInFastestDim, 
            const unsigned int& valueCountInMiddleDim, 
            const unsigned int& valueCountInSlowestDim, 
            common::AbstractHdfProxy* proxy
        );

        void pushBackLongHdf5SlabArray3dOfValues(
            long* values, 
            const unsigned int& valueCountInFastestDim, 
            const unsigned int& valueCountInMiddleDim, 
            const unsigned int& valueCountInSlowestDim, 
            const unsigned int& offsetInFastestDim, 
            const unsigned int& offsetInMiddleDim, 
            const unsigned int& offsetInSlowestDim, 
            common::AbstractHdfProxy* proxy
        );

        void pushBackLongHdf5SlabArrayOfValues(
            long * values, 
            unsigned long long * numValues,
            unsigned long long * offsetValues,
            const unsigned int & numArrayDimensions, 
            common::AbstractHdfProxy* proxy
        );

        void getLongValuesOfPatch(
            const unsigned int& patchIndex, 
            long* values, 
            unsigned long long* numValuesInEachDimension,
            unsigned long long* offsetInEachDimension,
            const unsigned int& numArrayDimensions
        );

        void getLongValuesOf3dPatch(
            const unsigned int& patchIndex, 
            long* values, 
            const unsigned int& valueCountInFastestDim, 
            const unsigned int& valueCountInMiddleDim, 
            const unsigned int& valueCountInSlowestDim, 
            const unsigned int& offsetInFastestDim, 
            const unsigned int& offsetInMiddleDim, 
            const unsigned int& offsetInSlowestDim
        );

    };
}