DiscreteProperty.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 "AbstractValuesProperty.h"
 
#include <limits>
 
namespace RESQML2_NS
{
    class DiscreteProperty : public RESQML2_NS::AbstractValuesProperty
    {
    public:

        virtual ~DiscreteProperty() = default;

        DLL_IMPORT_OR_EXPORT void pushBackInt64Hdf5Array1dOfValues(const int64_t * values, uint64_t valueCount, EML2_NS::AbstractHdfProxy* proxy, int64_t nullValue, int64_t minimumValue, int64_t maximumValue) {
            pushBackInt64Hdf5ArrayOfValues(values, &valueCount, 1, proxy, nullValue, minimumValue, maximumValue);
        }
        using AbstractValuesProperty::pushBackInt64Hdf5Array1dOfValues;
        
        DLL_IMPORT_OR_EXPORT void pushBackInt32Hdf5Array1dOfValues(const int * values, uint64_t valueCount, EML2_NS::AbstractHdfProxy* proxy, int nullValue, int minimumValue, int maximumValue) {
            pushBackInt32Hdf5ArrayOfValues(values, &valueCount, 1, proxy, nullValue, minimumValue, maximumValue);
        }
        using AbstractValuesProperty::pushBackInt32Hdf5Array1dOfValues;
        
        DLL_IMPORT_OR_EXPORT void pushBackInt16Hdf5Array1dOfValues(const short * values, uint64_t valueCount, EML2_NS::AbstractHdfProxy* proxy, short nullValue, short minimumValue, short maximumValue) {
            pushBackInt16Hdf5ArrayOfValues(values, &valueCount, 1, proxy, nullValue, minimumValue, maximumValue);
        }
        using AbstractValuesProperty::pushBackInt16Hdf5Array1dOfValues;
        
        DLL_IMPORT_OR_EXPORT void pushBackInt8Hdf5Array1dOfValues(const int8_t * values, uint64_t valueCount, EML2_NS::AbstractHdfProxy* proxy, int8_t nullValue, int8_t minimumValue, int8_t maximumValue) {
            pushBackInt8Hdf5ArrayOfValues(values, &valueCount, 1, proxy, nullValue, minimumValue, maximumValue);
        }
        using AbstractValuesProperty::pushBackInt8Hdf5Array1dOfValues;

        DLL_IMPORT_OR_EXPORT void pushBackInt64Hdf5Array2dOfValues(const int64_t * values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy,
            int64_t nullValue, int64_t minimumValue, int64_t maximumValue);
        using AbstractValuesProperty::pushBackInt64Hdf5Array2dOfValues;
        
        DLL_IMPORT_OR_EXPORT void pushBackInt32Hdf5Array2dOfValues(const int * values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy,
            int nullValue, int minimumValue, int maximumValue);
        using AbstractValuesProperty::pushBackInt32Hdf5Array2dOfValues;
        
        DLL_IMPORT_OR_EXPORT void pushBackInt16Hdf5Array2dOfValues(const short * values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy,
            short nullValue, short minimumValue, short maximumValue);
        using AbstractValuesProperty::pushBackInt16Hdf5Array2dOfValues;
        
        DLL_IMPORT_OR_EXPORT void pushBackUInt16Hdf5Array2dOfValues(const unsigned short * values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy,
            unsigned short nullValue, unsigned short minimumValue, unsigned short maximumValue);
        using AbstractValuesProperty::pushBackUInt16Hdf5Array2dOfValues;
        
        DLL_IMPORT_OR_EXPORT void pushBackInt8Hdf5Array2dOfValues(const int8_t * values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy,
            int8_t nullValue, int8_t minimumValue, int8_t maximumValue);
        using AbstractValuesProperty::pushBackInt8Hdf5Array2dOfValues;

        DLL_IMPORT_OR_EXPORT void pushBackInt64Hdf5Array3dOfValues(const int64_t * values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy,
            int64_t nullValue, int64_t minimumValue, int64_t maximumValue);
        using AbstractValuesProperty::pushBackInt64Hdf5Array3dOfValues;
        
        DLL_IMPORT_OR_EXPORT void pushBackInt32Hdf5Array3dOfValues(const int * values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy,
            int nullValue, int minimumValue, int maximumValue);
        using AbstractValuesProperty::pushBackInt32Hdf5Array3dOfValues;
        
        DLL_IMPORT_OR_EXPORT void pushBackInt16Hdf5Array3dOfValues(const short * values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy,
            short nullValue, short minimumValue, short maximumValue);
        using AbstractValuesProperty::pushBackInt16Hdf5Array3dOfValues;
        
        DLL_IMPORT_OR_EXPORT void pushBackUInt16Hdf5Array3dOfValues(const unsigned short * values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy,
            unsigned short nullValue, unsigned short minimumValue, unsigned short maximumValue);
        using AbstractValuesProperty::pushBackUInt16Hdf5Array3dOfValues;
        
