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

namespace RESQML2_0_1_NS
{
    class StructuralOrganizationInterpretation;
}

namespace RESQML2_NS
{
    class DLL_IMPORT_OR_EXPORT AbstractFeatureInterpretation : public COMMON_NS::AbstractObject
    {
    protected:

        AbstractFeatureInterpretation(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : COMMON_NS::AbstractObject(partialObject) {}

        AbstractFeatureInterpretation() {}

        AbstractFeatureInterpretation(gsoap_resqml2_0_1::resqml2__AbstractFeatureInterpretation* fromGsoap) : COMMON_NS::AbstractObject(fromGsoap) {}

        void setInterpretedFeatureInXml(RESQML2_NS::AbstractFeature* feature);

    public:

        virtual ~AbstractFeatureInterpretation() {}

        gsoap_resqml2_0_1::eml20__DataObjectReference* getInterpretedFeatureDor() const;

        std::string getInterpretedFeatureUuid() const;

        void setInterpretedFeature(AbstractFeature* feature);

        AbstractFeature* getInterpretedFeature() const;

        const gsoap_resqml2_0_1::resqml2__Domain & initDomain(const gsoap_resqml2_0_1::resqml2__Domain & defaultDomain) const;

        gsoap_resqml2_0_1::resqml2__Domain getDomain() const;

        std::vector<AbstractRepresentation*> getRepresentationSet() const;

        unsigned int                        getRepresentationCount() const;

        AbstractRepresentation*             getRepresentation(const unsigned int & index) const;

        std::vector<GridConnectionSetRepresentation *>  getGridConnectionSetRepresentationSet();

        void setBottomFrontierOf(RESQML2_0_1_NS::StructuralOrganizationInterpretation* structOrg);
        void setTopFrontierOf(RESQML2_0_1_NS::StructuralOrganizationInterpretation* structOrg);
        void setSideFrontierOf(RESQML2_0_1_NS::StructuralOrganizationInterpretation* structOrg);

    protected:

        virtual std::vector<epc::Relationship> getAllEpcRelationships() const;
        
        virtual void importRelationshipSetFromEpc(COMMON_NS::EpcDocument* epcDoc);

        // XML backward relationship
        std::vector<AbstractRepresentation *>                       representationSet;
        std::vector<GridConnectionSetRepresentation *>              gridConnectionSetRepresentationSet;

        std::vector<RESQML2_0_1_NS::StructuralOrganizationInterpretation *> isBottomFrontierSet;
        std::vector<RESQML2_0_1_NS::StructuralOrganizationInterpretation *> isTopFrontierSet;
        std::vector<RESQML2_0_1_NS::StructuralOrganizationInterpretation *> isSideFrontierSet;

        friend void AbstractRepresentation::setInterpretation(AbstractFeatureInterpretation * interp);
        friend void GridConnectionSetRepresentation::pushBackInterpretation(AbstractFeatureInterpretation* interp);
    };
}