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_0_1_NS
{
    class DLL_IMPORT_OR_EXPORT SubRepresentation : public RESQML2_NS::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_NS::AbstractRepresentation * supportingRep);

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

    public:

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

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

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

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

        ~SubRepresentation() {}

        std::string getHdfProxyUuid() const;

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

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

        unsigned int getPatchCount() const;

        unsigned int getSupportingRepresentationCount() const;

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