An ijk grid lattice representation. This class cannot be inherited. More...

#include <IjkGridLatticeRepresentation.h>

Inheritance diagram for resqml2_0_1::IjkGridLatticeRepresentation:

Public Member Functions
	IjkGridLatticeRepresentation (common::DataObjectRepository *repo, const std::string &guid, const std::string &title, unsigned int iCount, unsigned int jCount, unsigned int kCount)

	IjkGridLatticeRepresentation (resqml2::AbstractFeatureInterpretation *interp, const std::string &guid, const std::string &title, unsigned int iCount, unsigned int jCount, unsigned int kCount)

	IjkGridLatticeRepresentation (gsoap_resqml2_0_1::_resqml20__IjkGridRepresentation *fromGsoap)
	Creates an instance of this class by wrapping a gSOAP instance. More...

	IjkGridLatticeRepresentation (gsoap_resqml2_0_1::_resqml20__TruncatedIjkGridRepresentation *fromGsoap)
	Creates an instance of this class by wrapping a gSOAP instance. More...

	~IjkGridLatticeRepresentation ()=default

double	getXOrigin () const final

double	getYOrigin () const final

double	getZOrigin () const final

double	getXIOffset () const final

double	getYIOffset () const final

double	getZIOffset () const final

double	getXJOffset () const final

double	getYJOffset () const final

double	getZJOffset () const final

double	getXKOffset () const final

double	getYKOffset () const final

double	getZKOffset () const final

double	getISpacing () const final

double	getJSpacing () const final

double	getKSpacing () const final

int	getOriginInline () const final

int	getOriginCrossline () const final

int	getInlineIOffset () const final

int	getInlineJOffset () const final

int	getInlineKOffset () const final

int	getCrosslineIOffset () const final

int	getCrosslineJOffset () const final

int	getCrosslineKOffset () const final

void	setGeometryAsCoordinateLineNodes (gsoap_resqml2_0_1::resqml20__PillarShape mostComplexPillarGeometry, gsoap_resqml2_0_1::resqml20__KDirection kDirectionKind, bool isRightHanded, double originX, double originY, double originZ, double directionIX, double directionIY, double directionIZ, double spacingI, double directionJX, double directionJY, double directionJZ, double spacingJ, double directionKX, double directionKY, double directionKZ, double spacingK, resqml2::AbstractLocal3dCrs *localCrs=nullptr) final

void	addSeismic3dCoordinatesToPatch (unsigned int patchIndex, double startInline, double incrInline, unsigned int countInline, double startCrossline, double incrCrossline, unsigned int countCrossline, unsigned int countSample, resqml2::AbstractRepresentation *seismicSupport) final

common::DataObjectReference	getHdfProxyDor () const final
	Gets the data object reference of the HDF proxy which is used for storing the numerical values of this representation (i.e. its geometry). More...

std::string	getXmlNamespace () const final

Public Member Functions inherited from resqml2::IjkGridLatticeRepresentation
bool	isASeismicCube () const

bool	isAFaciesCube () const

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

double	getXOriginInGlobalCrs () const

double	getYOriginInGlobalCrs () const

double	getZOriginInGlobalCrs () const

geometryKind	getGeometryKind () const final

Public Member Functions inherited from resqml2::AbstractIjkGridRepresentation
	AbstractIjkGridRepresentation (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)

	AbstractIjkGridRepresentation (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)

	AbstractIjkGridRepresentation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject, bool withTruncatedPillars=false)

virtual	~AbstractIjkGridRepresentation ()

unsigned int	getICellCount () const

void	setICellCount (unsigned int iCount)

unsigned int	getJCellCount () const

void	setJCellCount (unsigned int jCount)
	Sets the count of cells in the J direction. More...

uint64_t	getCellCount () const final

unsigned int	getColumnCount () const

unsigned int	getPillarCount () const

unsigned int	getKGapsCount () const

void	getKGaps (bool *kGaps) const

unsigned int	getFaceCount () const

unsigned int	getIPillarFromGlobalIndex (unsigned int globalIndex) const

unsigned int	getJPillarFromGlobalIndex (unsigned int globalIndex) const

unsigned int	getGlobalIndexPillarFromIjIndex (unsigned int iPillar, unsigned int jPillar) const

unsigned int	getIColumnFromGlobalIndex (unsigned int globalIndex) const

unsigned int	getJColumnFromGlobalIndex (unsigned int globalIndex) const

unsigned int	getGlobalIndexColumnFromIjIndex (unsigned int iColumn, unsigned int jColumn) const

unsigned int	getGlobalIndexCellFromIjkIndex (unsigned int iCell, unsigned int jCell, unsigned int kCell) const

bool	isRightHanded () const

void	getPillarsOfSplitCoordinateLines (unsigned int *pillarIndices, bool reverseIAxis=false, bool reverseJAxis=false) const

void	getColumnsOfSplitCoordinateLines (unsigned int *columnIndices, bool reverseIAxis=false, bool reverseJAxis=false) const

