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

namespace RESQML2_NS
{
    class DLL_IMPORT_OR_EXPORT SubRepresentation : public RESQML2_NS::AbstractRepresentation
    {
    protected:

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

        SubRepresentation(RESQML2_NS::AbstractFeatureInterpretation* interp) : RESQML2_NS::AbstractRepresentation(interp, nullptr) {}

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

        virtual void pushBackXmlSupportingRepresentation(AbstractRepresentation * supportingRep) = 0;

    public:

        virtual ~SubRepresentation() {}
        
        static const char* XML_TAG;
        virtual std::string getXmlTag() const {return XML_TAG;}

        virtual indexableElement getElementKindOfPatch(const unsigned int & patchIndex, const unsigned int & elementIndicesIndex) const = 0;

        virtual ULONG64 getElementCountOfPatch(const unsigned int & patchIndex) const = 0;

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

        virtual void getSupportingRepresentationIndicesOfPatch(const unsigned int & patchIndex, short * supportingRepresentationIndices) const = 0;

        virtual bool areElementIndicesPairwise(const unsigned int & patchIndex) const = 0;

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

        virtual LONG64 getLatticeElementIndicesStartValue(const unsigned int & patchIndex, const unsigned int & elementIndicesIndex = 0) const = 0;
        virtual unsigned int getLatticeElementIndicesDimensionCount(const unsigned int & patchIndex, const unsigned int & elementIndicesIndex = 0) const = 0;
        virtual LONG64 getLatticeElementIndicesOffsetValue(const unsigned int & latticeDimensionIndex, const unsigned int & patchIndex, const unsigned int & elementIndicesIndex = 0) const = 0;
        virtual ULONG64 getLatticeElementIndicesOffsetCount(const unsigned int & latticeDimensionIndex, const unsigned int & patchIndex, const unsigned int & elementIndicesIndex = 0) const = 0;

        virtual void pushBackSubRepresentationPatch(const gsoap_resqml2_0_1::resqml2__IndexableElements & elementKind, const ULONG64 & originIndex,
            const unsigned int & elementCountInSlowestDimension,
            const unsigned int & elementCountInMiddleDimension,
            const unsigned int & elementCountInFastestDimension) = 0;

        virtual void pushBackSubRepresentationPatch(const gsoap_resqml2_0_1::resqml2__IndexableElements & elementKind, const ULONG64 & elementCount, ULONG64 * elementIndices, COMMON_NS::AbstractHdfProxy* proxy, short * supportingRepIndices = nullptr) = 0;

        virtual void pushBackSubRepresentationPatch(const gsoap_resqml2_0_1::resqml2__IndexableElements & elementKind0, const gsoap_resqml2_0_1::resqml2__IndexableElements & elementKind1,
            const ULONG64 & elementCount,
            ULONG64 * elementIndices0, ULONG64 * elementIndices1,
            COMMON_NS::AbstractHdfProxy* proxy) = 0;

        virtual void pushBackRefToExistingDataset(const gsoap_resqml2_0_1::resqml2__IndexableElements & elementKind, const ULONG64 & elementCount, const std::string & elementDataset,
            const LONG64 & nullValue, COMMON_NS::AbstractHdfProxy * proxy, const std::string & supportingRepDataset = "") = 0;

        ULONG64 getXyzPointCountOfPatch(const unsigned int & patchIndex) const;

        void getXyzPointsOfPatch(const unsigned int & patchIndex, double * xyzPoints) const;

        virtual unsigned int getPatchCount() const = 0;

        void pushBackSupportingRepresentation(AbstractRepresentation * supportingRep);

        virtual unsigned int getSupportingRepresentationCount() const = 0;

        AbstractRepresentation* getSupportingRepresentation(unsigned int index) const;

        virtual gsoap_resqml2_0_1::eml20__DataObjectReference* getSupportingRepresentationDor(unsigned int index) const = 0;

        std::string getSupportingRepresentationUuid(unsigned int index) const;

        std::string getSupportingRepresentationTitle(unsigned int index) const;

        std::string getSupportingRepresentationContentType() const;

    private:

        gsoap_resqml2_0_1::resqml2__PointGeometry* getPointGeometry2_0_1(const unsigned int & patchIndex) const {return nullptr;}
        
        std::vector<epc::Relationship> getAllEpcRelationships() const;
        void importRelationshipSetFromEpc(COMMON_NS::EpcDocument* epcDoc);
    };
}