Grid2dRepresentation.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 "resqml2_0_1/AbstractSurfaceRepresentation.h"

namespace RESQML2_0_1_NS
{
    class DLL_IMPORT_OR_EXPORT Grid2dRepresentation : public AbstractSurfaceRepresentation
    {
    private :
        gsoap_resqml2_0_1::resqml2__PointGeometry* getPointGeometry2_0_1(const unsigned int & patchIndex) const;
        gsoap_resqml2_0_1::resqml2__Point3dLatticeArray* getArrayLatticeOfPoints3d() const;

        void setSupportingRepresentation(Grid2dRepresentation * supportingRep);

        double getComponentInGlobalCrs(double x, double y, double z, size_t componentIndex) const;

    public:

        Grid2dRepresentation(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : AbstractSurfaceRepresentation(partialObject) {}

        Grid2dRepresentation(RESQML2_NS::AbstractFeatureInterpretation* interp, RESQML2_NS::AbstractLocal3dCrs * crs,
            const std::string & guid, const std::string & title);

        Grid2dRepresentation(gsoap_resqml2_0_1::_resqml2__Grid2dRepresentation* fromGsoap): AbstractSurfaceRepresentation(fromGsoap), supportingRepresentation(nullptr) {}

        ~Grid2dRepresentation() {}

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

        std::string getHdfProxyUuid() const;

        ULONG64 getNodeCountAlongIAxis() const;

        ULONG64 getNodeCountAlongJAxis() const;

        ULONG64 getXyzPointCountOfPatch(const unsigned int & patchIndex) const;

        void getXyzPointsOfPatch(const unsigned int & patchIndex, double * xyzPoints) const;

        void getZValues(double * values) const;

        void getZValuesInGlobalCrs(double * values) const;

        double getXOrigin() const;

        double getYOrigin() const;

        double getZOrigin() const;

        double getXOriginInGlobalCrs() const;

        double getYOriginInGlobalCrs() const;

        double getZOriginInGlobalCrs() const;

        double getXJOffset() const;

        double getYJOffset() const;

        double getZJOffset() const;

        double getXJOffsetInGlobalCrs() const;

        double getYJOffsetInGlobalCrs() const;

        double getZJOffsetInGlobalCrs() const;

        double getXIOffset() const;

        double getYIOffset() const;

        double getZIOffset() const;

        double getXIOffsetInGlobalCrs() const;

        double getYIOffsetInGlobalCrs() const;

        double getZIOffsetInGlobalCrs() const;

        bool isJSpacingConstant() const;

        bool isISpacingConstant() const;
        
        double getJSpacing() const;

        void getJSpacing(double* const jSpacings) const;

        double getISpacing() const;

        void getISpacing(double* const iSpacings) const;

        void setGeometryAsArray2dOfLatticePoints3d(
            const unsigned int & numPointsInFastestDirection, const unsigned int & numPointsInSlowestDirection,
            const double & xOrigin, const double & yOrigin, const double & zOrigin,
            const double & xOffsetInFastestDirection, const double & yOffsetInFastestDirection, const double & zOffsetInFastestDirection,
            const double & xOffsetInSlowestDirection, const double & yOffsetInSlowestDirection, const double & zOffsetInSlowestDirection,
            const double & spacingInFastestDirection, const double & spacingInSlowestDirection);

        void setGeometryAsArray2dOfExplicitZ(
                double * zValues,
                const unsigned int & numI, const unsigned int & numJ, COMMON_NS::AbstractHdfProxy* proxy,
                Grid2dRepresentation * supportingGrid2dRepresentation,
                const unsigned int & startIndexI = 0, const unsigned int & startIndexJ = 0,
                const int & indexIncrementI = 1, const int & indexIncrementJ = 1);

        void setGeometryAsArray2dOfExplicitZ(
                double * zValues,
                const unsigned int & numI, const unsigned int & numJ, COMMON_NS::AbstractHdfProxy* proxy,
                const double & originX, const double & originY, const double & originZ,
                const double & offsetIX, const double & offsetIY, const double & offsetIZ, const double & spacingI,
                const double & offsetJX, const double & offsetJY, const double & offsetJZ, const double & spacingJ);

        std::string getSupportingRepresentationUuid() const;

        Grid2dRepresentation*  getSupportingRepresentation() {return supportingRepresentation;}

        int getIndexOriginOnSupportingRepresentation() const;

        int getIndexOriginOnSupportingRepresentation(const unsigned int & dimension) const;

        int getNodeCountOnSupportingRepresentation(const unsigned int & dimension) const;

        int getIndexOffsetOnSupportingRepresentation(const unsigned int & dimension) const;

        unsigned int getPatchCount() const {return 1;}

    private:
        std::vector<epc::Relationship> getAllEpcRelationships() const;
        void importRelationshipSetFromEpc(COMMON_NS::EpcDocument* epcDoc);

        // Forward relationships
        Grid2dRepresentation * supportingRepresentation;

        // Backward relationships
        std::vector<AbstractRepresentation *> supportedRepresentationSet;
    };
}