void	getColumnCountOfSplitCoordinateLines (unsigned int *columnIndexCountPerSplitCoordinateLine) const

unsigned long	getSplitCoordinateLineCount () const

unsigned long	getBlockSplitCoordinateLineCount () const

uint64_t	getSplitNodeCount () const

void	getPillarGeometryIsDefined (bool *pillarGeometryIsDefined, bool reverseIAxis=false, bool reverseJAxis=false) const

bool	hasEnabledCellInformation () const

void	getEnabledCells (bool *enabledCells, bool reverseIAxis=false, bool reverseJAxis=false, bool reverseKAxis=false) const

void	setEnabledCells (unsigned char enabledCells, eml2::AbstractHdfProxy proxy=nullptr)

void	loadSplitInformation ()

void	loadBlockInformation (unsigned int iInterfaceStart, unsigned int iInterfaceEnd, unsigned int jInterfaceStart, unsigned int jInterfaceEnd, unsigned int kInterfaceStart, unsigned int kInterfaceEnd)

void	unloadSplitInformation ()

bool	isColumnEdgeSplitted (unsigned int iColumn, unsigned int jColumn, unsigned int edge) const
	Checks either a given column edge is splitted or not. This method requires that you have already loaded the split information. More...

uint64_t	getXyzPointIndexFromCellCorner (unsigned int iCell, unsigned int jCell, unsigned int kCell, unsigned int corner) const
	Gets the XYZ point index in the HDF dataset from the corner of a cell. This method requires that you have already loaded the split information. More...

void	getXyzPointOfBlockFromCellCorner (unsigned int iCell, unsigned int jCell, unsigned int kCell, unsigned int corner, const double *xyzPoints, double &x, double &y, double &z) const
	Gets the x, y and z values of the corner of a cell of a given block. This method requires that you have already both loaded the block information and get the geometry of the block thanks to getXyzPointsOfBlock(). More...

uint64_t	getXyzPointCountOfKInterface () const

uint64_t	getXyzPointCountOfBlock () const

void	getXyzPointsOfKInterface (unsigned int kInterface, double *xyzPoints)

virtual void	getXyzPointsOfKInterfaceSequence (unsigned int kInterfaceStart, unsigned int kInterfaceEnd, double *xyzPoints)
	Gets all the XYZ points of a particular sequence of K interfaces. XYZ points are given in the local CRS. More...

virtual void	getXyzPointsOfBlock (double *xyzPoints)
	Gets all the XYZ points of the current block. XYZ points are given in the local CRS. Block information must be loaded. More...

virtual bool	isNodeGeometryCompressed () const

gsoap_resqml2_0_1::resqml20__KDirection	getKDirection () const override

virtual uint64_t	getXyzPointCountOfPatch (unsigned int patchIndex) const override

std::string	getXmlTag () const final

unsigned int	getPatchCount () const override

Public Member Functions inherited from resqml2::AbstractColumnLayerGridRepresentation
virtual	~AbstractColumnLayerGridRepresentation ()=default

unsigned int	getKCellCount () const

void	setKCellCount (unsigned int kCount)

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

common::DataObjectReference	getStratigraphicOrganizationInterpretationDor () const final

bool	hasIntervalStratigraphicUnitIndices () const

uint64_t	getIntervalStratigraphicUnitIndices (uint64_t *stratiUnitIndices)

gsoap_resqml2_0_1::resqml20__PillarShape	getMostComplexPillarGeometry () const

Public Member Functions inherited from resqml2::AbstractGridRepresentation
virtual	~AbstractGridRepresentation ()=default

std::vector< class GridConnectionSetRepresentation * >	getGridConnectionSetRepresentationSet () const

unsigned int	getGridConnectionSetRepresentationCount () const

class GridConnectionSetRepresentation *	getGridConnectionSetRepresentation (unsigned int index) const

AbstractGridRepresentation *	getParentGrid () const

common::DataObjectReference	getParentGridDor () const

std::vector< resqml2::AbstractGridRepresentation * >	getChildGridSet () const

unsigned int	getChildGridCount () const

AbstractGridRepresentation *	getChildGrid (unsigned int index) const

void	setParentWindow (uint64_t cellIndices, uint64_t cellIndexCount, class UnstructuredGridRepresentation parentGrid, eml2::AbstractHdfProxy *proxy=nullptr)

void	setParentWindow (unsigned int columnIndices, unsigned int columnIndexCount, unsigned int kLayerIndexRegridStart, unsigned int childCellCountPerInterval, unsigned int parentCellCountPerInterval, unsigned int intervalCount, class AbstractColumnLayerGridRepresentation parentGrid, eml2::AbstractHdfProxy proxy=nullptr, double childCellWeights=nullptr)

void	setParentWindow (unsigned int iCellIndexRegridStart, unsigned int childCellCountPerIInterval, unsigned int parentCellCountPerIInterval, unsigned int iIntervalCount, unsigned int jCellIndexRegridStart, unsigned int childCellCountPerJInterval, unsigned int parentCellCountPerJInterval, unsigned int jIntervalCount, unsigned int kCellIndexRegridStart, unsigned int childCellCountPerKInterval, unsigned int parentCellCountPerKInterval, unsigned int kIntervalCount, class AbstractIjkGridRepresentation parentGrid, eml2::AbstractHdfProxy proxy=nullptr, double iChildCellWeights=nullptr, double jChildCellWeights=nullptr, double *kChildCellWeights=nullptr)

void	setParentWindow (unsigned int iCellIndexRegridStart, unsigned int constantChildCellCountPerIInterval, unsigned int constantParentCellCountPerIInterval, unsigned int iIntervalCount, unsigned int jCellIndexRegridStart, unsigned int constantChildCellCountPerJInterval, unsigned int constantParentCellCountPerJInterval, unsigned int jIntervalCount, unsigned int kCellIndexRegridStart, unsigned int constantChildCellCountPerKInterval, unsigned int constantParentCellCountPerKInterval, unsigned int kIntervalCount, class AbstractIjkGridRepresentation parentGrid, eml2::AbstractHdfProxy proxy=nullptr, double iChildCellWeights=nullptr, double jChildCellWeights=nullptr, double *kChildCellWeights=nullptr)
	Indicates that this grid takes place into another IJK parent grid. This method assumes that the count of cells per regrid interval is constant in both child and parent grids. More...

void	setParentWindow (unsigned int iCellIndexRegridStart, unsigned int iChildCellCount, unsigned int iParentCellCount, unsigned int jCellIndexRegridStart, unsigned int jChildCellCount, unsigned int jParentCellCount, unsigned int kCellIndexRegridStart, unsigned int kChildCellCount, unsigned int kParentCellCount, class AbstractIjkGridRepresentation parentGrid, eml2::AbstractHdfProxy proxy=nullptr, double iChildCellWeights=nullptr, double jChildCellWeights=nullptr, double *kChildCellWeights=nullptr)

void	setForcedNonRegridedParentCell (uint64_t *cellIndices, uint64_t cellIndexCount)

void	setCellOverlap (uint64_t parentChildCellPairCount, uint64_t parentChildCellPair, const std::string &volumeUom, double overlapVolumes=nullptr)

int64_t	getParentCellIndexCount () const

void	getParentCellIndices (uint64_t *parentCellIndices) const

int64_t	getParentColumnIndexCount () const

void	getParentColumnIndices (uint64_t *parentColumnIndices) const

uint64_t	getRegridStartIndexOnParentGrid (char dimension) const

uint64_t	getRegridIntervalCount (char dimension) const

bool	isRegridCellCountPerIntervalConstant (char dimension, bool childVsParentCellCount) const

uint64_t	getRegridConstantCellCountPerInterval (char dimension, bool childVsParentCellCount) const

void	getRegridCellCountPerInterval (char dimension, uint64_t *childCellCountPerInterval, bool childVsParentCellCount) const

bool	hasRegridChildCellWeights (char dimension) const

void	getRegridChildCellWeights (char dimension, double *childCellWeights) const

bool	hasForcedNonRegridedParentCell () const

void	setCellAssociationWithStratigraphicOrganizationInterpretation (uint64_t stratiUnitIndices, uint64_t nullValue, class AbstractStratigraphicOrganizationInterpretation stratiOrgInterp)

class AbstractStratigraphicOrganizationInterpretation *	getStratigraphicOrganizationInterpretation () const

bool	hasCellStratigraphicUnitIndices () const

uint64_t	getCellStratigraphicUnitIndices (uint64_t *stratiUnitIndices)

void	setCellAssociationWithRockFluidOrganizationInterpretation (uint64_t rockFluidUnitIndices, uint64_t nullValue, class RockFluidOrganizationInterpretation rockFluidOrgInterp)

class RockFluidOrganizationInterpretation *	getRockFluidOrganizationInterpretation () const

virtual common::DataObjectReference	getRockFluidOrganizationInterpretationDor () const

bool	hasCellFluidPhaseUnitIndices () const

uint64_t	getCellFluidPhaseUnitIndices (uint64_t *rockfluidUnitIndices)

bool	isTruncated () const

uint64_t	getTruncatedFaceCount () const

void	getNodeIndicesOfTruncatedFaces (uint64_t *nodeIndices) const

void	getCumulativeNodeCountPerTruncatedFace (uint64_t *nodeCountPerFace) const

void	getNodeCountPerTruncatedFace (uint64_t *nodeCountPerFace) const

uint64_t	getTruncatedCellCount () const

void	getTruncatedCellIndices (uint64_t *cellIndices) const

void	getTruncatedFaceIndicesOfTruncatedCells (uint64_t *faceIndices) const

void	getCumulativeTruncatedFaceCountPerTruncatedCell (uint64_t *cumulativeFaceCountPerCell) const

void	getTruncatedFaceCountPerTruncatedCell (uint64_t *faceCountPerCell) const

void	getNonTruncatedFaceIndicesOfTruncatedCells (uint64_t *faceIndices) const

