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 "AbstractProperty.h"
 
namespace RESQML2_NS
{
    class AbstractValuesProperty : public AbstractProperty
    {
    public:
 
        virtual ~AbstractValuesProperty() = default;
 
        DLL_IMPORT_OR_EXPORT unsigned int getPatchCount() const final;
 
        DLL_IMPORT_OR_EXPORT void pushBackFacet(gsoap_eml2_3::eml23__FacetKind facet, const std::string & facetValue);
 
        DLL_IMPORT_OR_EXPORT unsigned int getFacetCount() const;
 
        DLL_IMPORT_OR_EXPORT gsoap_eml2_3::eml23__FacetKind getFacetKind(unsigned int index) const;
 
        DLL_IMPORT_OR_EXPORT std::string getFacetValue(unsigned int index) const;
 
        //****************************
        //****** INTEGER *************
        //****************************
 
        DLL_IMPORT_OR_EXPORT void pushBackLongHdf5Array1dOfValues(const int64_t * values, uint64_t valueCount, EML2_NS::AbstractHdfProxy* proxy, int64_t nullValue);
 
        DLL_IMPORT_OR_EXPORT void pushBackIntHdf5Array1dOfValues(const int * values, uint64_t valueCount, EML2_NS::AbstractHdfProxy* proxy, int nullValue);
 
        DLL_IMPORT_OR_EXPORT void pushBackShortHdf5Array1dOfValues(const short * values, uint64_t valueCount, EML2_NS::AbstractHdfProxy* proxy, short nullValue);
 
        DLL_IMPORT_OR_EXPORT void pushBackCharHdf5Array1dOfValues(const char * values, uint64_t valueCount, EML2_NS::AbstractHdfProxy* proxy, char nullValue);
 
        DLL_IMPORT_OR_EXPORT void pushBackLongHdf5Array2dOfValues(const int64_t * values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy, int64_t nullValue);
 
        DLL_IMPORT_OR_EXPORT void pushBackIntHdf5Array2dOfValues(const int * values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy, int nullValue);
 
        DLL_IMPORT_OR_EXPORT void pushBackShortHdf5Array2dOfValues(const short * values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy, short nullValue);
 
        DLL_IMPORT_OR_EXPORT void pushBackUShortHdf5Array2dOfValues(const unsigned short * values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy, unsigned short nullValue);
 
        DLL_IMPORT_OR_EXPORT void pushBackCharHdf5Array2dOfValues(const char * values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy, char nullValue);
 
        DLL_IMPORT_OR_EXPORT void pushBackLongHdf5Array3dOfValues(const int64_t * values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy, int64_t nullValue);
 
        DLL_IMPORT_OR_EXPORT void pushBackIntHdf5Array3dOfValues(const int * values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy, int nullValue);
 
        DLL_IMPORT_OR_EXPORT void pushBackShortHdf5Array3dOfValues(const short * values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy, short nullValue);
 
        DLL_IMPORT_OR_EXPORT void pushBackUShortHdf5Array3dOfValues(const unsigned short * values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy, unsigned short nullValue);
 
        DLL_IMPORT_OR_EXPORT void pushBackCharHdf5Array3dOfValues(const char * values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy, char nullValue);
 
        DLL_IMPORT_OR_EXPORT virtual void pushBackLongHdf5ArrayOfValues(const int64_t * values, unsigned long long * numValues, unsigned int numDimensionsInArray, EML2_NS::AbstractHdfProxy* proxy, int64_t nullValue);
 
        DLL_IMPORT_OR_EXPORT virtual void pushBackIntHdf5ArrayOfValues(const int * values, unsigned long long * numValues, unsigned int numDimensionsInArray, EML2_NS::AbstractHdfProxy* proxy, int nullValue);
 
        DLL_IMPORT_OR_EXPORT virtual void pushBackShortHdf5ArrayOfValues(const short * values, unsigned long long * numValues, unsigned int numDimensionsInArray, EML2_NS::AbstractHdfProxy* proxy, short nullValue);
 
        DLL_IMPORT_OR_EXPORT virtual void pushBackUShortHdf5ArrayOfValues(const unsigned short * values, unsigned long long * numValues, unsigned int numDimensionsInArray, EML2_NS::AbstractHdfProxy* proxy, unsigned short nullValue);
 
        DLL_IMPORT_OR_EXPORT virtual void pushBackCharHdf5ArrayOfValues(const char * values, unsigned long long * numValues, unsigned int numDimensionsInArray, EML2_NS::AbstractHdfProxy* proxy, char nullValue);
 
        DLL_IMPORT_OR_EXPORT virtual std::string pushBackRefToExistingIntegerDataset(EML2_NS::AbstractHdfProxy* hdfProxy, const std::string & dataset = "", int64_t nullValue = (std::numeric_limits<int64_t>::max)());
 
