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

namespace common {
    class AbstractHdfProxy;
}

namespace resqml2
{
    class DLL_IMPORT_OR_EXPORT AbstractRepresentation : public common::AbstractObject
    {
    protected:

        AbstractRepresentation(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : common::AbstractObject(partialObject), interpretation(nullptr), hdfProxy(nullptr), localCrs(nullptr) {}

        AbstractRepresentation(class AbstractFeatureInterpretation* interp, class AbstractLocal3dCrs * crs);

        AbstractRepresentation(gsoap_resqml2_0_1::resqml2__AbstractRepresentation* fromGsoap) : common::AbstractObject(fromGsoap), interpretation(nullptr), hdfProxy(nullptr), localCrs(nullptr) {}

        void pushBackSeismicSupport(AbstractRepresentation * seismicSupport);

        void setXmlInterpretation(class AbstractFeatureInterpretation * interp);

        virtual gsoap_resqml2_0_1::resqml2__PointGeometry* getPointGeometry2_0_1(const unsigned int & patchIndex) const { return nullptr; }

        gsoap_resqml2_0_1::resqml2__PointGeometry* createPointGeometryPatch2_0_1(const unsigned int & patchIndex, double * points, unsigned long long * numPoints, const unsigned int & numDimensionsInArray, common::AbstractHdfProxy * proxy);

        std::string getHdfProxyUuidFromPointGeometryPatch(gsoap_resqml2_0_1::resqml2__PointGeometry* patch) const;

        gsoap_resqml2_0_1::resqml2__Seismic2dCoordinates* getSeismic2dCoordinates(const unsigned int & patchIndex) const;

        gsoap_resqml2_0_1::resqml2__Seismic3dCoordinates* getSeismic3dCoordinates(const unsigned int & patchIndex) const;

    public:

        enum indexableElement { NODE = 0, EDGE = 1, FACE = 2, VOLUME = 3, PILLAR = 4 };

        virtual ~AbstractRepresentation() {}

        class AbstractLocal3dCrs* getLocalCrs() const;

        virtual gsoap_resqml2_0_1::eml20__DataObjectReference* getLocalCrsDor() const;
        
        std::string getLocalCrsUuid() const;

        common::AbstractHdfProxy* getHdfProxy() const;

        /*
         * Getter for the uuid of the hdf proxy which is used for storing the numerical values of this representation i.e. geometry.
         * An empty string is returned if no hdf proxy is used for storing the representation/geometry.
         */
        virtual std::string getHdfProxyUuid() const = 0;

        const std::vector<class AbstractProperty*> & getPropertySet() const;

        std::vector<class AbstractValuesProperty*> getValuesPropertySet() const;

        unsigned int getValuesPropertyCount() const;

        class AbstractValuesProperty* getValuesProperty(const unsigned int & index) const;

        void setInterpretation(class AbstractFeatureInterpretation * interp);

        class AbstractFeatureInterpretation* getInterpretation() const;

        gsoap_resqml2_0_1::eml20__DataObjectReference* getInterpretationDor() const;

        std::string getInterpretationUuid() const;

        std::string getInterpretationContentType() const;

        void pushBackSubRepresentation(class SubRepresentation* subRep);

        std::vector<SubRepresentation*> getSubRepresentationSet() const;

        unsigned int getSubRepresentationCount() const;

        SubRepresentation* getSubRepresentation(const unsigned int & index) const;

        std::vector<SubRepresentation*> getFaultSubRepresentationSet() const;

        unsigned int getFaultSubRepresentationCount() const;

        SubRepresentation* getFaultSubRepresentation(const unsigned int & index) const;
        
        virtual ULONG64 getXyzPointCountOfPatch(const unsigned int & patchIndex) const = 0;

        ULONG64 getXyzPointCountOfAllPatches() const;

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

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

        void getXyzPointsOfAllPatches(double * xyzPoints) const;

        void getXyzPointsOfAllPatchesInGlobalCrs(double * xyzPoints) const;

        //const std::vector<AbstractRepresentation*> & getSeismicSupportSet() {return seismicSupportSet;}
        
        //std::vector<std::string> getSeismicSupportUuidSet();

        //unsigned int getSeismicPointCountOfPatch(const unsigned int & patchIndex);

        AbstractRepresentation* getSeismicSupportOfPatch(const unsigned int & patchIndex);

        virtual unsigned int getPatchCount() const = 0;

        void pushBackIntoRepresentationSet(class RepresentationSetRepresentation * repSet, bool xml = true);

        ULONG64 getRepresentationSetRepresentationCount() const;

        RepresentationSetRepresentation* getRepresentationSetRepresentation(const ULONG64  & index) const;

        void setHdfProxy(common::AbstractHdfProxy * proxy);

        void addSeismic3dCoordinatesToPatch(const unsigned int patchIndex, double * inlines, double * crosslines, const unsigned int & pointCount,
            resqml2::AbstractRepresentation * seismicSupport, common::AbstractHdfProxy * proxy);

        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,
            resqml2::AbstractRepresentation * seismicSupport);

        void addSeismic2dCoordinatesToPatch(const unsigned int patchIndex, double * lineAbscissa, const unsigned int & pointCount,
            resqml2::AbstractRepresentation * seismicSupport, common::AbstractHdfProxy * proxy);

        void getSeismicLineAbscissaOfPointsOfPatch(const unsigned int & patchIndex, double* values);

        static const char* XML_TAG;

    protected:

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

        // XML forward relationships
        class AbstractFeatureInterpretation*                interpretation;
        common::AbstractHdfProxy *                          hdfProxy;
        class AbstractLocal3dCrs *                          localCrs;
        std::vector<AbstractRepresentation*>                seismicSupportSet;

        // XML backward relationships
        std::vector<SubRepresentation*>                     subRepresentationSet;
        std::vector<AbstractProperty*>                      propertySet;
        std::vector<AbstractRepresentation*>                seismicSupportedRepSet;
        std::vector<class RepresentationSetRepresentation*> representationSetRepresentationSet;

        friend void AbstractProperty::setRepresentation(AbstractRepresentation * rep);
    };
}