DeviationSurveyRepresentation.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_0_1/WellboreTrajectoryRepresentation.h"

namespace resqml2
{
    class MdDatum;
}

namespace resqml2_0_1
{
    class WellboreTrajectoryRepresentation;

    class DLL_IMPORT_OR_EXPORT DeviationSurveyRepresentation : public resqml2::AbstractRepresentation
    {
    public:

        DeviationSurveyRepresentation(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) :AbstractRepresentation(partialObject) {}


        DeviationSurveyRepresentation(class WellboreInterpretation* interp, const std::string & guid, const std::string & title, const bool & isFinal, resqml2::MdDatum * mdInfo);

        DeviationSurveyRepresentation(gsoap_resqml2_0_1::_resqml2__DeviationSurveyRepresentation* fromGsoap) : AbstractRepresentation(fromGsoap) {}

        ~DeviationSurveyRepresentation() {}

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

        /*
        *  Set the geometry of the representation by means of a parametric line without MD information.
        * @param firstStationLocation           XYZ location of the first station of the deviation survey in the local CRS. It must be three doubles. It is not created and not deleted by this method.
        * @param stationCount                   Number of stations (including the first station location).
        * @param mdUom                          Units of measure of the measured depths along this deviation survey.
        * @param mds                            MD values for the position of the stations. Array length equals station count.
        * @param angleUom                       Defines the units of measure for the azimuth and inclination
        * @param azimuths                       An array of azimuth angles, one for each survey station. The rotation is relative to the projected CRS north with a positive value indicating a clockwise rotation as seen from above. Array length equals station count.
        * @param inclinations                   Dip (or inclination) angle for each station. Array length equals station count.
        * @param proxy                          The HDF proxy which indicates in which HDF5 file the numerical values will be stored.
        *                                       It must be already opened for writing and won't be closed.
        */
        void setGeometry(double * firstStationLocation, const ULONG64 & stationCount,
            const gsoap_resqml2_0_1::eml20__LengthUom & mdUom, double * mds,
            const gsoap_resqml2_0_1::eml20__PlaneAngleUom & angleUom, double * azimuths, double * inclinations,
            common::AbstractHdfProxy* proxy);

        void setMdDatum(resqml2::MdDatum* mdDatum);

        gsoap_resqml2_0_1::eml20__DataObjectReference* getMdDatumDor() const;

        resqml2::MdDatum * getMdDatum() const;

        std::string getMdDatumUuid() const;

        bool isFinal() const;

        ULONG64 getXyzPointCountOfPatch(const unsigned int & patchIndex) const;

        void getXyzPointsOfPatch(const unsigned int & patchIndex, double * xyzPoints) const;

        gsoap_resqml2_0_1::eml20__LengthUom getMdUom() const;

        gsoap_resqml2_0_1::eml20__PlaneAngleUom getAngleUom() const;

        void getMdValues(double* values);

        void getInclinations(double* values);

        void getAzimuths(double* values);

        std::vector<class WellboreFrameRepresentation*> getWellboreFrameRepresentationSet() const;

        unsigned int getWellboreFrameRepresentationCount() const;

        class WellboreFrameRepresentation* getWellboreFrameRepresentation(unsigned int index) const;

        const std::vector<class WellboreTrajectoryRepresentation*>& getWellboreTrajectoryRepresentationSet() const;

        unsigned int getWellboreTrajectoryRepresentationCount() const;

        class WellboreTrajectoryRepresentation* getWellboreTrajectoryRepresentation(const unsigned int & index) const;

        std::string getHdfProxyUuid() const;

        unsigned int getPatchCount() const {return 1;}

    protected:

        friend void WellboreTrajectoryRepresentation::setDeviationSurvey(DeviationSurveyRepresentation* deviationSurvey);

        void addTrajectory(class WellboreTrajectoryRepresentation* trajectory);

        std::vector<epc::Relationship> getAllEpcRelationships() const;
        void importRelationshipSetFromEpc(common::EpcDocument* epcDoc);
        
        // XML backward relationships
        std::vector<class WellboreTrajectoryRepresentation*> wbTrajectoryRepSet;
    };
}