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/GridConnectionSetRepresentation.h"
 
namespace RESQML2_0_1_NS
{
    class GridConnectionSetRepresentation final : public RESQML2_NS::GridConnectionSetRepresentation
    {
    public:

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

        GridConnectionSetRepresentation(RESQML2_NS::AbstractFeatureInterpretation* interp,
                const std::string & guid, const std::string & title);

        GridConnectionSetRepresentation(COMMON_NS::DataObjectRepository * repo,
            const std::string & guid, const std::string & title);

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

        ~GridConnectionSetRepresentation() = default;
 
        COMMON_NS::DataObjectReference getHdfProxyDor() const final;
 
        DLL_IMPORT_OR_EXPORT uint64_t getCellIndexPairCount() const final;
 
        DLL_IMPORT_OR_EXPORT int64_t getCellIndexPairs(int64_t * cellIndexPairs) const final;
 
        DLL_IMPORT_OR_EXPORT uint64_t getCellIndexPairCountFromInterpretationIndex(int64_t interpretationIndex) const final;
 
        DLL_IMPORT_OR_EXPORT bool isAssociatedToInterpretations() const final;
 
        DLL_IMPORT_OR_EXPORT void getInterpretationIndexCumulativeCount(uint64_t * cumulativeCount) const final;
 
        DLL_IMPORT_OR_EXPORT void getInterpretationIndices(int64_t * interpretationIndices) const final;
 
        DLL_IMPORT_OR_EXPORT int64_t getInterpretationIndexNullValue() const final;
 
        DLL_IMPORT_OR_EXPORT void getGridConnectionSetInformationFromInterpretationIndex(int64_t* cellIndexPairs, unsigned short * gridIndexPairs, int * localFaceIndexPairs, int64_t interpretationIndex) const final;
 
        DLL_IMPORT_OR_EXPORT COMMON_NS::DataObjectReference getInterpretationDorFromIndex(uint64_t interpretationIndex) const final;
 
        DLL_IMPORT_OR_EXPORT uint64_t getInterpretationCount() const final;
 
        DLL_IMPORT_OR_EXPORT bool hasLocalFacePerCell() const final;
 
        DLL_IMPORT_OR_EXPORT int64_t getLocalFacePerCellIndexPairs(int * localFacePerCellIndexPairs) const final;
 
        DLL_IMPORT_OR_EXPORT bool isBasedOnMultiGrids() const final;
 
        DLL_IMPORT_OR_EXPORT void getGridIndexPairs(unsigned short * gridIndexPairs) const final;
 
        DLL_IMPORT_OR_EXPORT 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 = "") final;
 
        DLL_IMPORT_OR_EXPORT void setInterpretationForAllConnections(RESQML2_NS::AbstractFeatureInterpretation* interp, EML2_NS::AbstractHdfProxy * proxy = nullptr) final;
 
        DLL_IMPORT_OR_EXPORT void setLocalFacePerCellIndexPairsUsingExistingDataset(const std::string & localFacePerCellIndexPair, int64_t nullValue, EML2_NS::AbstractHdfProxy * proxy = nullptr) final;
 
        DLL_IMPORT_OR_EXPORT void setConnectionInterpretationIndices(uint64_t const* cumulativeInterpCount, int64_t const* interpIndices, EML2_NS::AbstractHdfProxy * proxy = nullptr) final;
 
        DLL_IMPORT_OR_EXPORT uint64_t getSupportingGridRepresentationCount() const final;
 
        COMMON_NS::DataObjectReference getSupportingGridRepresentationDor(uint64_t index) const final;

        DLL_IMPORT_OR_EXPORT static const char* XML_NS;

        DLL_IMPORT_OR_EXPORT virtual std::string getXmlNamespace() const final { return XML_NS; }
 
    protected:

        void init(COMMON_NS::DataObjectRepository * repo, const std::string & guid, const std::string & title);

        void pushBackXmlInterpretation(RESQML2_NS::AbstractFeatureInterpretation* interp);
 
        /*
         * Pushes back a grid representation which is one of the support of this representation. And
         * push back this representation as a grid connection information of the grid representation as
         * well.
         *
         * @param [in,out]  supportingGridRep   If non-null, the supporting grid rep.
         */
        void pushBackXmlSupportingGridRepresentation(RESQML2_NS::AbstractGridRepresentation * supportingGridRep);
    };
}