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

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

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

        IjkGridLatticeRepresentation(resqml2::AbstractFeatureInterpretation* interp, resqml2::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;
    };
}