Fesapi  2.0.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
PointsProperty.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 "AbstractProperty.h"
22 
23 namespace RESQML2_NS
24 {
27  {
28  public:
29 
33  virtual ~PointsProperty() = default;
34 
45  DLL_IMPORT_OR_EXPORT uint64_t getXyzPointCountOfPatch(unsigned int patchIndex) const {
46  return getValuesCountOfPatch(patchIndex) / 3;
47  }
48 
54  DLL_IMPORT_OR_EXPORT uint64_t getXyzPointCountOfAllPatches() const;
55 
69  DLL_IMPORT_OR_EXPORT void getXyzPointsOfPatch(unsigned int patchIndex, double * xyzPoints) const;
70 
83  DLL_IMPORT_OR_EXPORT void getXyzPointsOfPatchInGlobalCrs(unsigned int patchIndex, double * xyzPoints) const;
84 
94  DLL_IMPORT_OR_EXPORT void getXyzPointsOfAllPatches(double * xyzPoints) const;
95 
105  DLL_IMPORT_OR_EXPORT void getXyzPointsOfAllPatchesInGlobalCrs(double * xyzPoints) const;
106 
121  DLL_IMPORT_OR_EXPORT void pushBackArray1dOfXyzPoints(const double * xyzPoints, uint64_t pointCount, EML2_NS::AbstractHdfProxy* proxy = nullptr);
122 
141  DLL_IMPORT_OR_EXPORT void pushBackArray2dOfXyzPoints(const double * xyzPoints, uint64_t pointCountInFastestDim, uint64_t pointCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy = nullptr);
142 
163  DLL_IMPORT_OR_EXPORT void pushBackArray3dOfXyzPoints(const double * xyzPoints, uint64_t pointCountInFastestDim, uint64_t pointCountInMiddleDim, uint64_t pointCountInSlowestDim, EML2_NS::AbstractHdfProxy* proxy = nullptr);
164 
182  DLL_IMPORT_OR_EXPORT void pushBackArrayOfXyzPoints(double const * xyzPoints, unsigned long long const * pointCountByDimension, unsigned int numArrayDimensions, EML2_NS::AbstractHdfProxy* proxy = nullptr);
183 
202  DLL_IMPORT_OR_EXPORT virtual std::string pushBackRefToExistingDataset(EML2_NS::AbstractHdfProxy* proxy, const std::string & datasetName = "") = 0;
203 
212  bool validatePropertyKindAssociation(EML2_NS::PropertyKind*) final {
213  return true;
214  }
215 
224  bool validatePropertyKindAssociation(gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind) final {
225  return true;
226  }
227 
229  DLL_IMPORT_OR_EXPORT static const char* XML_TAG;
230 
231  DLL_IMPORT_OR_EXPORT std::string getXmlTag() const final { return XML_TAG; }
232 
233  protected:
234 
240  DLL_IMPORT_OR_EXPORT PointsProperty(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : AbstractProperty(partialObject) {}
241 
246  PointsProperty() {}
247 
253  PointsProperty(gsoap_resqml2_0_1::_resqml20__PointsProperty* fromGsoap) : RESQML2_NS::AbstractProperty(fromGsoap) {}
254  PointsProperty(gsoap_eml2_3::resqml22__PointsProperty* fromGsoap) : RESQML2_NS::AbstractProperty(fromGsoap) {}
255 
256  virtual EML2_NS::AbstractHdfProxy* getValuesHdfProxyAndDatasetPathOfPatch(unsigned int patchIndex, std::string & datasetPath) const = 0;
257  };
258 }
Proxy class for an abstract property.
Definition: AbstractProperty.h:36
Proxy class for an points property.
Definition: PointsProperty.h:27
void getXyzPointsOfAllPatches(double *xyzPoints) const
Gets all the xyz points of all patches of this property. xyz points are given in the local CRS.
void pushBackArray2dOfXyzPoints(const double *xyzPoints, uint64_t pointCountInFastestDim, uint64_t pointCountInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr)
Adds a 2d array of points (in local CRS) to the property.
void pushBackArrayOfXyzPoints(double const *xyzPoints, unsigned long long const *pointCountByDimension, unsigned int numArrayDimensions, eml2::AbstractHdfProxy *proxy=nullptr)
Adds an nd array of points (in local CRS) to the property.
std::string getXmlTag() const final
Definition: PointsProperty.h:231
void pushBackArray1dOfXyzPoints(const double *xyzPoints, uint64_t pointCount, eml2::AbstractHdfProxy *proxy=nullptr)
Adds a 1d array of points (in local CRS) to the property.
void pushBackArray3dOfXyzPoints(const double *xyzPoints, uint64_t pointCountInFastestDim, uint64_t pointCountInMiddleDim, uint64_t pointCountInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr)
Adds a 3d array of points (in local CRS) to the property.
void getXyzPointsOfAllPatchesInGlobalCrs(double *xyzPoints) const
uint64_t getXyzPointCountOfAllPatches() const
bool validatePropertyKindAssociation(eml2::PropertyKind *) final
Definition: PointsProperty.h:212
bool validatePropertyKindAssociation(gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind) final
Definition: PointsProperty.h:224
virtual ~PointsProperty()=default
virtual std::string pushBackRefToExistingDataset(eml2::AbstractHdfProxy *proxy, const std::string &datasetName="")=0
void getXyzPointsOfPatchInGlobalCrs(unsigned int patchIndex, double *xyzPoints) const
Gets all the xyz points of a particular patch of this property. xyz points are given in the global CR...
static const char * XML_TAG
Definition: PointsProperty.h:229
void getXyzPointsOfPatch(unsigned int patchIndex, double *xyzPoints) const
Gets all the xyz points of a particular patch of this property. xyz points are given in the local CRS...
uint64_t getXyzPointCountOfPatch(unsigned int patchIndex) const
Definition: PointsProperty.h:45