void	getCumulativeNonTruncatedFaceCountPerTruncatedCell (uint64_t *cumulativeFaceCountPerCell) const

void	getNonTruncatedFaceCountPerTruncatedCell (uint64_t *faceCountPerCell) const

void	getTruncatedFaceIsRightHanded (unsigned char *cellFaceIsRightHanded) const

void	loadTargetRelationships ()

Public Member Functions inherited from resqml2::AbstractRepresentation
virtual	~AbstractRepresentation ()=default

class AbstractLocal3dCrs *	getLocalCrs (unsigned int patchIndex) const

virtual common::DataObjectReference	getLocalCrsDor (unsigned int patchIndex) const

std::vector< class AbstractProperty * >	getPropertySet () const

void	setInterpretation (class AbstractFeatureInterpretation *interp)

class AbstractFeatureInterpretation *	getInterpretation () const

common::DataObjectReference	getInterpretationDor () const

uint64_t	getXyzPointCountOfAllPatches () const

void	getXyzPointsOfPatchInGlobalCrs (unsigned int patchIndex, double *xyzPoints) const
	Gets all the xyz points of a particular patch of this representation. xyz points are given in the global CRS. More...

void	getXyzPointsOfAllPatches (double *xyzPoints) const
	Gets all the xyz points of all patches of this representation. xyz points are given in the local CRS. More...

bool	isInSingleLocalCrs () const

bool	isInSingleGlobalCrs () const

void	getXyzPointsOfAllPatchesInGlobalCrs (double *xyzPoints) const

AbstractRepresentation *	getSeismicSupportOfPatch (const unsigned int &patchIndex) const

std::set< AbstractRepresentation * >	getAllSeismicSupport () const

void	pushBackIntoRepresentationSet (class RepresentationSetRepresentation *repSet)

void	addSeismic3dCoordinatesToPatch (unsigned int patchIndex, double inlines, double crosslines, unsigned int pointCount, resqml2::AbstractRepresentation seismicSupport, eml2::AbstractHdfProxy proxy)

void	addSeismic3dCoordinatesToPatch (unsigned int patchIndex, double startInline, double incrInline, unsigned int countInline, double startCrossline, double incrCrossline, unsigned int countCrossline, resqml2::AbstractRepresentation *seismicSupport)

void	addSeismic2dCoordinatesToPatch (unsigned int patchIndex, double lineAbscissa, resqml2::AbstractRepresentation seismicSupport, eml2::AbstractHdfProxy *proxy)

void	getSeismicLineAbscissaOfPointsOfPatch (unsigned int patchIndex, double *values) const

void	getInlinesOfPointsOfPatch (unsigned int patchIndex, double *values) const

void	getCrosslinesOfPointsOfPatch (unsigned int patchIndex, double *values) const

Public Member Functions inherited from common::AbstractObject
bool	isPartial () const

virtual bool	isTopLevelElement () const

std::string	getUuid () const

std::string	getTitle () const

std::string	getEditor () const

time_t	getCreation () const

tm	getCreationAsTimeStructure () const

std::string	getOriginator () const

std::string	getDescription () const

time_t	getLastUpdate () const

tm	getLastUpdateAsTimeStructure () const

std::string	getFormat () const

std::string	getDescriptiveKeywords () const

std::string	getVersion () const

void	setTitle (const std::string &title)

void	setEditor (const std::string &editor)

void	setCreation (time_t creation)

void	setCreation (const tm &creation)

void	setOriginator (const std::string &originator)

void	setDescription (const std::string &description)

void	setLastUpdate (time_t lastUpdate)

void	setLastUpdate (const tm &lastUpdate)

void	setDescriptiveKeywords (const std::string &descriptiveKeywords)

void	setVersion (const std::string &version)

void	setMetadata (const std::string &title, const std::string &editor, time_t creation, const std::string &originator, const std::string &description, time_t lastUpdate, const std::string &descriptiveKeywords)

void	serializeIntoStream (std::ostream *stream)

void	setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *gsoapProxy)

void	setGsoapProxy (gsoap_eml2_1::eml21__AbstractObject *gsoapProxy)

gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getEml20GsoapProxy () const

gsoap_eml2_1::eml21__AbstractObject *	getEml21GsoapProxy () const

gsoap_eml2_2::eml22__AbstractObject *	getEml22GsoapProxy () const

void	setGsoapProxy (gsoap_eml2_2::eml22__AbstractObject *gsoapProxy)

gsoap_eml2_3::eml23__AbstractObject *	getEml23GsoapProxy () const

void	setGsoapProxy (gsoap_eml2_3::eml23__AbstractObject *gsoapProxy)

soap *	getGsoapContext () const

int	getGsoapType () const

gsoap_resqml2_0_1::eml20__DataObjectReference *	newResqmlReference () const

gsoap_eml2_1::eml21__DataObjectReference *	newEmlReference () const

gsoap_eml2_2::eml22__DataObjectReference *	newEml22Reference () const

gsoap_eml2_3::eml23__DataObjectReference *	newEml23Reference () const

