WellboreFrameRepresentation.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/AbstractRepresentation.h"
#include "resqml2/AbstractValuesProperty.h"

namespace WITSML1_4_1_1_NS
{
    class Log;
}

namespace RESQML2_0_1_NS
{
    class DLL_IMPORT_OR_EXPORT WellboreFrameRepresentation : public RESQML2_NS::AbstractRepresentation
    {
    protected:
        gsoap_resqml2_0_1::resqml2__PointGeometry* getPointGeometry2_0_1(const unsigned int & patchIndex) const {return nullptr;}

        WellboreFrameRepresentation(RESQML2_NS::AbstractFeatureInterpretation* interp, RESQML2_NS::AbstractLocal3dCrs * crs) : AbstractRepresentation(interp, crs), trajectory(nullptr), witsmlLog(nullptr) {}

    public:

        WellboreFrameRepresentation(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) :
            RESQML2_NS::AbstractRepresentation(partialObject)
        {
        }

        WellboreFrameRepresentation(class WellboreInterpretation* interp, const std::string & guid, const std::string & title, class WellboreTrajectoryRepresentation * traj);

        WellboreFrameRepresentation(gsoap_resqml2_0_1::_resqml2__WellboreFrameRepresentation* fromGsoap): AbstractRepresentation(fromGsoap), trajectory(nullptr), witsmlLog(nullptr)  {}

        ~WellboreFrameRepresentation() {}

        void setMdValues(double * mdValues, const unsigned int & mdValueCount, COMMON_NS::AbstractHdfProxy* proxy);

        void setMdValues(const double & firstMdValue, const double & incrementMdValue, const unsigned int & mdValueCount);

        bool areMdValuesRegularlySpaced() const;
        
        double getMdConstantIncrementValue() const;

        double getMdFirstValue() const;
        
        unsigned int getMdValuesCount() const;

        ULONG64 getXyzPointCountOfPatch(const unsigned int & patchIndex) const {return getMdValuesCount();}

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

        RESQML2_NS::AbstractValuesProperty::hdfDatatypeEnum getMdHdfDatatype() const;

        void getMdAsDoubleValues(double * values);

        void getMdAsFloatValues(float * values);

        std::string getWellboreTrajectoryUuid() const;

        class WellboreTrajectoryRepresentation* getWellboreTrajectory() {return trajectory;}

        gsoap_resqml2_0_1::eml20__DataObjectReference* getLocalCrsDor() const;

        std::string getHdfProxyUuid() const;

        unsigned int getPatchCount() const {return 1;}

        void setWitsmlLog(WITSML1_4_1_1_NS::Log * witsmlLogToSet);
        WITSML1_4_1_1_NS::Log* getWitsmlLog() {return witsmlLog;}

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

    protected:

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

        class WellboreTrajectoryRepresentation * trajectory;
        WITSML1_4_1_1_NS::Log * witsmlLog;
    };
}