StratigraphicColumnRankInterpretation.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_0_1/AbstractStratigraphicOrganizationInterpretation.h"
#include "resqml2_0_1/StratigraphicColumn.h"
#include "resqml2_0_1/StratigraphicOccurrenceInterpretation.h"

namespace RESQML2_0_1_NS
{
    class DLL_IMPORT_OR_EXPORT StratigraphicColumnRankInterpretation : public AbstractStratigraphicOrganizationInterpretation
    {
    public:

        StratigraphicColumnRankInterpretation(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : AbstractStratigraphicOrganizationInterpretation(partialObject) {}

        StratigraphicColumnRankInterpretation(class OrganizationFeature * orgFeat, const std::string & guid, const std::string & title, const unsigned long & rank, const gsoap_resqml2_0_1::resqml2__OrderingCriteria & orderingCriteria);

        StratigraphicColumnRankInterpretation(gsoap_resqml2_0_1::_resqml2__StratigraphicColumnRankInterpretation* fromGsoap) : AbstractStratigraphicOrganizationInterpretation(fromGsoap) {}

        ~StratigraphicColumnRankInterpretation() {}

        void pushBackStratiUnitInterpretation(class StratigraphicUnitInterpretation * stratiUnitInterpretation);
        
        void setHorizonOfLastContact(class HorizonInterpretation * partOf);

        void pushBackStratigraphicBinaryContact(StratigraphicUnitInterpretation* subject, const gsoap_resqml2_0_1::resqml2__ContactMode & subjectContactMode,
            StratigraphicUnitInterpretation* directObject, const gsoap_resqml2_0_1::resqml2__ContactMode & directObjectMode,
            class HorizonInterpretation * partOf = nullptr);

        bool isAChronoStratiRank() const;

        unsigned int getContactCount() const;

        gsoap_resqml2_0_1::resqml2__ContactMode getSubjectContactModeOfContact(const unsigned int & contactIndex) const;

        class StratigraphicUnitInterpretation* getSubjectOfContact(const unsigned int & contactIndex) const;

        gsoap_resqml2_0_1::resqml2__ContactMode getDirectObjectContactModeOfContact(const unsigned int & contactIndex) const;

        class StratigraphicUnitInterpretation* getDirectObjectOfContact(const unsigned int & contactIndex) const;

        class HorizonInterpretation* getHorizonInterpretationOfContact(const unsigned int & contactIndex) const;

        const std::vector<class StratigraphicUnitInterpretation*> & getStratigraphicUnitInterpretationSet() const;

        const std::vector<class StratigraphicOccurrenceInterpretation*> & getStratigraphicOccurrenceInterpretationSet() const;

        const std::vector<class HorizonInterpretation*> & getHorizonInterpretationSet() const;

        const std::vector<StratigraphicColumn*> & getStratigraphicColumnSet() const;

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

    private:

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

        // forward relationships
        std::vector<class StratigraphicUnitInterpretation*> stratigraphicUnitSet;
        std::vector<class HorizonInterpretation*> horizonInterpretationSet;

        // Backward relationship
        std::vector<StratigraphicColumn *> stratigraphicColumnSet;
        std::vector<StratigraphicOccurrenceInterpretation *> stratigraphicOccurrenceInterpretationSet;

        friend void StratigraphicColumn::pushBackStratiColumnRank(StratigraphicColumnRankInterpretation * stratiColumnRank);
        friend void StratigraphicOccurrenceInterpretation::setStratigraphicColumnRankInterpretation(StratigraphicColumnRankInterpretation * stratiColumnRankInterp);
    };
}