gsoap_resqml2_0_1::resqml20__ContactElementReference *	newContactElementReference2_0_1 () const

gsoap_eml2_3::resqml22__ContactElement *	newContactElementReference2_2 () const

common::DataObjectRepository *	getRepository () const

virtual std::string	getXmlNamespaceVersion () const

virtual std::string	getContentType () const

virtual std::string	getQualifiedType () const

virtual std::string	getPartNameInEpcDocument () const

std::string	serializeIntoString ()

void	addAlias (const std::string &authority, const std::string &title)

unsigned int	getAliasCount () const

std::string	getAliasAuthorityAtIndex (unsigned int index) const

std::string	getAliasTitleAtIndex (unsigned int index) const

std::vector< eml2::Activity * >	getActivitySet () const

unsigned int	getActivityCount () const

eml2::Activity *	getActivity (unsigned int index) const

void	pushBackExtraMetadata (const std::string &key, const std::string &value)

std::unordered_map< std::string, std::string >	getExtraMetadataSet () const

std::vector< std::string >	getExtraMetadata (const std::string &key) const

unsigned int	getExtraMetadataCount () const

std::string	getExtraMetadataKeyAtIndex (unsigned int index) const

std::string	getExtraMetadataStringValueAtIndex (unsigned int index) const

Static Public Attributes
static const char *	XML_NS

Static Public Attributes inherited from resqml2::AbstractIjkGridRepresentation
static const char *	XML_TAG

static const char *	XML_TAG_TRUNCATED

Static Public Attributes inherited from resqml2::AbstractGridRepresentation
static const char *	XML_TAG

Static Public Attributes inherited from resqml2::AbstractRepresentation
static const char *	XML_TAG

Additional Inherited Members
Public Types inherited from resqml2::AbstractIjkGridRepresentation
enum	geometryKind { UNKNOWN = 0 , EXPLICIT = 1 , PARAMETRIC = 2 , LATTICE = 3 , NO_GEOMETRY = 4 }

Public Types inherited from resqml2::AbstractRepresentation
enum	indexableElement { NODE = 0 , EDGE = 1 , FACE = 2 , VOLUME = 3 , PILLAR = 4 }

Public Types inherited from common::AbstractObject
enum	hdfDatatypeEnum { UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , LONG_64 = 3 , ULONG_64 = 4 , INT = 5 , UINT = 6 , SHORT = 7 , USHORT = 8 , CHAR = 9 , UCHAR = 10 }

Static Public Member Functions inherited from common::AbstractObject
static void	setFormat (const std::string &vendor, const std::string &applicationName, const std::string &applicationVersionNumber)

Detailed Description

An ijk grid lattice representation. This class cannot be inherited.

Constructor & Destructor Documentation

◆ IjkGridLatticeRepresentation() [1/4]

resqml2_0_1::IjkGridLatticeRepresentation::IjkGridLatticeRepresentation	(	common::DataObjectRepository *	repo,
		const std::string &	guid,
		const std::string &	title,
		unsigned int	iCount,
		unsigned int	jCount,
		unsigned int	kCount
	)

inline

Constructor

Parameters

[in,out]	repo	If non-null, the repo.
	guid	Unique identifier.
	title	The title.
	iCount	Number of.
	jCount	Number of.
	kCount	Number of.

◆ IjkGridLatticeRepresentation() [2/4]

resqml2_0_1::IjkGridLatticeRepresentation::IjkGridLatticeRepresentation	(	resqml2::AbstractFeatureInterpretation *	interp,
		const std::string &	guid,
		const std::string &	title,
		unsigned int	iCount,
		unsigned int	jCount,
		unsigned int	kCount
	)

inline

Constructor

Parameters

[in,out]	interp	If non-null, the interp.
	guid	Unique identifier.
	title	The title.
	iCount	Number of.
	jCount	Number of.
	kCount	Number of.

◆ IjkGridLatticeRepresentation() [3/4]

resqml2_0_1::IjkGridLatticeRepresentation::IjkGridLatticeRepresentation ( gsoap_resqml2_0_1::_resqml20__IjkGridRepresentation * fromGsoap )

inline

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

Parameters

[in] fromGsoap If non-null, the gSOAP instance.

◆ IjkGridLatticeRepresentation() [4/4]

resqml2_0_1::IjkGridLatticeRepresentation::IjkGridLatticeRepresentation ( gsoap_resqml2_0_1::_resqml20__TruncatedIjkGridRepresentation * fromGsoap )

inline

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

Parameters

[in] fromGsoap If non-null, the gSOAP instance.

◆ ~IjkGridLatticeRepresentation()

resqml2_0_1::IjkGridLatticeRepresentation::~IjkGridLatticeRepresentation ( )

virtualdefault

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

Reimplemented from resqml2::IjkGridLatticeRepresentation.

Member Function Documentation

◆ addSeismic3dCoordinatesToPatch()

