SealedVolumeFrameworkRepresentation.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 "RepresentationSetRepresentation.h"
 
namespace RESQML2_NS
{
    class SealedSurfaceFrameworkRepresentation;
    class StratigraphicColumnRankInterpretation;
    class StratigraphicUnitInterpretation;

    class SealedVolumeFrameworkRepresentation : public RepresentationSetRepresentation
    {
    public:

        virtual ~SealedVolumeFrameworkRepresentation() = default;

        DLL_IMPORT_OR_EXPORT void setSealedSurfaceFramework(SealedSurfaceFrameworkRepresentation* ssf);

        DLL_IMPORT_OR_EXPORT void setInterpretationOfVolumeRegion(uint64_t regionIndex, StratigraphicUnitInterpretation * stratiUnitInterp);

        DLL_IMPORT_OR_EXPORT virtual void pushBackVolumeRegion(StratigraphicUnitInterpretation * stratiUnitInterp,
            unsigned int externalShellFaceCount,
            unsigned int const* faceRepresentationIndices, unsigned int const* faceRepPatchIndices, bool const* faceSide) = 0;

        DLL_IMPORT_OR_EXPORT virtual void pushBackInternalShell(uint64_t regionIndex,
            unsigned int internalShellFaceCount,
            unsigned int const* faceRepresentationIndices, unsigned int const* faceRepPatchIndices, bool const* faceSide) = 0;

        DLL_IMPORT_OR_EXPORT SealedSurfaceFrameworkRepresentation* getSealedStructuralFramework() const;

        DLL_IMPORT_OR_EXPORT class StratigraphicUnitInterpretation* getStratiUnitInterp(uint64_t regionIndex) const;

        DLL_IMPORT_OR_EXPORT virtual uint64_t getRegionCount() const = 0;

        DLL_IMPORT_OR_EXPORT virtual uint64_t getInternalShellCount(uint64_t regionIndex) const = 0;

        DLL_IMPORT_OR_EXPORT virtual uint64_t getFaceCountOfExternalShell(uint64_t regionIndex) const = 0;

        DLL_IMPORT_OR_EXPORT virtual uint64_t getFaceCountOfInternalShell(uint64_t regionIndex, unsigned int internalShellIndex) const = 0;

        DLL_IMPORT_OR_EXPORT virtual RESQML2_NS::AbstractRepresentation* getRepOfExternalShellFace(uint64_t regionIndex, unsigned int faceIndex) const = 0;

        DLL_IMPORT_OR_EXPORT virtual RESQML2_NS::AbstractRepresentation* getRepOfInternalShellFace(uint64_t regionIndex, unsigned int internalShellIndex, unsigned int faceIndex) const = 0;

        DLL_IMPORT_OR_EXPORT virtual uint64_t getRepPatchIndexOfExternalShellFace(uint64_t regionIndex, unsigned int faceIndex) const = 0;

        DLL_IMPORT_OR_EXPORT virtual uint64_t getRepPatchIndexOfInternalShellFace(uint64_t regionIndex, unsigned int internalShellIndex, unsigned int faceIndex) const = 0;

        DLL_IMPORT_OR_EXPORT virtual bool getSideFlagOfExternalShellFace(uint64_t regionIndex, unsigned int faceIndex) const = 0;

        DLL_IMPORT_OR_EXPORT virtual bool getSideFlagOfInternalShellFace(uint64_t regionIndex, unsigned int internalShellIndex, unsigned int faceIndex) const = 0;

        DLL_IMPORT_OR_EXPORT static const char* XML_TAG;
 
        DLL_IMPORT_OR_EXPORT virtual std::string getXmlTag() const final { return XML_TAG; }
 
    protected:

        DLL_IMPORT_OR_EXPORT SealedVolumeFrameworkRepresentation(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : RepresentationSetRepresentation(partialObject) {}

        SealedVolumeFrameworkRepresentation() {}

        SealedVolumeFrameworkRepresentation(gsoap_resqml2_0_1::_resqml20__SealedVolumeFrameworkRepresentation* fromGsoap) : RepresentationSetRepresentation(fromGsoap) {}

        SealedVolumeFrameworkRepresentation(gsoap_eml2_3::_resqml22__SealedVolumeFrameworkRepresentation* fromGsoap) : RepresentationSetRepresentation(fromGsoap) {}
 
        virtual COMMON_NS::DataObjectReference getSealedStructuralFrameworkDor() const = 0;
 
        virtual COMMON_NS::DataObjectReference getStratiUnitInterpDor(uint64_t regionIndex) const = 0;

        void loadTargetRelationships() final;

        virtual void setXmlSealedSurfaceFramework(class SealedSurfaceFrameworkRepresentation* ssf) = 0;

        virtual void setXmlInterpretationOfVolumeRegion(uint64_t regionIndex, class StratigraphicUnitInterpretation * stratiUnitInterp) = 0;
    };
}