IjkGridLatticeRepresentation.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/AbstractIjkGridRepresentation.h"

namespace RESQML2_0_1_NS
{
    class DLL_IMPORT_OR_EXPORT IjkGridLatticeRepresentation : public AbstractIjkGridRepresentation
    {
    private :
        gsoap_resqml2_0_1::resqml2__Point3dLatticeArray* getArrayLatticeOfPoints3d() const;
    public:

        IjkGridLatticeRepresentation(soap* soapContext, RESQML2_NS::AbstractLocal3dCrs * crs,
            const std::string & guid, const std::string & title,
            const unsigned int & iCount, const unsigned int & jCount, const unsigned int & kCount);

        IjkGridLatticeRepresentation(RESQML2_NS::AbstractFeatureInterpretation* interp, RESQML2_NS::AbstractLocal3dCrs * crs,
                const std::string & guid, const std::string & title,
                const unsigned int & iCount, const unsigned int & jCount, const unsigned int & kCount);

        IjkGridLatticeRepresentation(gsoap_resqml2_0_1::_resqml2__IjkGridRepresentation* fromGsoap): AbstractIjkGridRepresentation(fromGsoap) {}
        IjkGridLatticeRepresentation(gsoap_resqml2_0_1::_resqml2__TruncatedIjkGridRepresentation* fromGsoap) : AbstractIjkGridRepresentation(fromGsoap) {}

        ~IjkGridLatticeRepresentation() {}

        bool isASeismicCube() const;

        bool isAFaciesCube() const;

        ULONG64 getXyzPointCountOfPatch(const unsigned int & patchIndex) const;

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

        double getXOrigin() const;

        double getYOrigin() const;

        double getZOrigin() const;

        double getXOriginInGlobalCrs() const;

        double getYOriginInGlobalCrs() const;

        double getZOriginInGlobalCrs() const;

        /*****************************************************
        * Notice that, in seismic context, I is the slowest axis, J is the intermediate axis and K is the fastest axis.
        * In reservoir grid, I is the fastest axis, J is the intermediate axis and K is slowest axis.
        * It should be improved in future Resqml versions.
        *****************************************************/

        double getXIOffset() const;

        double getYIOffset() const;

        double getZIOffset() const;

        double getXJOffset() const;

        double getYJOffset() const;

        double getZJOffset() const;

        double getXKOffset() const;

        double getYKOffset() const;

        double getZKOffset() const;

        double getISpacing() const;

        double getJSpacing() const;

        double getKSpacing() const;

        int getOriginInline() const;

        int getOriginCrossline() const;

        int getInlineIOffset() const;

        int getInlineJOffset() const;

        int getInlineKOffset() const;

        int getCrosslineIOffset() const;

        int getCrosslineJOffset() const;

        int getCrosslineKOffset() const;

        void setGeometryAsCoordinateLineNodes(  const gsoap_resqml2_0_1::resqml2__PillarShape & mostComplexPillarGeometry,
                                                const gsoap_resqml2_0_1::resqml2__KDirection & kDirectionKind,
                                                const bool & isRightHanded,
                                                const double & originX, const double & originY, const double & originZ,
                                                const double & directionIX, const double & directionIY, const double & directionIZ, const double & spacingI,
                                                const double & directionJX, const double & directionJY, const double & directionJZ, const double & spacingJ,
                                                const double & directionKX, const double & directionKY, const double & directionKZ, const double & spacingK);

        void addSeismic3dCoordinatesToPatch(
                        const unsigned int patchIndex,
                        const double & startInline, const double & incrInline, const unsigned int & countInline,
                        const double & startCrossline, const double & incrCrossline, const unsigned int & countCrossline,
                        const unsigned int & countSample, AbstractRepresentation * seismicSupport);

        std::string getHdfProxyUuid() const;

        geometryKind getGeometryKind() const;
    };
}