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_2::IjkGridParametricRepresentation Class Referencefinal

#include <IjkGridParametricRepresentation.h>

Inheritance diagram for resqml2_2::IjkGridParametricRepresentation:

Public Member Functions

 IjkGridParametricRepresentation (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)
 Constructor.
 
 IjkGridParametricRepresentation (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)
 Constructor.
 
 IjkGridParametricRepresentation (gsoap_eml2_3::_resqml22__IjkGridRepresentation *fromGsoap)
 Creates an instance of this class by wrapping a gsoap instance.
 
 IjkGridParametricRepresentation (gsoap_eml2_3::_resqml22__TruncatedIjkGridRepresentation *fromGsoap)
 Constructor.
 
 ~IjkGridParametricRepresentation ()=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.
 
unsigned int getControlPointMaxCountPerPillar () const final
 
bool hasControlPointParameters () const final
 
bool isParametricLineKindConstant () const final
 
short getConstantParametricLineKind () const final
 
void setGeometryAsParametricSplittedPillarNodes (gsoap_resqml2_0_1::resqml20__PillarShape mostComplexPillarGeometry, bool isRightHanded, double const *parameters, double const *controlPoints, double const *controlPointParameters, unsigned int controlPointMaxCountPerPillar, short const *pillarKind, eml2 ::AbstractHdfProxy *proxy, uint64_t splitCoordinateLineCount, unsigned int const *pillarOfCoordinateLine, unsigned int const *splitCoordinateLineColumnCumulativeCount, unsigned int const *splitCoordinateLineColumns, resqml2 ::AbstractLocal3dCrs *localCrs=nullptr) final
 
void setGeometryAsParametricSplittedPillarNodesUsingExistingDatasets (gsoap_resqml2_0_1::resqml20__PillarShape mostComplexPillarGeometry, gsoap_resqml2_0_1::resqml20__KDirection kDirectionKind, bool isRightHanded, const std::string &parameters, const std::string &controlPoints, const std::string &controlPointParameters, unsigned int controlPointMaxCountPerPillar, const std::string &pillarKind, const std::string &definedPillars, eml2 ::AbstractHdfProxy *proxy, uint64_t splitCoordinateLineCount, const std::string &pillarOfCoordinateLine, const std::string &splitCoordinateLineColumnCumulativeCount, const std::string &splitCoordinateLineColumns, resqml2 ::AbstractLocal3dCrs *localCrs=nullptr) final
 
void setGeometryAsParametricSplittedPillarNodesUsingExistingDatasets (gsoap_resqml2_0_1::resqml20__KDirection kDirectionKind, bool isRightHanded, const std::string &parameters, const std::string &controlPoints, const std::string &controlPointParameters, unsigned int controlPointCountPerPillar, short pillarKind, eml2 ::AbstractHdfProxy *proxy, uint64_t splitCoordinateLineCount, const std::string &pillarOfCoordinateLine, const std::string &splitCoordinateLineColumnCumulativeCount, const std::string &splitCoordinateLineColumns, resqml2 ::AbstractLocal3dCrs *localCrs=nullptr) final
 
std::string getXmlNamespace () const final
 

Static Public Attributes

static const char * XML_NS
 

Detailed Description

An IJK Grid parametric representation define the cell corner positions by means of parameters along the pillars of the grid. 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

◆ IjkGridParametricRepresentation() [1/4]

resqml2_2::IjkGridParametricRepresentation::IjkGridParametricRepresentation ( 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]repoIf non-nullptr, the repo.
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.

◆ IjkGridParametricRepresentation() [2/4]

resqml2_2::IjkGridParametricRepresentation::IjkGridParametricRepresentation ( 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-nullptr, 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.

◆ IjkGridParametricRepresentation() [3/4]

resqml2_2::IjkGridParametricRepresentation::IjkGridParametricRepresentation ( gsoap_eml2_3::_resqml22__IjkGridRepresentation * fromGsoap)
inline

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

Parameters
[in]fromGsoapIf non-nullptr, from gsoap.

◆ IjkGridParametricRepresentation() [4/4]

resqml2_2::IjkGridParametricRepresentation::IjkGridParametricRepresentation ( gsoap_eml2_3::_resqml22__TruncatedIjkGridRepresentation * fromGsoap)
inline

Constructor.

Parameters
[in]fromGsoapIf non-nullptr, from gsoap.

◆ ~IjkGridParametricRepresentation()

resqml2_2::IjkGridParametricRepresentation::~IjkGridParametricRepresentation ( )
default

Destructor clean pillarInformation memory when allocated

Member Function Documentation

◆ getXmlNamespace()

std::string resqml2_2::IjkGridParametricRepresentation::getXmlNamespace ( ) const
inlinefinal

Get the standard XML namespace for serializing this data object.

◆ getXyzPointsOfPatch()

void resqml2_2::IjkGridParametricRepresentation::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 if it is not handled yet by fesapi.
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

const char* resqml2_2::IjkGridParametricRepresentation::XML_NS
static

The standard XML namespace for serializing this data object.


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