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 <limits>
 
#include "AbstractRepresentation.h"
 
namespace RESQML2_NS
{
    class GridConnectionSetRepresentation : public AbstractRepresentation
    {
    public:

        virtual ~GridConnectionSetRepresentation() = default;

        DLL_IMPORT_OR_EXPORT virtual uint64_t getCellIndexPairCount() const = 0;

        DLL_IMPORT_OR_EXPORT virtual int64_t getCellIndexPairs(int64_t * cellIndexPairs) const = 0;

        DLL_IMPORT_OR_EXPORT virtual uint64_t getCellIndexPairCountFromInterpretationIndex(int64_t interpretationIndex) const = 0;

        DLL_IMPORT_OR_EXPORT virtual bool isAssociatedToInterpretations() const = 0;

        DLL_IMPORT_OR_EXPORT virtual void getInterpretationIndexCumulativeCount(uint64_t * cumulativeCount) const = 0;

        DLL_IMPORT_OR_EXPORT virtual void getInterpretationIndices(int64_t * interpretationIndices) const = 0;

        DLL_IMPORT_OR_EXPORT virtual int64_t getInterpretationIndexNullValue() const = 0;

        DLL_IMPORT_OR_EXPORT virtual void getGridConnectionSetInformationFromInterpretationIndex(int64_t * cellIndexPairs, unsigned short * gridIndexPairs, int * localFaceIndexPairs, int64_t interpretationIndex) const = 0;

        DLL_IMPORT_OR_EXPORT std::string getInterpretationUuidFromIndex(uint64_t interpretationIndex) const {
            return getInterpretationDorFromIndex(interpretationIndex).getUuid();
        }

        DLL_IMPORT_OR_EXPORT virtual COMMON_NS::DataObjectReference getInterpretationDorFromIndex(uint64_t interpretationIndex) const = 0;

        DLL_IMPORT_OR_EXPORT class AbstractFeatureInterpretation* getInterpretationFromIndex(uint64_t interpretationIndex) const;

        DLL_IMPORT_OR_EXPORT virtual uint64_t getInterpretationCount() const = 0;

        DLL_IMPORT_OR_EXPORT virtual bool hasLocalFacePerCell() const = 0;

        DLL_IMPORT_OR_EXPORT virtual int64_t getLocalFacePerCellIndexPairs(int * localFacePerCellIndexPairs) const = 0;

        DLL_IMPORT_OR_EXPORT virtual bool isBasedOnMultiGrids() const = 0;

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

        DLL_IMPORT_OR_EXPORT virtual void setCellIndexPairsUsingExistingDataset(uint64_t cellIndexPairCount, const std::string & cellIndexPair, int64_t cellIndexPairNullValue, EML2_NS::AbstractHdfProxy * proxy = nullptr,
            int64_t gridIndexPairNullValue = -1, const std::string & gridIndexPair = "") = 0;

        DLL_IMPORT_OR_EXPORT void setCellIndexPairs(uint64_t cellIndexPairCount, int64_t const* cellIndexPair, int64_t cellIndexPairNullValue = -1, EML2_NS::AbstractHdfProxy * proxy = nullptr,
            uint16_t gridIndexPairNullValue = (std::numeric_limits<uint16_t>::max)(), uint16_t const* gridIndexPair = nullptr);

        DLL_IMPORT_OR_EXPORT virtual void setLocalFacePerCellIndexPairsUsingExistingDataset(const std::string & localFacePerCellIndexPair, int64_t nullValue, EML2_NS::AbstractHdfProxy * proxy = nullptr) = 0;

        DLL_IMPORT_OR_EXPORT void setLocalFacePerCellIndexPairs(int const* localFacePerCellIndexPair, int nullValue, EML2_NS::AbstractHdfProxy * proxy = nullptr);

        DLL_IMPORT_OR_EXPORT virtual void setConnectionInterpretationIndices(uint64_t const* cumulativeInterpCount, int64_t const* interpIndices, EML2_NS::AbstractHdfProxy * proxy = nullptr) = 0;

        DLL_IMPORT_OR_EXPORT void pushBackInterpretation(class AbstractFeatureInterpretation* interp);

        DLL_IMPORT_OR_EXPORT virtual void setInterpretationForAllConnections(class AbstractFeatureInterpretation* interp, EML2_NS::AbstractHdfProxy * proxy = nullptr) = 0;

        DLL_IMPORT_OR_EXPORT void pushBackSupportingGridRepresentation(class AbstractGridRepresentation * supportingGridRep);

        DLL_IMPORT_OR_EXPORT virtual uint64_t getSupportingGridRepresentationCount() const = 0;

        DLL_IMPORT_OR_EXPORT class AbstractGridRepresentation* getSupportingGridRepresentation(uint64_t index) const;

        DLL_IMPORT_OR_EXPORT virtual COMMON_NS::DataObjectReference getSupportingGridRepresentationDor(uint64_t index) const = 0;

        DLL_IMPORT_OR_EXPORT uint64_t getXyzPointCountOfPatch(uint64_t patchIndex) const override;

        DLL_IMPORT_OR_EXPORT void getXyzPointsOfPatch(uint64_t patchIndex, double * xyzPoints) const override;
 
        DLL_IMPORT_OR_EXPORT uint64_t getPatchCount() const override {return 1;}

        DLL_IMPORT_OR_EXPORT static const char* XML_TAG;
 
        DLL_IMPORT_OR_EXPORT virtual std::string getXmlTag() const override { return XML_TAG; }
 
    protected:

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

        GridConnectionSetRepresentation() {}

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

        GridConnectionSetRepresentation(gsoap_eml2_3::_resqml22__GridConnectionSetRepresentation* fromGsoap) : AbstractRepresentation(fromGsoap) {}

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

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

        void loadTargetRelationships() final;
    };
}