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 "AbstractSurfaceRepresentation.h"
 
namespace RESQML2_NS
{
    class Grid2dRepresentation : public AbstractSurfaceRepresentation
    {
    public:
        virtual ~Grid2dRepresentation() = default;

        DLL_IMPORT_OR_EXPORT virtual uint64_t getNodeCountAlongIAxis() const = 0;

        DLL_IMPORT_OR_EXPORT virtual uint64_t getNodeCountAlongJAxis() const = 0;
 
        DLL_IMPORT_OR_EXPORT uint64_t getXyzPointCountOfPatch(uint64_t patchIndex) const final;

        DLL_IMPORT_OR_EXPORT void getXyzPointsOfPatch(uint64_t patchIndex, double * xyzPoints) const final;

        DLL_IMPORT_OR_EXPORT virtual void getZValues(double * values) const = 0;

        DLL_IMPORT_OR_EXPORT void getZValuesInGlobalCrs(double * values) const;

        DLL_IMPORT_OR_EXPORT virtual double getXOrigin() const = 0;

        DLL_IMPORT_OR_EXPORT virtual double getYOrigin() const = 0;

        DLL_IMPORT_OR_EXPORT virtual double getZOrigin() const = 0;

        DLL_IMPORT_OR_EXPORT double getXOriginInGlobalCrs() const;

        DLL_IMPORT_OR_EXPORT double getYOriginInGlobalCrs() const;

        DLL_IMPORT_OR_EXPORT double getZOriginInGlobalCrs() const;

        DLL_IMPORT_OR_EXPORT virtual double getXJOffset() const = 0;

        DLL_IMPORT_OR_EXPORT virtual double getYJOffset() const = 0;

        DLL_IMPORT_OR_EXPORT virtual double getZJOffset() const = 0;

        DLL_IMPORT_OR_EXPORT double getXJOffsetInGlobalCrs() const;

        DLL_IMPORT_OR_EXPORT double getYJOffsetInGlobalCrs() const;

        DLL_IMPORT_OR_EXPORT double getZJOffsetInGlobalCrs() const;

        DLL_IMPORT_OR_EXPORT virtual double getXIOffset() const = 0;

        DLL_IMPORT_OR_EXPORT virtual double getYIOffset() const = 0;

        DLL_IMPORT_OR_EXPORT virtual double getZIOffset() const = 0;

        DLL_IMPORT_OR_EXPORT double getXIOffsetInGlobalCrs() const;

        DLL_IMPORT_OR_EXPORT double getYIOffsetInGlobalCrs() const;

        DLL_IMPORT_OR_EXPORT double getZIOffsetInGlobalCrs() const;

        DLL_IMPORT_OR_EXPORT virtual bool isJSpacingConstant() const = 0;

        DLL_IMPORT_OR_EXPORT virtual bool isISpacingConstant() const = 0;

        DLL_IMPORT_OR_EXPORT virtual double getJSpacing() const = 0;

        DLL_IMPORT_OR_EXPORT virtual void getJSpacing(double* jSpacings) const = 0;

        DLL_IMPORT_OR_EXPORT virtual double getISpacing() const = 0;

        DLL_IMPORT_OR_EXPORT virtual void getISpacing(double* iSpacings) const = 0;

        DLL_IMPORT_OR_EXPORT virtual void setGeometryAsArray2dOfLatticePoints3d(
            unsigned int numPointsInFastestDirection, unsigned int numPointsInSlowestDirection,
            double xOrigin, double yOrigin, double zOrigin,
            double xOffsetInFastestDirection, double yOffsetInFastestDirection, double zOffsetInFastestDirection,
            double xOffsetInSlowestDirection, double yOffsetInSlowestDirection, double zOffsetInSlowestDirection,
            double spacingInFastestDirection, double spacingInSlowestDirection, EML2_NS::AbstractLocal3dCrs * localCrs = nullptr) = 0;

        DLL_IMPORT_OR_EXPORT virtual void setGeometryAsArray2dOfExplicitZ(
            double * zValues,
            unsigned int numI, unsigned int numJ, EML2_NS::AbstractHdfProxy* proxy,
            Grid2dRepresentation * supportingGrid2dRepresentation, EML2_NS::AbstractLocal3dCrs * localCrs = nullptr,
            unsigned int startIndexI = 0, unsigned int startIndexJ = 0,
            int indexIncrementI = 1, int indexIncrementJ = 1) = 0;

        DLL_IMPORT_OR_EXPORT virtual void setGeometryAsArray2dOfExplicitZ(
            double * zValues,
            unsigned int numI, unsigned int numJ, EML2_NS::AbstractHdfProxy* proxy,
            double originX, double originY, double originZ,
            double offsetIX, double offsetIY, double offsetIZ, double spacingI,
            double offsetJX, double offsetJY, double offsetJZ, double spacingJ, EML2_NS::AbstractLocal3dCrs * localCrs = nullptr) = 0;

        virtual COMMON_NS::DataObjectReference getSupportingRepresentationDor() const = 0;

        DLL_IMPORT_OR_EXPORT Grid2dRepresentation* getSupportingRepresentation() const;

        DLL_IMPORT_OR_EXPORT virtual uint64_t getIndexOriginOnSupportingRepresentation() const = 0;

        DLL_IMPORT_OR_EXPORT virtual int getIndexOriginOnSupportingRepresentation(unsigned int dimension) const = 0;

        DLL_IMPORT_OR_EXPORT virtual uint64_t getNodeCountOnSupportingRepresentation(unsigned int dimension) const = 0;

        DLL_IMPORT_OR_EXPORT virtual int64_t getIndexOffsetOnSupportingRepresentation(unsigned int dimension) const = 0;
 
        DLL_IMPORT_OR_EXPORT uint64_t getPatchCount() const final {return 1;}

        DLL_IMPORT_OR_EXPORT static const char* XML_TAG;
 
        DLL_IMPORT_OR_EXPORT std::string getXmlTag() const final { return XML_TAG; }
 
    protected:
        
        DLL_IMPORT_OR_EXPORT Grid2dRepresentation(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : AbstractSurfaceRepresentation(partialObject) {}

        Grid2dRepresentation() {}

        Grid2dRepresentation(gsoap_resqml2_0_1::_resqml20__Grid2dRepresentation* fromGsoap) : AbstractSurfaceRepresentation(fromGsoap) {}

        Grid2dRepresentation(gsoap_eml2_3::_resqml22__Grid2dRepresentation* fromGsoap) : AbstractSurfaceRepresentation(fromGsoap) {}

        double getComponentInGlobalCrs(double x, double y, double z, size_t componentIndex, bool withoutTranslation = false) const;

        void loadTargetRelationships() final;
    };
}