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

        virtual ~SubRepresentation() = default;

        DLL_IMPORT_OR_EXPORT virtual gsoap_eml2_3::eml23__IndexableElement getElementKindOfPatch(uint64_t patchIndex, unsigned int elementIndicesIndex) const = 0;

        DLL_IMPORT_OR_EXPORT virtual uint64_t getElementCountOfPatch(uint64_t patchIndex) const = 0;

        DLL_IMPORT_OR_EXPORT virtual void getElementIndicesOfPatch(uint64_t patchIndex, unsigned int elementIndicesIndex, uint64_t* elementIndices) const = 0;

        DLL_IMPORT_OR_EXPORT virtual void getSupportingRepresentationIndicesOfPatch(uint64_t patchIndex, short* supportingRepresentationIndices) const = 0;

        DLL_IMPORT_OR_EXPORT virtual bool areElementIndicesPairwise(uint64_t patchIndex) const = 0;

        DLL_IMPORT_OR_EXPORT virtual bool areElementIndicesBasedOnLattice(uint64_t patchIndex, unsigned int elementIndicesIndex = 0) const = 0;

        DLL_IMPORT_OR_EXPORT virtual int64_t getLatticeElementIndicesStartValue(uint64_t patchIndex, unsigned int elementIndicesIndex = 0) const = 0;

        DLL_IMPORT_OR_EXPORT virtual uint64_t getLatticeElementIndicesDimensionCount(uint64_t patchIndex, unsigned int elementIndicesIndex = 0) const = 0;

        DLL_IMPORT_OR_EXPORT virtual int64_t getLatticeElementIndicesOffsetValue(unsigned int latticeDimensionIndex, uint64_t patchIndex, unsigned int elementIndicesIndex = 0) const = 0;

        DLL_IMPORT_OR_EXPORT virtual uint64_t getLatticeElementIndicesOffsetCount(unsigned int latticeDimensionIndex, uint64_t patchIndex, unsigned int elementIndicesIndex = 0) const = 0;

        DLL_IMPORT_OR_EXPORT virtual void pushBackSubRepresentationPatch(gsoap_eml2_3::eml23__IndexableElement elementKind, uint64_t originIndex,
            unsigned int elementCountInSlowestDimension,
            unsigned int elementCountInMiddleDimension,
            unsigned int elementCountInFastestDimension) = 0;

        DLL_IMPORT_OR_EXPORT void pushBackSubRepresentationPatch(gsoap_eml2_3::eml23__IndexableElement elementKind, uint64_t elementCount, uint64_t* elementIndices,
            EML2_NS::AbstractHdfProxy* proxy = nullptr, short* supportingRepIndices = nullptr);

        DLL_IMPORT_OR_EXPORT void pushBackSubRepresentationPatch(gsoap_eml2_3::eml23__IndexableElement elementKind, uint64_t elementCount,
            EML2_NS::AbstractHdfProxy* proxy = nullptr);
 
        DLL_IMPORT_OR_EXPORT void setElementIndices(uint64_t* elementIndices, 
            uint64_t elementCount,
            uint64_t offset,
            EML2_NS::AbstractHdfProxy* proxy = nullptr,
            uint64_t patchIndex = (std::numeric_limits<unsigned int>::max)());
        
        DLL_IMPORT_OR_EXPORT virtual 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) = 0;

        DLL_IMPORT_OR_EXPORT virtual 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 = "") = 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 virtual uint64_t getPatchCount() const override = 0;

        DLL_IMPORT_OR_EXPORT void pushBackSupportingRepresentation(AbstractRepresentation * supportingRep);

        DLL_IMPORT_OR_EXPORT virtual uint64_t getSupportingRepresentationCount() const = 0;

        DLL_IMPORT_OR_EXPORT AbstractRepresentation* getSupportingRepresentation(uint64_t index) const;

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

        DLL_IMPORT_OR_EXPORT static constexpr char const* XML_TAG = "SubRepresentation";
 
        DLL_IMPORT_OR_EXPORT virtual std::string getXmlTag() const final { return XML_TAG; }

        void loadTargetRelationships() final;
 
    protected:

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

        SubRepresentation() {}

        SubRepresentation(gsoap_resqml2_0_1::_resqml20__SubRepresentation* fromGsoap) : RESQML2_NS::AbstractRepresentation(fromGsoap) {}

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

        virtual void pushBackXmlSupportingRepresentation(AbstractRepresentation const * supportingRep) = 0;
    };
}