        DLL_IMPORT_OR_EXPORT int64_t getLongValuesOfPatch(unsigned int patchIndex, int64_t * values) const;
 
        DLL_IMPORT_OR_EXPORT int64_t getNullValueOfPatch(unsigned int patchIndex) const;
 
        DLL_IMPORT_OR_EXPORT int getIntValuesOfPatch(unsigned int patchIndex, int * values) const;
 
        DLL_IMPORT_OR_EXPORT unsigned int getUIntValuesOfPatch(unsigned int patchIndex, unsigned int * values) const;
 
        DLL_IMPORT_OR_EXPORT short getShortValuesOfPatch(unsigned int patchIndex, short * values) const;
 
        DLL_IMPORT_OR_EXPORT unsigned short getUShortValuesOfPatch(unsigned int patchIndex, unsigned short * values) const;
 
        DLL_IMPORT_OR_EXPORT char getCharValuesOfPatch(unsigned int patchIndex, char * values) const;
 
        DLL_IMPORT_OR_EXPORT unsigned char getUCharValuesOfPatch(unsigned int patchIndex, unsigned char * values) const;
 
        //***********************************
        //*** INTEGER For hyperslabbing *****
        //***********************************
 
        DLL_IMPORT_OR_EXPORT void pushBackLongHdf5ArrayOfValues(
            unsigned long long* numValues,
            unsigned int numArrayDimensions,
            int64_t nullValue = (std::numeric_limits<int64_t>::max)(),
            EML2_NS::AbstractHdfProxy* proxy = nullptr);
 
        DLL_IMPORT_OR_EXPORT void pushBackLongHdf5Array3dOfValues(
            uint64_t valueCountInFastestDim,
            uint64_t valueCountInMiddleDim,
            uint64_t valueCountInSlowestDim,
            int64_t nullValue = (std::numeric_limits<int64_t>::max)(),
            EML2_NS::AbstractHdfProxy* proxy = nullptr);
 
        DLL_IMPORT_OR_EXPORT void setValuesOfLongHdf5Array3dOfValues(
            int64_t* values,
            uint64_t valueCountInFastestDim,
            uint64_t valueCountInMiddleDim,
            uint64_t valueCountInSlowestDim,
            uint64_t offsetInFastestDim,
            uint64_t offsetInMiddleDim,
            uint64_t offsetInSlowestDim,
            EML2_NS::AbstractHdfProxy* proxy = nullptr,
            unsigned int patchIndex = (std::numeric_limits<unsigned int>::max)());
 
        DLL_IMPORT_OR_EXPORT void setValuesOfLongHdf5ArrayOfValues(
            int64_t* values,
            unsigned long long const * numValues,
            unsigned long long const * offsetValues,
            unsigned int numArrayDimensions,
            EML2_NS::AbstractHdfProxy* proxy = nullptr,
            unsigned int patchIndex = (std::numeric_limits<unsigned int>::max)());
 
        DLL_IMPORT_OR_EXPORT void getLongValuesOfPatch(
            unsigned int patchIndex,
            int64_t* values,
            unsigned long long const * numValuesInEachDimension,
            unsigned long long const * offsetInEachDimension,
            unsigned int numArrayDimensions
        ) const;
 
        DLL_IMPORT_OR_EXPORT void getLongValuesOf3dPatch(
            unsigned int patchIndex,
            int64_t* values,
            uint64_t valueCountInFastestDim,
            uint64_t valueCountInMiddleDim,
            uint64_t valueCountInSlowestDim,
            uint64_t offsetInFastestDim,
            uint64_t offsetInMiddleDim,
            uint64_t offsetInSlowestDim
        ) const;
 
        DLL_IMPORT_OR_EXPORT int getIntValuesOfPatch(
            unsigned int patchIndex,
            int* values,
            unsigned long long* numValuesInEachDimension,
            unsigned long long* offsetInEachDimension,
            unsigned int numArrayDimensions
        ) const;
 
        DLL_IMPORT_OR_EXPORT void getIntValuesOf3dPatch(
            unsigned int patchIndex,
            int* values,
            unsigned int valueCountInFastestDim,
            unsigned int valueCountInMiddleDim,
            unsigned int valueCountInSlowestDim,
            unsigned int offsetInFastestDim,
            unsigned int offsetInMiddleDim,
            unsigned int offsetInSlowestDim
        ) const;
 
        //***********************************
        //****** FLOATING POINT *************
        //***********************************
 
        DLL_IMPORT_OR_EXPORT void pushBackDoubleHdf5Array1dOfValues(const double * values, uint64_t valueCount, EML2_NS::AbstractHdfProxy* proxy = nullptr);
 
        DLL_IMPORT_OR_EXPORT void pushBackDoubleHdf5Array2dOfValues(const double * values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy = nullptr);
 
