SubRepresentation.h

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

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

namespace resqml2_0_1
{
    class DLL_IMPORT_OR_EXPORT SubRepresentation : public resqml2::SubRepresentation
    {
    private:
        /*
        * @param soapContext    The soap context where the underlying gsoap proxy will be created.
        * @param guid           The guid to set to this instance.
        * @param title          A title for the instance to init.
        */
        void init(soap* soapContext, const std::string & guid, const std::string & title);

        gsoap_resqml2_0_1::_resqml2__SubRepresentation* getSpecializedGsoapProxy() const;

        gsoap_resqml2_0_1::resqml2__SubRepresentationPatch* getSubRepresentationPatch(const unsigned int & index) const;

        void pushBackXmlSupportingRepresentation(resqml2::AbstractRepresentation * supportingRep);

        class DiscreteProperty* getSupportingRepresentationIndicesDiscretePropOfPatch(const unsigned int & patchIndex) const;

    public:

        SubRepresentation(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject):
            resqml2::SubRepresentation(partialObject) {}

        SubRepresentation(soap* soapContext, const std::string & guid, const std::string & title);

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

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

        ~SubRepresentation() {}

        std::string getHdfProxyUuid() const;

        resqml2::AbstractRepresentation::indexableElement getElementKindOfPatch(const unsigned int & patchIndex, const unsigned int & elementIndicesIndex) const;

        ULONG64 getElementCountOfPatch(const unsigned int & patchIndex) const;

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

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

        bool areElementIndicesPairwise(const unsigned int & patchIndex) const;

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

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

        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);

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

        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::AbstractHdfProxy* proxy);

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

        unsigned int getPatchCount() const;

        unsigned int getSupportingRepresentationCount() const;

        gsoap_resqml2_0_1::eml20__DataObjectReference* getSupportingRepresentationDor(unsigned int index) const;
    };
}