Fesapi 2.9.0.1
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
resqml2_0_1::IjkGridExplicitRepresentation Class Referencefinal

#include <IjkGridExplicitRepresentation.h>

Inheritance diagram for resqml2_0_1::IjkGridExplicitRepresentation:

Public Member Functions

 IjkGridExplicitRepresentation (common ::DataObjectRepository *repo, const std::string &guid, const std::string &title, unsigned int iCount, unsigned int jCount, unsigned int kCount, bool *kGaps=nullptr, eml2 ::AbstractHdfProxy *proxy=nullptr)
 
 IjkGridExplicitRepresentation (resqml2 ::AbstractFeatureInterpretation *interp, const std::string &guid, const std::string &title, unsigned int iCount, unsigned int jCount, unsigned int kCount, bool *kGaps=nullptr, eml2 ::AbstractHdfProxy *proxy=nullptr)
 
 IjkGridExplicitRepresentation (gsoap_resqml2_0_1::_resqml20__IjkGridRepresentation *fromGsoap)
 Creates an instance of this class by wrapping a gSOAP instance.
 
 IjkGridExplicitRepresentation (gsoap_resqml2_0_1::_resqml20__TruncatedIjkGridRepresentation *fromGsoap)
 Creates an instance of this class by wrapping a gSOAP instance.
 
virtual ~IjkGridExplicitRepresentation ()=default
 
common::DataObjectReference getHdfProxyDor () const final
 
void getXyzPointsOfPatch (unsigned int patchIndex, double *xyzPoints) const final
 Gets all the xyz points of a particular patch of this representation. xyz points are given in the local CRS.
 
void setGeometryAsCoordinateLineNodes (gsoap_resqml2_0_1::resqml20__PillarShape mostComplexPillarGeometry, gsoap_resqml2_0_1::resqml20__KDirection kDirectionKind, bool isRightHanded, double const *points, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t splitCoordinateLineCount=0, unsigned int const *pillarOfCoordinateLine=nullptr, unsigned int const *splitCoordinateLineColumnCumulativeCount=nullptr, unsigned int const *splitCoordinateLineColumns=nullptr, int8_t const *definedPillars=nullptr, resqml2 ::AbstractLocal3dCrs *localCrs=nullptr) final
 
void setGeometryAsCoordinateLineNodesUsingExistingDatasets (gsoap_resqml2_0_1::resqml20__PillarShape mostComplexPillarGeometry, gsoap_resqml2_0_1::resqml20__KDirection kDirectionKind, bool isRightHanded, const std::string &points, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t splitCoordinateLineCount=0, const std::string &pillarOfCoordinateLine="", const std::string &splitCoordinateLineColumnCumulativeCount="", const std::string &splitCoordinateLineColumns="", const std::string &definedPillars="", resqml2 ::AbstractLocal3dCrs *localCrs=nullptr) final
 
std::string getXmlNamespace () const final
 

Static Public Attributes

static constexpr char const * XML_NS = "resqml20"
 

Detailed Description

An IJK Grid explicit representation defines each cell corner position by means of XYZ coordinates. Adjacent cell corner are supposed to be located the same so they are not repeated unless you define split lines or split nodes.

Constructor & Destructor Documentation

◆ IjkGridExplicitRepresentation() [1/4]

resqml2_0_1::IjkGridExplicitRepresentation::IjkGridExplicitRepresentation ( common ::DataObjectRepository * repo,
const std::string & guid,
const std::string & title,
unsigned int iCount,
unsigned int jCount,
unsigned int kCount,
bool * kGaps = nullptr,
eml2 ::AbstractHdfProxy * proxy = nullptr )
inline

Constructor

Parameters
[in]repoThe repo where the underlying gsoap proxy is going to be created.
guidUnique identifier.
titleThe title.
iCountNumber of cell in I direction.
jCountNumber of cell in J direction.
kCountNumber of cell in K direction.
kGaps(Optional) Boolean array of length KCellCount-1. TRUE if there is a gap after the corresponding layer. Won't be freed by FESAPI.
[in]proxy(Optional) The HDF proxy for writing the enabledCells values. If nullptr (default), then the default HDF proxy will be used.

◆ IjkGridExplicitRepresentation() [2/4]

resqml2_0_1::IjkGridExplicitRepresentation::IjkGridExplicitRepresentation ( resqml2 ::AbstractFeatureInterpretation * interp,
const std::string & guid,
const std::string & title,
unsigned int iCount,
unsigned int jCount,
unsigned int kCount,
bool * kGaps = nullptr,
eml2 ::AbstractHdfProxy * proxy = nullptr )
inline

Constructor

Parameters
[in]interpIf non-null, the interp.
guidUnique identifier.
titleThe title.
iCountNumber of cell in I direction.
jCountNumber of cell in J direction.
kCountNumber of cell in K direction.
kGaps(Optional) Boolean array of length KCellCount-1. TRUE if there is a gap after the corresponding layer. Won't be freed by FESAPI.
[in]proxy(Optional) The HDF proxy for writing the enabledCells values. If nullptr (default), then the default HDF proxy will be used.

◆ IjkGridExplicitRepresentation() [3/4]

resqml2_0_1::IjkGridExplicitRepresentation::IjkGridExplicitRepresentation ( gsoap_resqml2_0_1::_resqml20__IjkGridRepresentation * fromGsoap)
inline

Creates an instance of this class by wrapping a gSOAP instance.

Parameters
[in]fromGsoapIf non-null, the gSOAP instance.

◆ IjkGridExplicitRepresentation() [4/4]

resqml2_0_1::IjkGridExplicitRepresentation::IjkGridExplicitRepresentation ( gsoap_resqml2_0_1::_resqml20__TruncatedIjkGridRepresentation * fromGsoap)
inline

Creates an instance of this class by wrapping a gSOAP instance.

Parameters
[in]fromGsoapIf non-null, the gSOAP instance.

◆ ~IjkGridExplicitRepresentation()

virtual resqml2_0_1::IjkGridExplicitRepresentation::~IjkGridExplicitRepresentation ( )
virtualdefault

Destructor does nothing since the memory is managed by the gsoap context.

Member Function Documentation

◆ getXmlNamespace()

std::string resqml2_0_1::IjkGridExplicitRepresentation::getXmlNamespace ( ) const
inlinefinal

Get the standard XML namespace for serializing this data object.

◆ getXyzPointsOfPatch()

void resqml2_0_1::IjkGridExplicitRepresentation::getXyzPointsOfPatch ( unsigned int patchIndex,
double * xyzPoints ) const
final

Gets all the xyz points of a particular patch of this representation. xyz points are given in the local CRS.

Exceptions
std::logic_errorIf the geometry of the grid either does not exist or is not an explicit one.
std::logic_errorIf this grid is truncated and the additional grid points cannot be read.
std::out_of_rangeIf patchIndex >= getPatchCount().
Parameters
patchIndexThe index of the patch.
xyzPointsxyz double triplets ordered by i then j then split then k. It must be preallocated with a count of ((iCellCount+1) * (jCellCount+1) + splitCoordinateLineCount) * kCellCount.

Member Data Documentation

◆ XML_NS

constexpr char const* resqml2_0_1::IjkGridExplicitRepresentation::XML_NS = "resqml20"
staticconstexpr

The standard XML namespace for serializing this data object.


The documentation for this class was generated from the following file: