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

namespace RESQML2_NS
{
    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, unsigned short * 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 LONG64 getLocalFacePerCellIndexPairs(int * localFacePerCellIndexPairs) const = 0;

        virtual bool isBasedOnMultiGrids() const = 0;

        virtual void getGridIndexPairs(unsigned short * gridIndexPairs) const = 0;

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

        void setCellIndexPairs(const ULONG64 & cellIndexPairCount, ULONG64 * cellIndexPair, const LONG64 & nullValue, COMMON_NS::AbstractHdfProxy * proxy, unsigned short * gridIndexPair = nullptr);

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

        virtual void setConnectionInterpretationIndices(unsigned int * interpretationIndices, const unsigned int & interpretationIndiceCount, const LONG64 & nullValue, COMMON_NS::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_NS::EpcDocument* epcDoc);
    };
}