resqml2::AbstractColumnLayerGridRepresentation Class Reference

Proxy class for an abstract column layer grid representation. More...

#include <AbstractColumnLayerGridRepresentation.h>

Inheritance diagram for resqml2::AbstractColumnLayerGridRepresentation:

Public Member Functions
virtual	~AbstractColumnLayerGridRepresentation ()=default
uint64_t	getKCellCount () const
void	setKCellCount (uint64_t kCount)
virtual gsoap_resqml2_0_1::resqml20__KDirection	getKDirection () const =0
void	setIntervalAssociationWithStratigraphicOrganizationInterpretation (int64_t const *stratiUnitIndices, int64_t nullValue, resqml2 ::AbstractStratigraphicOrganizationInterpretation *stratiOrgInterp, eml2 ::AbstractHdfProxy *hdfProxy=nullptr)
common::DataObjectReference	getStratigraphicOrganizationInterpretationDor () const final
bool	hasIntervalStratigraphicUnitIndices () const
int64_t	getIntervalStratigraphicUnitIndices (int64_t *stratiUnitIndices)
gsoap_resqml2_0_1::resqml20__PillarShape	getMostComplexPillarGeometry () const

Detailed Description

Proxy class for an abstract column layer grid representation.

Constructor & Destructor Documentation

~AbstractColumnLayerGridRepresentation()

virtual resqml2::AbstractColumnLayerGridRepresentation::~AbstractColumnLayerGridRepresentation ( )

virtualdefault

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

Member Function Documentation

getIntervalStratigraphicUnitIndices()

int64_t resqml2::AbstractColumnLayerGridRepresentation::getIntervalStratigraphicUnitIndices

(

int64_t *

stratiUnitIndices

)

Get the stratigraphic unit indices (regarding the associated stratigraphic organization interpretation) of each interval of this grid representation.

Exceptions

std::invalid_argument	If this grid is a truncated one.
std::invalid_argument	If this grid has no stratigraphic unit interval information.

Parameters

[out]

stratiUnitIndices

This array must be allocated with a size equal to the count of interval in this grid. Intervals = layers + K gaps. It will be filled in with the stratigraphic unit indices ordered as grid intervals are ordered.

Returns

The null value. The null value is used to tell the association between a grid interval and a stratigraphic unit is unavailable.

getKCellCount()

uint64_t resqml2::AbstractColumnLayerGridRepresentation::getKCellCount

(

)

const

Gets the K layer count of this grid

Exceptions

std::logic_error

If this grid is partial or if the underlying gSOAP instance is not a RESQML2.0 one.

Returns

The K layer count of this grid.

getKDirection()

virtual gsoap_resqml2_0_1::resqml20__KDirection resqml2::AbstractColumnLayerGridRepresentation::getKDirection ( ) const

pure virtual

Gets the K direction (up, down or not monotonic) of this grid.

Exceptions

std::invalid_argument

If there is no geometry on this grid.

Returns

The K direction of this grid.

getMostComplexPillarGeometry()

gsoap_resqml2_0_1::resqml20__PillarShape resqml2::AbstractColumnLayerGridRepresentation::getMostComplexPillarGeometry

(

)

const

Gets the most complex pillar geometry we can find on this grid. The returned value is not computed. It is just read from the data object attributes. Since it is denormalized information, inconsistency (mainly due to non synchronized information) might occur. In order to be sure the value is consistent with actual data, please compute this value again from the pillar kind indices.

Exceptions

std::invalid_argument

If this grid has no AbstractColumnLayerGridGeometry.

Returns

The most complex pillar geometry which we can find on this grid.

hasIntervalStratigraphicUnitIndices()

bool resqml2::AbstractColumnLayerGridRepresentation::hasIntervalStratigraphicUnitIndices

(

)

const

Queries if this grid has some interval stratigraphic unit indices.

Exceptions

std::logic_error

If this grid is partial or if the underlying gSOAP instance is not a RESQML2.0 one..

Returns

true if this grid representation has got some association between stratigraphic unit indices and intervals. Intervals = layers + K gaps.

setIntervalAssociationWithStratigraphicOrganizationInterpretation()

void resqml2::AbstractColumnLayerGridRepresentation::setIntervalAssociationWithStratigraphicOrganizationInterpretation	(	int64_t const *	stratiUnitIndices,
		int64_t	nullValue,
		resqml2 ::AbstractStratigraphicOrganizationInterpretation *	stratiOrgInterp,
		eml2 ::AbstractHdfProxy *	hdfProxy = nullptr )

Set the stratigraphic organization interpretation which is associated to this grid representation.

Exceptions

std::invalid_argument	If this grid is a truncated one and thus cannot be linked to a stratigraphic column in RESQML2.0.
std::invalid_argument	If stratiOrgInterp is null.
std::invalid_argument	If hdfProxy is null and no default HDF proxy is provided in the associated data object repository.

Parameters

[in]	stratiUnitIndices	Index of the stratigraphic unit of a given stratigraphic column for each interval of this grid representation. Array length is the number of interval in the grids. Intervals = layers + K gaps.
	nullValue	The value which is used to tell that the association between a grid interval and a stratigraphic unit is unavailable.
[in]	stratiOrgInterp	The stratigraphic organization interpretation which is associated to this grid representation.
[in,out]	hdfProxy	(Optional) The HDF proxy where to write the values. It must be already opened for writing and won't be closed in this method.

setKCellCount()

void resqml2::AbstractColumnLayerGridRepresentation::setKCellCount

(

uint64_t

kCount

)

Sets the K layer count of this grid

Exceptions

std::logic_error

If this grid is partial or if the underlying gSOAP instance is not a RESQML2.0 one.

Parameters

kCount

The K layer count to set to this grid.

---

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

• C:/Users/philippe/dev/fesapiEnv/fesapi-2.9.0.1/src/resqml2/AbstractColumnLayerGridRepresentation.h