Grid2dRepresentation.h

/*-----------------------------------------------------------------------
Copyright F2I-CONSULTING, (2014-2016) 

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

namespace resqml2_0_1
{
    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);

    public:
        Grid2dRepresentation(resqml2::AbstractFeatureInterpretation* interp, resqml2::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 getXOriginInGlobalCrs() const;

        double getYOriginInGlobalCrs() const;

        double getXJOffset() const;

        double getYJOffset() const;

        double getXJOffsetInGlobalCrs() const;

        double getYJOffsetInGlobalCrs() const;

        double getXIOffset() const;

        double getYIOffset() const;

        double getXIOffsetInGlobalCrs() const;

        double getYIOffsetInGlobalCrs() 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, resqml2::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, resqml2::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::EpcDocument* epcDoc);

        // Forward relationships
        Grid2dRepresentation * supportingRepresentation;

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

        friend void Grid2dSetRepresentation::pushBackGeometryPatch(
                double * zValues,
                const unsigned int & numI, const unsigned int & numJ, resqml2::AbstractHdfProxy* proxy,
                Grid2dRepresentation * supportingGrid2dRepresentation,
                const unsigned int & startIndexI, const unsigned int & startIndexJ,
                const int & indexIncrementI, const int & indexIncrementJ);
    };
}