        DLL_IMPORT_OR_EXPORT void pushBackInt8Hdf5Array3dOfValues(const int8_t * values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy,
            int8_t nullValue, int8_t minimumValue, int8_t maximumValue);
        using AbstractValuesProperty::pushBackInt8Hdf5Array3dOfValues;

        DLL_IMPORT_OR_EXPORT void pushBackInt64Hdf5ArrayOfValues(const int64_t * values, const uint64_t * numValues, unsigned int numDimensionsInArray, EML2_NS::AbstractHdfProxy* proxy, int64_t nullValue) final;
        
        DLL_IMPORT_OR_EXPORT void pushBackInt32Hdf5ArrayOfValues(const int * values, const uint64_t * numValues, unsigned int numDimensionsInArray, EML2_NS::AbstractHdfProxy* proxy, int nullValue) final;
        
        DLL_IMPORT_OR_EXPORT void pushBackInt16Hdf5ArrayOfValues(const short * values, const uint64_t * numValues, unsigned int numDimensionsInArray, EML2_NS::AbstractHdfProxy* proxy, short nullValue) final;
        
        DLL_IMPORT_OR_EXPORT void pushBackUInt16Hdf5ArrayOfValues(const unsigned short * values, const uint64_t * numValues, unsigned int numDimensionsInArray, EML2_NS::AbstractHdfProxy* proxy, unsigned short nullValue) final;
        
        DLL_IMPORT_OR_EXPORT void pushBackInt8Hdf5ArrayOfValues(const int8_t * values, const uint64_t * numValues, unsigned int numDimensionsInArray, EML2_NS::AbstractHdfProxy* proxy, int8_t nullValue) final;

        DLL_IMPORT_OR_EXPORT void pushBackInt64Hdf5ArrayOfValues(const int64_t * values, const uint64_t * numValues, unsigned int numDimensionsInArray, EML2_NS::AbstractHdfProxy* proxy,
            int64_t nullValue, int64_t minimumValue, int64_t maximumValue);
        
        DLL_IMPORT_OR_EXPORT void pushBackInt32Hdf5ArrayOfValues(const int * values, const uint64_t * numValues, unsigned int numDimensionsInArray, EML2_NS::AbstractHdfProxy* proxy,
            int nullValue, int minimumValue, int maximumValue);
        
        DLL_IMPORT_OR_EXPORT void pushBackInt16Hdf5ArrayOfValues(const short * values, const uint64_t * numValues, unsigned int numDimensionsInArray, EML2_NS::AbstractHdfProxy* proxy,
            short nullValue, short minimumValue, short maximumValue);
        
        DLL_IMPORT_OR_EXPORT void pushBackUInt16Hdf5ArrayOfValues(const unsigned short * values, const uint64_t * numValues, unsigned int numDimensionsInArray, EML2_NS::AbstractHdfProxy* proxy,
            unsigned short nullValue, unsigned short minimumValue, unsigned short maximumValue);
        
        DLL_IMPORT_OR_EXPORT void pushBackInt8Hdf5ArrayOfValues(const int8_t * values, const uint64_t * numValues, unsigned int numDimensionsInArray, EML2_NS::AbstractHdfProxy* proxy,
            int8_t nullValue, int8_t minimumValue, int8_t maximumValue);

        DLL_IMPORT_OR_EXPORT virtual std::string pushBackRefToExistingIntegerDataset(EML2_NS::AbstractHdfProxy* proxy, const std::string & datasetName, int64_t nullValue, int64_t minimumValue, int64_t maximumValue) = 0;
        using AbstractValuesProperty::pushBackRefToExistingIntegerDataset;
 
        //***************************
        //*** For hyperslabbing *****
        //***************************

        DLL_IMPORT_OR_EXPORT void pushBackHdf5ArrayOfValues(
            COMMON_NS::AbstractObject::numericalDatatypeEnum datatype,
            const uint64_t* numValues,
            unsigned int numArrayDimensions,
            int64_t* minimumValue, int64_t* maximumValue,
            int64_t nullValue = (std::numeric_limits<int64_t>::max)(),
            EML2_NS::AbstractHdfProxy* proxy = nullptr);
        using AbstractValuesProperty::pushBackHdf5ArrayOfValues;

        DLL_IMPORT_OR_EXPORT void pushBackHdf5Array1dOfValues(
            COMMON_NS::AbstractObject::numericalDatatypeEnum datatype,
            uint64_t valueCount,
            int64_t minimumValue, int64_t maximumValue,
            int64_t nullValue = (std::numeric_limits<int64_t>::max)(),
            EML2_NS::AbstractHdfProxy* proxy = nullptr);
        using AbstractValuesProperty::pushBackHdf5Array1dOfValues;

        DLL_IMPORT_OR_EXPORT void pushBackHdf5Array2dOfValues(
            COMMON_NS::AbstractObject::numericalDatatypeEnum datatype,
            uint64_t valueCountInFastestDim,
            uint64_t valueCountInSlowestDim,
            int64_t minimumValue, int64_t maximumValue,
            int64_t nullValue = (std::numeric_limits<int64_t>::max)(),
            EML2_NS::AbstractHdfProxy* proxy = nullptr);
        using AbstractValuesProperty::pushBackHdf5Array2dOfValues;

