Fesapi  2.0.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
WellboreFrameRepresentation.h
1 /*-----------------------------------------------------------------------
2 Licensed to the Apache Software Foundation (ASF) under one
3 or more contributor license agreements. See the NOTICE file
4 distributed with this work for additional information
5 regarding copyright ownership. The ASF licenses this file
6 to you under the Apache License, Version 2.0 (the
7 "License"; you may not use this file except in compliance
8 with the License. You may obtain a copy of the License at
9 
10  http://www.apache.org/licenses/LICENSE-2.0
11 
12 Unless required by applicable law or agreed to in writing,
13 software distributed under the License is distributed on an
14 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 KIND, either express or implied. See the License for the
16 specific language governing permissions and limitations
17 under the License.
18 -----------------------------------------------------------------------*/
19 #pragma once
20 
21 #include "AbstractRepresentation.h"
22 #include "AbstractValuesProperty.h"
23 
24 namespace RESQML2_NS
25 {
35  {
36  public:
39 
55  DLL_IMPORT_OR_EXPORT void setMdValues(double const * mdValues, unsigned int mdValueCount, EML2_NS::AbstractHdfProxy* proxy = nullptr);
56 
67  DLL_IMPORT_OR_EXPORT void setMdValues(double firstMdValue, double incrementMdValue, unsigned int mdValueCount);
68 
77  DLL_IMPORT_OR_EXPORT bool areMdValuesRegularlySpaced() const;
78 
88  DLL_IMPORT_OR_EXPORT double getMdConstantIncrementValue() const;
89 
101  DLL_IMPORT_OR_EXPORT double getMdFirstValue() const;
102 
110  DLL_IMPORT_OR_EXPORT unsigned int getMdValuesCount() const;
111 
115  DLL_IMPORT_OR_EXPORT uint64_t getXyzPointCountOfPatch(unsigned int patchIndex) const override;
116 
120  DLL_IMPORT_OR_EXPORT void getXyzPointsOfPatch(unsigned int patchIndex, double * xyzPoints) const override;
121 
133  DLL_IMPORT_OR_EXPORT COMMON_NS::AbstractObject::hdfDatatypeEnum getMdHdfDatatype() const;
134 
148  DLL_IMPORT_OR_EXPORT void getMdAsDoubleValues(double * values) const;
149 
163  DLL_IMPORT_OR_EXPORT void getMdAsFloatValues(float * values) const;
164 
172  COMMON_NS::DataObjectReference getWellboreTrajectoryDor() const;
173 
181  DLL_IMPORT_OR_EXPORT class WellboreTrajectoryRepresentation* getWellboreTrajectory() const;
182 
183  COMMON_NS::DataObjectReference getLocalCrsDor(unsigned int patchIndex) const override;
184 
192  COMMON_NS::DataObjectReference getHdfProxyDor() const final;
193 
194  DLL_IMPORT_OR_EXPORT unsigned int getPatchCount() const final {return 1;}
195 
196  protected:
199 
205  WellboreFrameRepresentation(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) :
206  RESQML2_NS::AbstractRepresentation(partialObject) {}
207 
213  WellboreFrameRepresentation(gsoap_resqml2_0_1::_resqml20__WellboreFrameRepresentation* fromGsoap) :
214  AbstractRepresentation(fromGsoap) {}
215 
221  WellboreFrameRepresentation(gsoap_eml2_3::resqml22__WellboreFrameRepresentation* fromGsoap) :
222  AbstractRepresentation(fromGsoap) {}
223 
225  virtual void loadTargetRelationships() override;
226  };
227 }
Proxy class for an abstract representation.
Definition: AbstractRepresentation.h:32
Proxy class for a wellbore frame representation. A wellbore frame representation is a representation ...
Definition: WellboreFrameRepresentation.h:35
void getXyzPointsOfPatch(unsigned int patchIndex, double *xyzPoints) const override
void setMdValues(double const *mdValues, unsigned int mdValueCount, eml2::AbstractHdfProxy *proxy=nullptr)
unsigned int getMdValuesCount() const
uint64_t getXyzPointCountOfPatch(unsigned int patchIndex) const override
class WellboreTrajectoryRepresentation * getWellboreTrajectory() const
void getMdAsFloatValues(float *values) const
common::AbstractObject::hdfDatatypeEnum getMdHdfDatatype() const
common::DataObjectReference getHdfProxyDor() const final
Gets the data object reference of the HDF proxy which is used for storing the numerical values of thi...
void setMdValues(double firstMdValue, double incrementMdValue, unsigned int mdValueCount)
common::DataObjectReference getWellboreTrajectoryDor() const
void getMdAsDoubleValues(double *values) const
common::DataObjectReference getLocalCrsDor(unsigned int patchIndex) const override
Representation of a wellbore trajectory.
Definition: WellboreTrajectoryRepresentation.h:29