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

namespace resqml2
{
    class DLL_IMPORT_OR_EXPORT GridConnectionSetRepresentation : public AbstractRepresentation
    {
    protected:

        GridConnectionSetRepresentation(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) :
            AbstractRepresentation(partialObject) {}

        GridConnectionSetRepresentation(class AbstractFeatureInterpretation* interp) : AbstractRepresentation(interp, nullptr) {}

        GridConnectionSetRepresentation(gsoap_resqml2_0_1::_resqml2__GridConnectionSetRepresentation* fromGsoap) : AbstractRepresentation(fromGsoap) {}

        virtual void pushBackXmlInterpretation(class AbstractFeatureInterpretation* interp) = 0;
        virtual void pushBackXmlSupportingGridRepresentation(class AbstractGridRepresentation * supportingGridRep) = 0;

    public:

        virtual ~GridConnectionSetRepresentation() {}
        
        static const char* XML_TAG;
        virtual std::string getXmlTag() const;

        virtual std::string getHdfProxyUuid() const = 0;

        virtual ULONG64 getCellIndexPairCount() const = 0;

        virtual ULONG64 getCellIndexPairs(ULONG64 * cellIndexPairs) const = 0;

        virtual unsigned int getCellIndexPairCountFromInterpretationIndex(const unsigned int & interpretationIndex) const = 0;

        virtual bool isAssociatedToInterpretations() const = 0;

        virtual void getInterpretationIndexCumulativeCount(unsigned int * cumulativeCount) const = 0;

        virtual void getInterpretationIndices(unsigned int * interpretationIndices) const = 0;

        virtual LONG64 getInterpretationIndexNullValue() const = 0;

        virtual void getGridConnectionSetInformationFromInterpretationIndex(ULONG64 * cellIndexPairs, ULONG64 * gridIndexPairs, int * localFaceIndexPairs, const unsigned int & interpretationIndex) const = 0;

        virtual std::string getInterpretationUuidFromIndex(const unsigned int & interpretationIndex) const = 0;

        class AbstractFeatureInterpretation * getInterpretationFromIndex(const unsigned int & interpretationIndex) const;

        virtual unsigned int getInterpretationCount() const = 0;

        virtual bool hasLocalFacePerCell() const = 0;

        virtual void getLocalFacePerCellIndexPairs(int * localFacePerCellIndexPairs) const = 0;

        virtual bool isBasedOnMultiGrids() const = 0;

        virtual void getGridIndexPairs(ULONG64 * gridIndexPairs) const = 0;

        virtual void setCellIndexPairsUsingExistingDataset(const ULONG64 & cellIndexPairCount, const std::string & cellIndexPair, const ULONG64 & nullValue, common::AbstractHdfProxy * proxy, const std::string & gridIndexPair = "") = 0;

        void setCellIndexPairs(const ULONG64 & cellIndexPairCount, ULONG64 * cellIndexPair, const ULONG64 & nullValue, common::AbstractHdfProxy * proxy, ULONG64 * gridIndexPair = nullptr);

        virtual void setLocalFacePerCellIndexPairs(const ULONG64 & cellIndexPairCount, int * localFacePerCellIndexPair, common::AbstractHdfProxy * proxy) = 0;

        virtual void setConnectionInterpretationIndices(unsigned int * interpretationIndices, const unsigned int & interpretationIndiceCount, const ULONG64 & nullValue, common::AbstractHdfProxy * proxy) = 0;

        void pushBackInterpretation(class AbstractFeatureInterpretation* interp);
    
        void pushBackSupportingGridRepresentation(class AbstractGridRepresentation * supportingGridRep);
        
        virtual unsigned int getSupportingGridRepresentationCount() const = 0;

        class AbstractGridRepresentation* getSupportingGridRepresentation(unsigned int index) const;

        virtual gsoap_resqml2_0_1::eml20__DataObjectReference* getSupportingGridRepresentationDor(unsigned int index) const = 0;
        
        std::string getSupportingGridRepresentationUuid(unsigned int index) const;

        std::string getSupportingGridRepresentationTitle(unsigned int index) const;

        std::string getSupportingGridRepresentationContentType(unsigned int index) const;

        ULONG64 getXyzPointCountOfPatch(const unsigned int & patchIndex) const;

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

        unsigned int getPatchCount() const {return 1;}

    private:

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