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 "AbstractRepresentation.h"
#include "AbstractValuesProperty.h"
 
namespace RESQML2_NS
{
    class WellboreFrameRepresentation : public AbstractRepresentation
    {
    public:
        ~WellboreFrameRepresentation() = default;

        DLL_IMPORT_OR_EXPORT void setMdValues(double const * mdValues, uint64_t mdValueCount, EML2_NS::AbstractHdfProxy* proxy = nullptr);

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

        DLL_IMPORT_OR_EXPORT bool areMdValuesRegularlySpaced() const;

        DLL_IMPORT_OR_EXPORT double getMdConstantIncrementValue() const;

        DLL_IMPORT_OR_EXPORT double getMdFirstValue() const;

        DLL_IMPORT_OR_EXPORT unsigned int getMdValuesCount() const;

        DLL_IMPORT_OR_EXPORT uint64_t getXyzPointCountOfPatch(uint64_t patchIndex) const override;

        DLL_IMPORT_OR_EXPORT void getXyzPointsOfPatch(uint64_t patchIndex, double * xyzPoints) const override;

        DLL_IMPORT_OR_EXPORT COMMON_NS::AbstractObject::numericalDatatypeEnum getMdHdfDatatype() const;

        DLL_IMPORT_OR_EXPORT void getMdAsDoubleValues(double * values) const;

        DLL_IMPORT_OR_EXPORT void getMdAsFloatValues(float * values) const;

        COMMON_NS::DataObjectReference getWellboreTrajectoryDor() const;

        DLL_IMPORT_OR_EXPORT class WellboreTrajectoryRepresentation* getWellboreTrajectory() const;
 
        COMMON_NS::DataObjectReference getLocalCrsDor(uint64_t patchIndex) const override;

        COMMON_NS::DataObjectReference getHdfProxyDor() const final;
 
        DLL_IMPORT_OR_EXPORT uint64_t getPatchCount() const final {return 1;}
 
    protected:
        WellboreFrameRepresentation() {}

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

        WellboreFrameRepresentation(gsoap_resqml2_0_1::_resqml20__WellboreFrameRepresentation* fromGsoap) :
            AbstractRepresentation(fromGsoap) {}

        WellboreFrameRepresentation(gsoap_eml2_3::resqml22__WellboreFrameRepresentation* fromGsoap) :
            AbstractRepresentation(fromGsoap) {}

        virtual void loadTargetRelationships() override;
    };
}