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

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

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

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

        SubRepresentation(gsoap_eml2_3::_resqml22__SubRepresentation* fromGsoap) : RESQML2_NS::SubRepresentation(fromGsoap) {}

        ~SubRepresentation() = default;
 
        COMMON_NS::DataObjectReference getHdfProxyDor() const final;
 
        DLL_IMPORT_OR_EXPORT gsoap_eml2_3::eml23__IndexableElement getElementKindOfPatch(uint64_t patchIndex, unsigned int elementIndicesIndex) const final;
 
        DLL_IMPORT_OR_EXPORT uint64_t getElementCountOfPatch(uint64_t patchIndex) const final;
 
        DLL_IMPORT_OR_EXPORT void getElementIndicesOfPatch(uint64_t patchIndex, unsigned int elementIndicesIndex, uint64_t * elementIndices) const final;
 
        DLL_IMPORT_OR_EXPORT void getSupportingRepresentationIndicesOfPatch(uint64_t patchIndex, short * supportingRepresentationIndices) const final;
 
        DLL_IMPORT_OR_EXPORT bool areElementIndicesPairwise(uint64_t patchIndex) const final;
 
        DLL_IMPORT_OR_EXPORT bool areElementIndicesBasedOnLattice(uint64_t patchIndex, unsigned int elementIndicesIndex = 0) const final;
 
        DLL_IMPORT_OR_EXPORT int64_t getLatticeElementIndicesStartValue(uint64_t patchIndex, unsigned int elementIndicesIndex = 0) const;
        DLL_IMPORT_OR_EXPORT uint64_t getLatticeElementIndicesDimensionCount(uint64_t patchIndex, unsigned int elementIndicesIndex = 0) const final;
        DLL_IMPORT_OR_EXPORT int64_t getLatticeElementIndicesOffsetValue(unsigned int latticeDimensionIndex, uint64_t patchIndex, unsigned int elementIndicesIndex = 0) const final;
        DLL_IMPORT_OR_EXPORT uint64_t getLatticeElementIndicesOffsetCount(unsigned int latticeDimensionIndex, uint64_t patchIndex, unsigned int elementIndicesIndex = 0) const final;
 
        using RESQML2_NS::SubRepresentation::pushBackSubRepresentationPatch;
 
        DLL_IMPORT_OR_EXPORT void pushBackSubRepresentationPatch(gsoap_eml2_3::eml23__IndexableElement elementKind, uint64_t originIndex,
            unsigned int elementCountInSlowestDimension,
            unsigned int elementCountInMiddleDimension,
            unsigned int elementCountInFastestDimension) final;
 
        DLL_IMPORT_OR_EXPORT void pushBackSubRepresentationPatch(gsoap_eml2_3::eml23__IndexableElement elementKind0, gsoap_eml2_3::eml23__IndexableElement elementKind1,
            uint64_t elementCount,
            uint64_t * elementIndices0, uint64_t * elementIndices1,
            EML2_NS::AbstractHdfProxy* proxy = nullptr) final;
 
        DLL_IMPORT_OR_EXPORT void pushBackRefToExistingDataset(gsoap_eml2_3::eml23__IndexableElement elementKind, uint64_t elementCount, const std::string & elementDataset,
            int64_t nullValue, EML2_NS::AbstractHdfProxy * proxy, const std::string & supportingRepDataset = "") final;
 
        DLL_IMPORT_OR_EXPORT uint64_t getPatchCount() const final;
 
        DLL_IMPORT_OR_EXPORT uint64_t getSupportingRepresentationCount() const final;
 
        COMMON_NS::DataObjectReference getSupportingRepresentationDor(uint64_t index) const final;

        DLL_IMPORT_OR_EXPORT static const char* XML_NS;

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

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

        gsoap_eml2_3::_resqml22__SubRepresentation* getSpecializedGsoapProxy() const;

        gsoap_eml2_3::resqml22__SubRepresentationPatch* getSubRepresentationPatch(uint64_t patchIndex) const;

        void pushBackXmlSupportingRepresentation(RESQML2_NS::AbstractRepresentation const * supportingRep);
    };
}