        DLL_IMPORT_OR_EXPORT void pushBackHdf5Array3dOfValues(
            COMMON_NS::AbstractObject::numericalDatatypeEnum datatype,
            uint64_t valueCountInFastestDim,
            uint64_t valueCountInMiddleDim,
            uint64_t valueCountInSlowestDim,
            int64_t minimumValue, int64_t maximumValue,
            int64_t nullValue = (std::numeric_limits<int64_t>::max)(),
            EML2_NS::AbstractHdfProxy* proxy = nullptr);
        using AbstractValuesProperty::pushBackHdf5Array3dOfValues;

        DLL_IMPORT_OR_EXPORT void setValuesOfInt64Hdf5Array3dOfValues(
            int64_t* values,
            uint64_t valueCountInFastestDim,
            uint64_t valueCountInMiddleDim,
            uint64_t valueCountInSlowestDim,
            uint64_t offsetInFastestDim,
            uint64_t offsetInMiddleDim,
            uint64_t offsetInSlowestDim,
            bool computeMinMax,
            EML2_NS::AbstractHdfProxy* proxy = nullptr,
            uint64_t patchIndex = (std::numeric_limits<uint64_t>::max)());
        using AbstractValuesProperty::setValuesOfInt64Hdf5Array3dOfValues;
        DLL_IMPORT_OR_EXPORT void setValuesOfInt32Hdf5Array3dOfValues(
            int32_t* values,
            uint64_t valueCountInFastestDim,
            uint64_t valueCountInMiddleDim,
            uint64_t valueCountInSlowestDim,
            uint64_t offsetInFastestDim,
            uint64_t offsetInMiddleDim,
            uint64_t offsetInSlowestDim,
            bool computeMinMax,
            EML2_NS::AbstractHdfProxy* proxy = nullptr,
            uint64_t patchIndex = (std::numeric_limits<uint64_t>::max)());
        using AbstractValuesProperty::setValuesOfInt32Hdf5Array3dOfValues;

        DLL_IMPORT_OR_EXPORT void setValuesOfInt64Hdf5ArrayOfValues(
            int64_t* values,
            uint64_t const * numValues,
            uint64_t const * offsetValues,
            unsigned int numArrayDimensions,
            bool computeMinMax,
            EML2_NS::AbstractHdfProxy* proxy = nullptr,
            uint64_t patchIndex = (std::numeric_limits<uint64_t>::max)());
        using AbstractValuesProperty::setValuesOfInt64Hdf5ArrayOfValues;
        DLL_IMPORT_OR_EXPORT void setValuesOfInt32Hdf5ArrayOfValues(
            int32_t* values,
            uint64_t const * numValues,
            uint64_t const * offsetValues,
            unsigned int numArrayDimensions,
            bool computeMinMax,
            EML2_NS::AbstractHdfProxy* proxy = nullptr,
            uint64_t patchIndex = (std::numeric_limits<uint64_t>::max)());
        using AbstractValuesProperty::setValuesOfInt32Hdf5ArrayOfValues;

        DLL_IMPORT_OR_EXPORT virtual int64_t getNullValue(uint64_t patchIndex = (std::numeric_limits<uint64_t>::max)()) const = 0;

        DLL_IMPORT_OR_EXPORT virtual bool hasMinimumValue(uint64_t index = 0) const = 0;

        DLL_IMPORT_OR_EXPORT virtual int64_t getMinimumValue(uint64_t index = 0) const = 0;

        DLL_IMPORT_OR_EXPORT virtual bool hasMaximumValue(uint64_t index = 0) const = 0;

        DLL_IMPORT_OR_EXPORT virtual int64_t getMaximumValue(uint64_t index = 0) const = 0;

        DLL_IMPORT_OR_EXPORT virtual void setMinimumValue(int64_t value, uint64_t index = 0) const = 0;

        DLL_IMPORT_OR_EXPORT virtual void setMaximumValue(int64_t value, uint64_t index = 0) const = 0;

        DLL_IMPORT_OR_EXPORT static constexpr char const* XML_TAG = "DiscreteProperty";
 
        DLL_IMPORT_OR_EXPORT virtual std::string getXmlTag() const final { return XML_TAG; }
 
    protected:

        DiscreteProperty(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : RESQML2_NS::AbstractValuesProperty(partialObject) {}

        DiscreteProperty() {}

        DiscreteProperty(gsoap_resqml2_0_1::_resqml20__DiscreteProperty* fromGsoap) : AbstractValuesProperty(fromGsoap) {}

        DiscreteProperty(gsoap_eml2_3::_resqml22__DiscreteProperty* fromGsoap) : AbstractValuesProperty(fromGsoap) {}
 
        virtual size_t getMinimumValueSize() const = 0;
        virtual size_t getMaximumValueSize() const = 0;
    };
}