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

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

        std::string pushBackRefToExistingIntegerDataset(COMMON_NS::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_NS::AbstractProperty(fromGsoap) {}

        virtual ~AbstractValuesProperty() {}

        unsigned int getPatchCount() const;

        AbstractValuesProperty::hdfDatatypeEnum getValuesHdfDatatype() const;

        virtual std::string pushBackRefToExistingDataset(COMMON_NS::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_NS::AbstractHdfProxy* proxy
        );

        void createLongHdf5Array3dOfValues(
            const unsigned int& valueCountInFastestDim, 
            const unsigned int& valueCountInMiddleDim, 
            const unsigned int& valueCountInSlowestDim, 
            COMMON_NS::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_NS::AbstractHdfProxy* proxy
        );

        void pushBackLongHdf5SlabArrayOfValues(
            long * values, 
            unsigned long long * numValues,
            unsigned long long * offsetValues,
            const unsigned int & numArrayDimensions, 
            COMMON_NS::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
        );

    };
}