void resqml2_0_1::IjkGridLatticeRepresentation::addSeismic3dCoordinatesToPatch	(	unsigned int	patchIndex,
		double	startInline,
		double	incrInline,
		unsigned int	countInline,
		double	startCrossline,
		double	incrCrossline,
		unsigned int	countCrossline,
		unsigned int	countSample,
		resqml2::AbstractRepresentation *	seismicSupport
	)

finalvirtual

Pushes back a patch of seismic 3D coordinates.

Exceptions

std::logic_error	If this grid is partial.
std::invalid_argument	If `patchIndex` does not identify a point geometry.
std:invalid_argument	If `seismicSupport` is nullptr.
std::invalid_argument	If it already exists some seismic 2d coordinates for this patch.

Parameters

	patchIndex	Zero-based index of the patch to push. It must be consistent with the index of the geometry patch it is related to.
	startInline	The start inline.
	incrInline	The inline increment.
	countInline	The count of inlines.
	startCrossline	The start crossline.
	incrCrossline	The crossline increment.
	countCrossline	The count of crosslines.
	countSample	The count of samples.
[in]	seismicSupport	The seismic support of the patch to push.

Implements resqml2::IjkGridLatticeRepresentation.

◆ getCrosslineIOffset()

int resqml2_0_1::IjkGridLatticeRepresentation::getCrosslineIOffset ( ) const

finalvirtual

Gets the crossline I offset value. Notice that I is the slowest axis in the seismic context.

Exceptions

std::logic_error If this grid is partial.

Returns: The crossline I offset value if successful, otherwise 0.

Implements resqml2::IjkGridLatticeRepresentation.

◆ getCrosslineJOffset()

int resqml2_0_1::IjkGridLatticeRepresentation::getCrosslineJOffset ( ) const

finalvirtual

Gets the crossline J offset value.

Exceptions

std::logic_error If this grid is partial.

Returns: The crossline J offset value if successful, otherwise 0.

Implements resqml2::IjkGridLatticeRepresentation.

◆ getCrosslineKOffset()

int resqml2_0_1::IjkGridLatticeRepresentation::getCrosslineKOffset ( ) const

finalvirtual

Gets the crossline K offset value. Notice that K is the fastest axis in the seismic context.

Exceptions

std::logic_error If this grid is partial.

Returns: The crossline K offset value if successful, otherwise 0.

Implements resqml2::IjkGridLatticeRepresentation.

◆ getHdfProxyDor()

common::DataObjectReference resqml2_0_1::IjkGridLatticeRepresentation::getHdfProxyDor ( ) const

finalvirtual

Gets the data object reference of the HDF proxy which is used for storing the numerical values of this representation (i.e. its geometry).

Exceptions

std::logic_error If this representation is partial.

Returns: The data object reference of the HDF proxy used for storing the geometry, or empty data object reference if it fails.

Reimplemented from resqml2::AbstractIjkGridRepresentation.

◆ getInlineIOffset()

int resqml2_0_1::IjkGridLatticeRepresentation::getInlineIOffset ( ) const

finalvirtual

Gets the inline I offset value. Notice that I is the slowest axis in the seismic context.

Exceptions

std::logic_error If this grid is partial.

Returns: The inline I offset value if successful, otherwise 0.

Implements resqml2::IjkGridLatticeRepresentation.

◆ getInlineJOffset()

int resqml2_0_1::IjkGridLatticeRepresentation::getInlineJOffset ( ) const

finalvirtual

Gets the inline J offset value.

Exceptions

std::logic_error If this grid is partial.

Returns: The inline J offset value if successful, otherwise 0.

Implements resqml2::IjkGridLatticeRepresentation.

◆ getInlineKOffset()

int resqml2_0_1::IjkGridLatticeRepresentation::getInlineKOffset ( ) const

finalvirtual

Gets the inline K offset value. Notice that K is the fastest axis in the seismic context.

Exceptions

std::logic_error If this grid is partial.

Returns: The inline K offset value if successful, otherwise 0.

Implements resqml2::IjkGridLatticeRepresentation.

◆ getISpacing()

double resqml2_0_1::IjkGridLatticeRepresentation::getISpacing ( ) const

finalvirtual

Gets the I spacing of this regular (seismic) grid. Notice that I is the slowest axis in the seismic context.

Exceptions

std::logic_error If this grid is partial.

Returns: The I spacing if successful, otherwise double.NAN.

Implements resqml2::IjkGridLatticeRepresentation.

◆ getJSpacing()

double resqml2_0_1::IjkGridLatticeRepresentation::getJSpacing ( ) const

finalvirtual

Gets the J spacing of this regular (seismic) grid.

Exceptions

std::logic_error If this grid is partial.

Returns: The J spacing if successful, otherwise double.NAN.

Implements resqml2::IjkGridLatticeRepresentation.

◆ getKSpacing()

double resqml2_0_1::IjkGridLatticeRepresentation::getKSpacing ( ) const

finalvirtual

Gets the K spacing of this regular (seismic) grid. Notice that K is the fastest axis in the seismic context.

Exceptions

std::logic_error If this grid is partial.

Returns: The K spacing if successful, otherwise double.NAN.

