SubRepresentation.h

/*-----------------------------------------------------------------------
Copyright F2I-CONSULTING, (2014-2016) 

philippe.verney@f2i-consulting.com

This software is a computer program whose purpose is to access to data formatted using Energistics standards.

This software is governed by the CeCILL-B license under French law and
abiding by the rules of distribution of free software.  You can  use, 
modify and/ or redistribute the software under the terms of the CeCILL-B
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info". 

As a counterpart to the access to the source code and  rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty  and the software's author,  the holder of the
economic rights,  and the successive licensors  have only  limited
liability. 

In this respect, the user's attention is drawn to the risks associated
with loading,  using,  modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean  that it is complicated to manipulate,  and  that  also
therefore means  that it is reserved for developers  and  experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or 
data to be ensured and,  more generally, to use and operate it in the 
same conditions as regards security. 

The fact that you are presently reading this means that you have had
knowledge of the CeCILL-B license and that you accept its terms.
-----------------------------------------------------------------------*/
#pragma once

#include "resqml2/AbstractRepresentation.h"

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

        SubRepresentation(gsoap_resqml2_0_1::eml__DataObjectReference* partialObject) :
            resqml2::AbstractRepresentation(nullptr, partialObject)
        {
        }

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

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

    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 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, resqml2::AbstractHdfProxy* proxy) = 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,
            resqml2::AbstractHdfProxy* proxy) = 0;

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

        ULONG64 getXyzPointCountOfPatch(const unsigned int & patchIndex) const;

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

        virtual unsigned int getPatchCount() const = 0;

        resqml2::AbstractRepresentation* getSupportingRepresentation() const;

        virtual std::string getSupportingRepresentationUuid() const = 0;

        virtual std::string getSupportingRepresentationTitle() const = 0;

        virtual std::string getSupportingRepresentationContentType() const = 0;

    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::EpcDocument* epcDoc);
    };
}