ContinuousProperty.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 "resqml2/AbstractValuesProperty.h"
#include "common/AbstractHdfProxy.h"

#include <stdexcept>
#include <sstream>      // std::ostringstream

namespace resqml2_0_1
{
    class DLL_IMPORT_OR_EXPORT ContinuousProperty : public resqml2::AbstractValuesProperty
    {
    protected:

        ContinuousProperty() {}

    private:

        void init(resqml2::AbstractRepresentation * rep, const std::string & guid, const std::string & title,
            const unsigned int & dimension, const gsoap_resqml2_0_1::resqml2__IndexableElements & attachmentKind);

    public:

        ContinuousProperty(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : resqml2::AbstractValuesProperty(partialObject) {}

        ContinuousProperty(resqml2::AbstractRepresentation * rep, const std::string & guid, const std::string & title,
            const unsigned int & dimension, const gsoap_resqml2_0_1::resqml2__IndexableElements & attachmentKind, const gsoap_resqml2_0_1::resqml2__ResqmlUom & uom, const gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind & energisticsPropertyKind);

        ContinuousProperty(resqml2::AbstractRepresentation * rep, const std::string & guid, const std::string & title,
            const unsigned int & dimension, const gsoap_resqml2_0_1::resqml2__IndexableElements & attachmentKind, const gsoap_resqml2_0_1::resqml2__ResqmlUom & uom, resqml2::PropertyKind * localPropKind);

        ContinuousProperty(resqml2::AbstractRepresentation * rep, const std::string & guid, const std::string & title,
            const unsigned int & dimension, const gsoap_resqml2_0_1::resqml2__IndexableElements & attachmentKind, const std::string & nonStandardUom, const gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind & energisticsPropertyKind);

        ContinuousProperty(resqml2::AbstractRepresentation * rep, const std::string & guid, const std::string & title,
            const unsigned int & dimension, const gsoap_resqml2_0_1::resqml2__IndexableElements & attachmentKind, const std::string & nonStandardUom, resqml2::PropertyKind * localPropKind);

        ContinuousProperty(gsoap_resqml2_0_1::_resqml2__ContinuousProperty* fromGsoap): AbstractValuesProperty(fromGsoap) {}

        virtual ~ContinuousProperty() {}

        static const char* XML_TAG;
        virtual std::string getXmlTag() const {return XML_TAG;}

        const gsoap_resqml2_0_1::resqml2__ResqmlUom & getUom() const;

        std::string getUomAsString() const;

        void pushBackDoubleHdf5Array1dOfValues(double * values, const ULONG64 & valueCount, common::AbstractHdfProxy* proxy,
            const double & minimumValue = std::numeric_limits<double>::quiet_NaN(), const double & maximumValue = std::numeric_limits<double>::quiet_NaN());

        void pushBackDoubleHdf5Array2dOfValues(double * values, const ULONG64 & valueCountInFastestDim, const ULONG64 & valueCountInSlowestDim, common::AbstractHdfProxy* proxy,
            const double & minimumValue = std::numeric_limits<double>::quiet_NaN(), const double & maximumValue = std::numeric_limits<double>::quiet_NaN());

        void pushBackDoubleHdf5Array3dOfValues(double * values, const ULONG64 & valueCountInFastestDim, const ULONG64 & valueCountInMiddleDim, const ULONG64 & valueCountInSlowestDim, common::AbstractHdfProxy* proxy,
            const double & minimumValue = std::numeric_limits<double>::quiet_NaN(), const double & maximumValue = std::numeric_limits<double>::quiet_NaN());

        void pushBackDoubleHdf5ArrayOfValues(double * values, unsigned long long * numValues, const unsigned int & numArrayDimensions, common::AbstractHdfProxy* proxy,
            double * minimumValue = nullptr, double * maximumValue = nullptr);

        void pushBackFloatHdf5Array1dOfValues(float * values, const ULONG64 & valueCount, common::AbstractHdfProxy* proxy,
            const float & minimumValue = std::numeric_limits<float>::quiet_NaN(), const float & maximumValue = std::numeric_limits<float>::quiet_NaN());

        void pushBackFloatHdf5Array2dOfValues(float * values, const ULONG64 & valueCountInFastestDim, const ULONG64 & valueCountInSlowestDim, common::AbstractHdfProxy* proxy,
            const float & minimumValue = std::numeric_limits<float>::quiet_NaN(), const float & maximumValue = std::numeric_limits<float>::quiet_NaN());

        void pushBackFloatHdf5Array3dOfValues(float * values, const ULONG64 & valueCountInFastestDim, const ULONG64 & valueCountInMiddleDim, const ULONG64 & valueCountInSlowestDim, common::AbstractHdfProxy* proxy,
            const float & minimumValue = std::numeric_limits<float>::quiet_NaN(), const float & maximumValue = std::numeric_limits<float>::quiet_NaN());

        void pushBackFloatHdf5ArrayOfValues(float * values, unsigned long long * numValues, const unsigned int & numArrayDimensions, common::AbstractHdfProxy* proxy,
            float * minimumValue = nullptr, float * maximumValue = nullptr);

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

        void pushBackFloatHdf5ArrayOfValues(
            const ULONG64& valueCountInFastestDim,
            const ULONG64& valueCountInMiddleDim,
            const ULONG64& valueCountInSlowestDim,
            common::AbstractHdfProxy* proxy
        );

        void setValuesOfFloatHdf5ArrayOfValues(
            float* values, 
            const ULONG64& valueCountInFastestDim,
            const ULONG64& valueCountInMiddleDim,
            const ULONG64& valueCountInSlowestDim,
            const ULONG64& offsetInFastestDim,
            const ULONG64& offsetInMiddleDim,
            const ULONG64& offsetInSlowestDim,
            common::AbstractHdfProxy* proxy,
            unsigned int patchIndex = (std::numeric_limits<unsigned int>::max)()
        );

        void setValuesOfFloatHdf5ArrayOfValues(
            float * values, 
            unsigned long long * numValues,
            unsigned long long * offsetValues,
            const unsigned int & numArrayDimensions, 
            common::AbstractHdfProxy* proxy,
            unsigned int patchIndex = (std::numeric_limits<unsigned int>::max)()
        );

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

        void getDoubleValuesOfPatch(const unsigned int & patchIndex, double * values);

        void getFloatValuesOfPatch(const unsigned int & patchIndex, float * values);

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

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

        double getMinimumValue();
        double getMaximumValue();

        bool validatePropertyKindAssociation(resqml2::PropertyKind* pk);

        bool validatePropertyKindAssociation(const gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind & pk);

    private:

        template <class T>
        void setPropertyMinMax(
            T* values, 
            unsigned long long* numValuesInEachDimension,
            const unsigned int& numArrayDimensions,
            T * minimumValue = nullptr, T * maximumValue = nullptr)
        {
            gsoap_resqml2_0_1::_resqml2__ContinuousProperty* prop = static_cast<gsoap_resqml2_0_1::_resqml2__ContinuousProperty*>(gsoapProxy2_0_1);
            prop->MinimumValue.clear();
            prop->MaximumValue.clear();

            if (minimumValue != nullptr && maximumValue != nullptr) {
                for (unsigned int i = 0; i < prop->Count; ++i)
                {
                    prop->MinimumValue.push_back(minimumValue[i]);
                    prop->MaximumValue.push_back(maximumValue[i]);
                }
            }
            else {

                ULONG64 nValues = numValuesInEachDimension[0];
                if (prop->Count == 1) {
                    for (unsigned int dim = 1; dim < numArrayDimensions; dim++) {
                        nValues *= numValuesInEachDimension[dim];
                    }
                }
                else if (prop->Count > 1) {
                    //In this case, the last (fastest) dimension has the number of properties per indexable element of the representation.
                    for (unsigned int dim = 1; dim < numArrayDimensions - 1; dim++) {
                        nValues *= numValuesInEachDimension[dim];
                    }
                }
                else {
                    throw std::invalid_argument("Cannot compute and set min and max value on a property which has a Count set to zero or negative.");
                }

                for (unsigned int propIndex = 0; propIndex < prop->Count; ++propIndex) {
                    size_t i = propIndex;
                    T computedMin = std::numeric_limits<T>::quiet_NaN();
                    T computedMax = std::numeric_limits<T>::quiet_NaN();
                    while (i < nValues && values[i] != values[i]) i += prop->Count;
                    if (i >= nValues) {
                        throw std::invalid_argument("All values of a dimension of the vectorial property look to be only NaN values.");
                    }
                    computedMin = values[i];
                    computedMax = values[i];

                    for (; i < nValues; i += prop->Count) {
                        T propVal = values[i];
                        if (propVal < computedMin) {
                            computedMin = propVal;
                        }
                        else if (propVal > computedMax) {
                            computedMax = propVal;
                        }
                    }
                    prop->MinimumValue.push_back(computedMin);
                    prop->MaximumValue.push_back(computedMax);
                }
            }
        }
    };
}