Implements resqml2::IjkGridLatticeRepresentation.

◆ getOriginCrossline()

int resqml2_0_1::IjkGridLatticeRepresentation::getOriginCrossline ( ) const

finalvirtual

Gets the label of the first crossline.

Exceptions

std::logic_error If this grid is partial.

Returns: The label of the first crossline if successful, otherwise 0.

Implements resqml2::IjkGridLatticeRepresentation.

◆ getOriginInline()

int resqml2_0_1::IjkGridLatticeRepresentation::getOriginInline ( ) const

finalvirtual

Gets the label of the first inline.

Exceptions

std::logic_error If this grid is partial.

Returns: The label of the first inline if successful, otherwise 0.

Implements resqml2::IjkGridLatticeRepresentation.

◆ getXIOffset()

double resqml2_0_1::IjkGridLatticeRepresentation::getXIOffset ( ) const

finalvirtual

Gets the X coordinate of the I offset of this geometry. Notice that I is the slowest axis in the seismic context. The X coordinate is given in the local CRS.

Exceptions

std::logic_error If this grid is partial.

Returns: The X coordinate of the I offset if successful, otherwise double.NAN.

Implements resqml2::IjkGridLatticeRepresentation.

◆ getXJOffset()

double resqml2_0_1::IjkGridLatticeRepresentation::getXJOffset ( ) const

finalvirtual

Gets the X coordinate of the J offset of this geometry. The X coordinate is given in the local CRS.

Exceptions

std::logic_error If this grid is partial.

Returns: The X coordinate of the J offset if successful, otherwise double.NAN.

Implements resqml2::IjkGridLatticeRepresentation.

◆ getXKOffset()

double resqml2_0_1::IjkGridLatticeRepresentation::getXKOffset ( ) const

finalvirtual

Gets the X coordinate of the K offset of this geometry. Notice that K is the fastest axis in the seismic context. The X coordinate is given in the local CRS.

Exceptions

std::logic_error If this grid is partial.

Returns: The X coordinate of the K offset if successful, otherwise double.NAN.

Implements resqml2::IjkGridLatticeRepresentation.

◆ getXmlNamespace()

std::string resqml2_0_1::IjkGridLatticeRepresentation::getXmlNamespace ( ) const

inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Reimplemented from resqml2::AbstractIjkGridRepresentation.

◆ getXOrigin()

double resqml2_0_1::IjkGridLatticeRepresentation::getXOrigin ( ) const

finalvirtual

Gets the X coordinate of the origin of this geometry. The X coordinate is given in the local CRS.

Exceptions

std::logic_error If this grid is partial.

Returns: The X coordinate of the origin point if successful, otherwise double.NAN.

Implements resqml2::IjkGridLatticeRepresentation.

◆ getYIOffset()

double resqml2_0_1::IjkGridLatticeRepresentation::getYIOffset ( ) const

finalvirtual

Gets the Y coordinate of the I offset of this geometry. Notice that I is the slowest axis in the seismic context. The Y coordinate is given in the local CRS.

Exceptions

std::logic_error If this grid is partial.

Returns: The Y coordinate of the I offset if successful, otherwise double.NAN.

Implements resqml2::IjkGridLatticeRepresentation.

◆ getYJOffset()

double resqml2_0_1::IjkGridLatticeRepresentation::getYJOffset ( ) const

finalvirtual

Gets the Y coordinate of the J offset of this geometry. The Y coordinate is given in the local CRS.

Exceptions

std::logic_error If this grid is partial.

Returns: The Y coordinate of the J offset if successful, otherwise double.NAN.

Implements resqml2::IjkGridLatticeRepresentation.

◆ getYKOffset()

double resqml2_0_1::IjkGridLatticeRepresentation::getYKOffset ( ) const

finalvirtual

Gets the Y coordinate of the K offset of this geometry. Notice that K is the fastest axis in the seismic context. The Y coordinate is given in the local CRS.

Exceptions

std::logic_error If this grid is partial.

Returns: The Y coordinate of the K offset if successful, otherwise double.NAN.

Implements resqml2::IjkGridLatticeRepresentation.

◆ getYOrigin()

double resqml2_0_1::IjkGridLatticeRepresentation::getYOrigin ( ) const

finalvirtual

Gets the Y coordinate of the origin of this geometry. The Y coordinate is given in the local CRS.

Exceptions

std::logic_error If this grid is partial.

Returns: The Y coordinate of the origin point if successful, otherwise double.NAN.

Implements resqml2::IjkGridLatticeRepresentation.

◆ getZIOffset()

double resqml2_0_1::IjkGridLatticeRepresentation::getZIOffset ( ) const

finalvirtual

Gets the Z coordinate of the I offset of this geometry. Notice that I is the slowest axis in the seismic context. The Z coordinate is given in the local CRS.

Exceptions

std::logic_error If this grid is partial.

Returns: The Z coordinate of the I offset if successful, otherwise double.NAN.

Implements resqml2::IjkGridLatticeRepresentation.