        DLL_IMPORT_OR_EXPORT void pushBackDoubleHdf5Array3dOfValues(const double * values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy = nullptr);
 
        DLL_IMPORT_OR_EXPORT void pushBackDoubleHdf5ArrayOfValues(double const * values, unsigned long long const * numValues, unsigned int numArrayDimensions, EML2_NS::AbstractHdfProxy* proxy = nullptr);
 
        DLL_IMPORT_OR_EXPORT void pushBackFloatHdf5Array1dOfValues(const float * values, uint64_t valueCount, EML2_NS::AbstractHdfProxy* proxy = nullptr);
 
        DLL_IMPORT_OR_EXPORT void pushBackFloatHdf5Array2dOfValues(const float * values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy = nullptr);
 
        DLL_IMPORT_OR_EXPORT void pushBackFloatHdf5Array3dOfValues(const float * values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy = nullptr);
 
        DLL_IMPORT_OR_EXPORT void pushBackFloatHdf5ArrayOfValues(float const * values, unsigned long long const * numValues, unsigned int numArrayDimensions, EML2_NS::AbstractHdfProxy* proxy = nullptr);
 
        DLL_IMPORT_OR_EXPORT virtual std::string pushBackRefToExistingFloatingPointDataset(EML2_NS::AbstractHdfProxy* proxy, const std::string & datasetName = "");
 
        DLL_IMPORT_OR_EXPORT void getDoubleValuesOfPatch(unsigned int patchIndex, double * values) const;
 
        DLL_IMPORT_OR_EXPORT void getFloatValuesOfPatch(unsigned int patchIndex, float * values) const;
 
        //******************************************
        //*** For FLOATING POINT hyperslabbing *****
        //******************************************
 
        DLL_IMPORT_OR_EXPORT void pushBackFloatHdf5ArrayOfValues(
            unsigned long long const * numValues,
            unsigned int numArrayDimensions,
            EML2_NS::AbstractHdfProxy* proxy = nullptr
        );
 
        DLL_IMPORT_OR_EXPORT void pushBackFloatHdf5Array3dOfValues(
            uint64_t valueCountInFastestDim,
            uint64_t valueCountInMiddleDim,
            uint64_t valueCountInSlowestDim,
            EML2_NS::AbstractHdfProxy* proxy = nullptr
        );
 
        DLL_IMPORT_OR_EXPORT void setValuesOfFloatHdf5Array3dOfValues(
            float const * values,
            uint64_t valueCountInFastestDim,
            uint64_t valueCountInMiddleDim,
            uint64_t valueCountInSlowestDim,
            uint64_t offsetInFastestDim,
            uint64_t offsetInMiddleDim,
            uint64_t offsetInSlowestDim,
            EML2_NS::AbstractHdfProxy* proxy = nullptr,
            unsigned int patchIndex = (std::numeric_limits<unsigned int>::max)()
        );
 
        DLL_IMPORT_OR_EXPORT void setValuesOfFloatHdf5ArrayOfValues(
            float const * values,
            unsigned long long const * numValues,
            unsigned long long const * offsetValues,
            unsigned int numArrayDimensions,
            EML2_NS::AbstractHdfProxy* proxy = nullptr,
            unsigned int patchIndex = (std::numeric_limits<unsigned int>::max)()
        );
 
        DLL_IMPORT_OR_EXPORT void getFloatValuesOfPatch(
            unsigned int patchIndex,
            float* values,
            unsigned long long const * numValuesInEachDimension,
            unsigned long long const * offsetInEachDimension,
            unsigned int numArrayDimensions
        ) const;
 
        DLL_IMPORT_OR_EXPORT void getFloatValuesOf3dPatch(
            unsigned int patchIndex,
            float* values,
            uint64_t valueCountInFastestDim,
            uint64_t valueCountInMiddleDim,
            uint64_t valueCountInSlowestDim,
            uint64_t offsetInFastestDim,
            uint64_t offsetInMiddleDim,
            uint64_t offsetInSlowestDim
        ) const;
 
    protected:
 
        DLL_IMPORT_OR_EXPORT AbstractValuesProperty(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : AbstractProperty(partialObject) {}
 
        AbstractValuesProperty() {}
 
        AbstractValuesProperty(gsoap_resqml2_0_1::resqml20__AbstractValuesProperty* fromGsoap) : RESQML2_NS::AbstractProperty(fromGsoap) {}
        AbstractValuesProperty(gsoap_eml2_3::resqml22__AbstractValuesProperty* fromGsoap) : RESQML2_NS::AbstractProperty(fromGsoap) {}
 
        EML2_NS::AbstractHdfProxy* getDatasetOfPatch(unsigned int patchIndex, int64_t & nullValue, std::string & dsPath) const final;
 
        COMMON_NS::DataObjectReference getHdfProxyDor(unsigned int patchIndex) const final;
    };
}