◆ getZJOffset()

double resqml2_0_1::IjkGridLatticeRepresentation::getZJOffset ( ) const

finalvirtual

Gets the Z coordinate of the J offset of this geometry. The Z coordinate is given in the local CRS.

Exceptions

std::logic_error If this grid is partial.

Returns: The Z coordinate of the J offset if successful, otherwise double.NAN.

Implements resqml2::IjkGridLatticeRepresentation.

◆ getZKOffset()

double resqml2_0_1::IjkGridLatticeRepresentation::getZKOffset ( ) const

finalvirtual

Gets the Z coordinate of the K offset of this geometry. Notice that K is the fastest axis in the seismic context. The Z coordinate is given in the local CRS.

Exceptions

std::logic_error If this grid is partial.

Returns: The Z coordinate of the K offset if successful, otherwise double.NAN.

Implements resqml2::IjkGridLatticeRepresentation.

◆ getZOrigin()

double resqml2_0_1::IjkGridLatticeRepresentation::getZOrigin ( ) const

finalvirtual

Gets the Z coordinate of the origin of this geometry. The Z coordinate is given in the local CRS.

Exceptions

std::logic_error If this grid is partial.

Returns: The Z coordinate of the origin point if successful, otherwise double.NAN.

Implements resqml2::IjkGridLatticeRepresentation.

◆ setGeometryAsCoordinateLineNodes()

void resqml2_0_1::IjkGridLatticeRepresentation::setGeometryAsCoordinateLineNodes	(	gsoap_resqml2_0_1::resqml20__PillarShape	mostComplexPillarGeometry,
		gsoap_resqml2_0_1::resqml20__KDirection	kDirectionKind,
		bool	isRightHanded,
		double	originX,
		double	originY,
		double	originZ,
		double	directionIX,
		double	directionIY,
		double	directionIZ,
		double	spacingI,
		double	directionJX,
		double	directionJY,
		double	directionJZ,
		double	spacingJ,
		double	directionKX,
		double	directionKY,
		double	directionKZ,
		double	spacingK,
		resqml2::AbstractLocal3dCrs *	localCrs = `nullptr`
	)

finalvirtual

Sets the geometry of this IJK grid as a regular IJK grid

Exceptions

std::invalid_argument If localCrs is nullptr and no default local 3d CRS is defined.

Parameters

	mostComplexPillarGeometry	The most complex pillar shape which we can find on this IJK grid.
	kDirectionKind	The K direction kind.
	isRightHanded	Indicates that the IJK grid is right handed, as determined by the triple product of tangent vectors in the I, J, and K directions.
	originX	The X coordinate of the origin.
	originY	The Y coordinate of the origin.
	originZ	The Z coordinate of the origin.
	directionIX	The X coordinate of the I offset.
	directionIY	The Y coordinate of the I offset.
	directionIZ	The Z coordinate of the I offset.
	spacingI	The spacing in the I direction.
	directionJX	The X coordinate of the J offset.
	directionJY	The Y coordinate of the J offset.
	directionJZ	The Z coordinate of the J offset.
	spacingJ	The spacing in the J direction.
	directionKX	The X coordinate of the K offset.
	directionKY	The Y coordinate of the K offset.
	directionKZ	The Z coordinate of the K offset.
	spacingK	The spacing in the K direction.
[in]	localCrs	(Optional) The local CRS where the points are given. If `nullptr` (default) then the default CRS of the repository will be used.

Implements resqml2::IjkGridLatticeRepresentation.

Member Data Documentation

◆ XML_NS

const char* resqml2_0_1::IjkGridLatticeRepresentation::XML_NS

static

The standard XML namespace for serializing this data object.

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

C:/Users/philippe/dev/fesapiEnv/fesapi-2.0.0.0/src/resqml2_0_1/IjkGridLatticeRepresentation.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IjkGridLatticeRepresentation() [1/4]

◆ IjkGridLatticeRepresentation() [2/4]

◆ IjkGridLatticeRepresentation() [3/4]

◆ IjkGridLatticeRepresentation() [4/4]

◆ ~IjkGridLatticeRepresentation()

Member Function Documentation

◆ addSeismic3dCoordinatesToPatch()

◆ getCrosslineIOffset()

◆ getCrosslineJOffset()

◆ getCrosslineKOffset()

◆ getHdfProxyDor()

◆ getInlineIOffset()

◆ getInlineJOffset()

◆ getInlineKOffset()

◆ getISpacing()

◆ getJSpacing()

◆ getKSpacing()

◆ getOriginCrossline()

◆ getOriginInline()

◆ getXIOffset()

◆ getXJOffset()

◆ getXKOffset()

◆ getXmlNamespace()

◆ getXOrigin()

◆ getYIOffset()

◆ getYJOffset()

◆ getYKOffset()

◆ getYOrigin()

◆ getZIOffset()

◆ getZJOffset()

◆ getZKOffset()

◆ getZOrigin()

◆ setGeometryAsCoordinateLineNodes()

Member Data Documentation

◆ XML_NS