A 2d grid representation. More...

#include <Grid2dRepresentation.h>

Inheritance diagram for resqml2::Grid2dRepresentation:

Public Member Functions
virtual	~Grid2dRepresentation ()=default

virtual uint64_t	getNodeCountAlongIAxis () const =0

virtual uint64_t	getNodeCountAlongJAxis () const =0

uint64_t	getXyzPointCountOfPatch (unsigned int patchIndex) const final

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

virtual void	getZValues (double *values) const =0

void	getZValuesInGlobalCrs (double *values) const

virtual double	getXOrigin () const =0

virtual double	getYOrigin () const =0

virtual double	getZOrigin () const =0

double	getXOriginInGlobalCrs () const

double	getYOriginInGlobalCrs () const

double	getZOriginInGlobalCrs () const

virtual double	getXJOffset () const =0

virtual double	getYJOffset () const =0

virtual double	getZJOffset () const =0

double	getXJOffsetInGlobalCrs () const

double	getYJOffsetInGlobalCrs () const

double	getZJOffsetInGlobalCrs () const

virtual double	getXIOffset () const =0

virtual double	getYIOffset () const =0

virtual double	getZIOffset () const =0

double	getXIOffsetInGlobalCrs () const

double	getYIOffsetInGlobalCrs () const

double	getZIOffsetInGlobalCrs () const

virtual bool	isJSpacingConstant () const =0

virtual bool	isISpacingConstant () const =0

virtual double	getJSpacing () const =0

virtual void	getJSpacing (double *jSpacings) const =0

virtual double	getISpacing () const =0

virtual void	getISpacing (double *iSpacings) const =0

virtual void	setGeometryAsArray2dOfLatticePoints3d (unsigned int numPointsInFastestDirection, unsigned int numPointsInSlowestDirection, double xOrigin, double yOrigin, double zOrigin, double xOffsetInFastestDirection, double yOffsetInFastestDirection, double zOffsetInFastestDirection, double xOffsetInSlowestDirection, double yOffsetInSlowestDirection, double zOffsetInSlowestDirection, double spacingInFastestDirection, double spacingInSlowestDirection, resqml2::AbstractLocal3dCrs *localCrs=nullptr)=0

virtual void	setGeometryAsArray2dOfExplicitZ (double zValues, unsigned int numI, unsigned int numJ, eml2::AbstractHdfProxy proxy, Grid2dRepresentation supportingGrid2dRepresentation, resqml2::AbstractLocal3dCrs localCrs=nullptr, unsigned int startIndexI=0, unsigned int startIndexJ=0, int indexIncrementI=1, int indexIncrementJ=1)=0

virtual void	setGeometryAsArray2dOfExplicitZ (double zValues, unsigned int numI, unsigned int numJ, eml2::AbstractHdfProxy proxy, double originX, double originY, double originZ, double offsetIX, double offsetIY, double offsetIZ, double spacingI, double offsetJX, double offsetJY, double offsetJZ, double spacingJ, resqml2::AbstractLocal3dCrs *localCrs=nullptr)=0

virtual common::DataObjectReference	getSupportingRepresentationDor () const =0

Grid2dRepresentation *	getSupportingRepresentation () const

virtual int	getIndexOriginOnSupportingRepresentation () const =0

virtual int	getIndexOriginOnSupportingRepresentation (unsigned int dimension) const =0

virtual int	getNodeCountOnSupportingRepresentation (unsigned int dimension) const =0

virtual int	getIndexOffsetOnSupportingRepresentation (unsigned int dimension) const =0
	Gets the index offset of the nodes of the current geometry on a particular dimension of the supporting representation. More...

unsigned int	getPatchCount () const final

std::string	getXmlTag () const final

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

unsigned int	getBoundariesCount () const

common::DataObjectReference	getOuterRingDor (unsigned int index) const

void	pushBackOuterRing (PolylineRepresentation *outerRing)

void	setSurfaceRole (gsoap_resqml2_0_1::resqml20__SurfaceRole surfaceRole)

gsoap_resqml2_0_1::resqml20__SurfaceRole	getSurfaceRole () const

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

virtual common::DataObjectReference	getHdfProxyDor () const =0
	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::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	getXmlNamespace () const =0

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_TAG

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

Additional Inherited Members
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

A 2d grid representation.

Constructor & Destructor Documentation

◆ ~Grid2dRepresentation()

virtual resqml2::Grid2dRepresentation::~Grid2dRepresentation ( )

virtualdefault

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

Reimplemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

Member Function Documentation

◆ getIndexOffsetOnSupportingRepresentation()

virtual int resqml2::Grid2dRepresentation::getIndexOffsetOnSupportingRepresentation ( unsigned int dimension ) const

pure virtual

Gets the index offset of the nodes of the current geometry on a particular dimension of the supporting representation.

Exceptions

std::logic_error	If no supporting representation is associated to this 2d grid representation.
std::out_of_range	If `dimension` is out of range.

Parameters

dimension The dimension for which we look for the index offset.

Returns: The index offset on the dimension dimension.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

◆ getIndexOriginOnSupportingRepresentation() [1/2]

virtual int resqml2::Grid2dRepresentation::getIndexOriginOnSupportingRepresentation ( ) const

pure virtual

Gets the index of the origin of the current geometry on the supporting representation. The index is given by means of the formula iOrigin + jOrigin * iNodeCountOnSupportingRepresentation

Exceptions

std::logic_error If no supporting representation is associated to this 2d grid representation.

Returns: The index of the origin on the supporting representation.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

◆ getIndexOriginOnSupportingRepresentation() [2/2]

virtual int resqml2::Grid2dRepresentation::getIndexOriginOnSupportingRepresentation ( unsigned int dimension ) const

pure virtual

Gets the index of the origin of the current geometry on a particular dimension of the supporting representation.

Exceptions

std::logic_error	If no supporting representation is associated to this 2d grid representation.
std::invalid_argument	If `dimension` differs from `0` or `1`.

Parameters

dimension The dimension for which we look for the index of the origin. It can be 0 for J (slowest) dimension or 1 for I (fastest) dimension.

Returns: The index of the origin on the supporting representation on the dimension dimension.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

◆ getISpacing() [1/2]

virtual double resqml2::Grid2dRepresentation::getISpacing ( ) const

pure virtual

Gets the constant I (fastest) spacing of this 2d grid representation.

Exceptions

std::logic_error If the I spacing is not constant or cannot be get.

Returns: The constant I (fastest) spacing of this 2d grid representation.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

◆ getISpacing() [2/2]

virtual void resqml2::Grid2dRepresentation::getISpacing ( double * iSpacings ) const

pure virtual

Gets all the I (fastest) spacings of this 2d grid representation.

Exceptions

std::logic_error If the HDF proxy is missing of if the I spacings cannot be get.

Parameters

[out] iSpacings A preallocated array to receive the I spacings. The count of this array must be getNodeCountAlongJAxis() - 1 and it will not be freed by this method.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

◆ getJSpacing() [1/2]

virtual double resqml2::Grid2dRepresentation::getJSpacing ( ) const

pure virtual

Gets the constant J (slowest) spacing of this 2d grid representation.

Exceptions

std::logic_error If the J spacing is not constant or cannot be get.

Returns: The constant J (slowest) spacing of this 2d grid representation.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

◆ getJSpacing() [2/2]

virtual void resqml2::Grid2dRepresentation::getJSpacing ( double * jSpacings ) const

pure virtual

Gets all the J (slowest) spacings of this 2d grid representation.

Exceptions

std::logic_error If the HDF proxy is missing of if the J spacings cannot be get.

Parameters

[out] jSpacings A preallocated array to receive the J spacings. The count of this array must be getNodeCountAlongJAxis() - 1 and it will not be freed by this method.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

◆ getNodeCountAlongIAxis()

virtual uint64_t resqml2::Grid2dRepresentation::getNodeCountAlongIAxis ( ) const

pure virtual

Gets the number of nodes along the I (fastest) axis of this 2d grid representation.

Returns: The node count along the I (fastest) axis.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

◆ getNodeCountAlongJAxis()

virtual uint64_t resqml2::Grid2dRepresentation::getNodeCountAlongJAxis ( ) const

pure virtual

Gets the number of nodes along the J (slowest) axis of this 2d grid representation.

Returns: The node count along the J (slowest) axis.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

◆ getNodeCountOnSupportingRepresentation()

virtual int resqml2::Grid2dRepresentation::getNodeCountOnSupportingRepresentation ( unsigned int dimension ) const

pure virtual

Gets the number of nodes of the current geometry which is extracted from a particular dimension of the supporting representation.

Exceptions

std::logic_error	If no supporting representation is associated to this 2d grid representation.
std::out_of_range	If `dimension` is out of range.

Parameters

dimension The dimension for which we look for the number of nodes.

Returns: The number of nodes on the dimension dimension.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

◆ getPatchCount()

unsigned int resqml2::Grid2dRepresentation::getPatchCount ( ) const

inlinefinalvirtual

Gets the patch count.

Returns: The patch count.

Implements resqml2::AbstractRepresentation.

◆ getSupportingRepresentation()

Grid2dRepresentation* resqml2::Grid2dRepresentation::getSupportingRepresentation ( ) const

Gets the supporting representation of this 2d grid representation.

Returns: The supporting representation if there exists one, else nullptr.

◆ getSupportingRepresentationDor()

virtual common::DataObjectReference resqml2::Grid2dRepresentation::getSupportingRepresentationDor ( ) const

pure virtual

Gets the supporting representation data object reference.

Returns: The supporting representation data object reference if there exists one, else empty data object reference.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

◆ getXIOffset()

virtual double resqml2::Grid2dRepresentation::getXIOffset ( ) const

pure virtual

Gets the x offset along the I (fastest) axis. If the J spacing is constant, the returned offset is exactly the offset between two consecutive nodes lying on the J axis. If not, the offset length does not have any meaning. The x coordinate is given in the local CRS.

Exceptions

std::logic_error If the x offset along the I axis cannot be get.

Returns: The x offset along the I (fastest) axis.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

◆ getXIOffsetInGlobalCrs()

double resqml2::Grid2dRepresentation::getXIOffsetInGlobalCrs ( ) const

Gets the x offset along the I (fastest) axis. If the J spacing is constant, the returned offset is exactly the offset between two consecutive nodes lying on the J axis. If not, the offset length does not have any meaning. The x coordinate is given in the global CRS.

Exceptions

std::logic_error If the x offset along the I axis cannot be get.

Returns: The x offset along the I (fastest) axis.

◆ getXJOffset()

virtual double resqml2::Grid2dRepresentation::getXJOffset ( ) const

pure virtual

Gets the x offset along the J (slowest) axis. If the J spacing is constant, the returned offset is exactly the offset between two consecutive nodes lying on the J axis. If not, the offset length does not have any meaning. The x coordinate is given in the local CRS.

Exceptions

std::logic_error If the x offset along the J axis cannot be get.

Returns: The x offset along the J (slowest) axis.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

◆ getXJOffsetInGlobalCrs()

double resqml2::Grid2dRepresentation::getXJOffsetInGlobalCrs ( ) const

Gets the x offset along the J (slowest) axis. If the J spacing is constant, the returned offset is exactly the offset between two consecutive nodes lying on the J axis. If not, the offset length does not have any meaning. The x coordinate is given in the global CRS.

Exceptions

std::logic_error If the x offset along the J axis cannot be get.

Returns: The x offset along the J (slowest) axis.

◆ getXmlTag()

std::string resqml2::Grid2dRepresentation::getXmlTag ( ) const

inlinefinalvirtual

Gets the standard XML tag without XML namespace for serializing this data object.

Returns: The XML tag.

Implements common::AbstractObject.

◆ getXOrigin()

virtual double resqml2::Grid2dRepresentation::getXOrigin ( ) const

pure virtual

Gets the x coordinate of the origin of this 2d grid representation. The x coordinate is given in the local CRS.

Returns: NAN if the origin x coordinate cannot be get, the origin x coordinate otherwise.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

◆ getXOriginInGlobalCrs()

double resqml2::Grid2dRepresentation::getXOriginInGlobalCrs ( ) const

Gets the x coordinate of the origin of this 2d grid representation. The x coordinate is given in the global CRS.

Returns: NAN if the origin x coordinate cannot be get, the origin x coordinate otherwise.

◆ getXyzPointCountOfPatch()

uint64_t resqml2::Grid2dRepresentation::getXyzPointCountOfPatch ( unsigned int patchIndex ) const

finalvirtual

Get the xyz point count in a given patch of this representation.

Exceptions

std::out_of_range	If `patchIndex` is out of range.
std::logic_error	If this representation is partial.

Parameters

patchIndex Zero-based index of the patch from which we look for the xyz points.

Returns: The xyz point count of the patch at position patchIndex.

Implements resqml2::AbstractRepresentation.

◆ getXyzPointsOfPatch()

void resqml2::Grid2dRepresentation::getXyzPointsOfPatch	(	unsigned int	patchIndex,
		double *	xyzPoints
	)		const

finalvirtual

Please do note use: please compute x and y values with the lattice information.

Implements resqml2::AbstractRepresentation.

◆ getYIOffset()

virtual double resqml2::Grid2dRepresentation::getYIOffset ( ) const

pure virtual

Gets the y offset along the I (fastest) axis. If the J spacing is constant, the returned offset is exactly the offset between two consecutive nodes lying on the J axis. If not, the offset length does not have any meaning. The y coordinate is given in the local CRS.

Exceptions

std::logic_error If the y offset along the I axis cannot be get.

Returns: The y offset along the I (fastest) axis.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

◆ getYIOffsetInGlobalCrs()

double resqml2::Grid2dRepresentation::getYIOffsetInGlobalCrs ( ) const

Gets the y offset along the I (fastest) axis. If the J spacing is constant, the returned offset is exactly the offset between two consecutive nodes lying on the J axis. If not, the offset length does not have any meaning. The y coordinate is given in the global CRS.

Exceptions

std::logic_error If the y offset along the I axis cannot be get.

Returns: The y offset along the I (fastest) axis.

◆ getYJOffset()

virtual double resqml2::Grid2dRepresentation::getYJOffset ( ) const

pure virtual

Gets the y offset along the J (slowest) axis. If the J spacing is constant, the returned offset is exactly the offset between two consecutive nodes lying on the J axis. If not, the offset length does not have any meaning. The y coordinate is given in the local CRS.

Exceptions

std::logic_error If the y offset along the J axis cannot be get.

Returns: The y offset along the J (slowest) axis.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

◆ getYJOffsetInGlobalCrs()

double resqml2::Grid2dRepresentation::getYJOffsetInGlobalCrs ( ) const

Gets the y offset along the J (slowest) axis. If the J spacing is constant, the returned offset is exactly the offset between two consecutive nodes lying on the J axis. If not, the offset length does not have any meaning. The y coordinate is given in the global CRS.

Exceptions

std::logic_error If the y offset along the J axis cannot be get.

Returns: The y offset along the J (slowest) axis.

◆ getYOrigin()

virtual double resqml2::Grid2dRepresentation::getYOrigin ( ) const

pure virtual

Gets the y coordinate of the origin of this 2d grid representation. The y coordinate is given in the local CRS.

Returns: NAN if the origin y coordinate cannot be get, the origin y coordinate otherwise.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

◆ getYOriginInGlobalCrs()

double resqml2::Grid2dRepresentation::getYOriginInGlobalCrs ( ) const

Gets the y coordinate of the origin of this 2d grid representation. The y coordinate is given in the global CRS.

Returns: NAN if the origin y coordinate cannot be get, the origin y coordinate otherwise.

◆ getZIOffset()

virtual double resqml2::Grid2dRepresentation::getZIOffset ( ) const

pure virtual

Gets the z offset along the I (fastest) axis. If the J spacing is constant, the returned offset is exactly the offset between two consecutive nodes lying on the J axis. If not, the offset length does not have any meaning. The z coordinate is given in the local CRS.

Exceptions

std::logic_error If the z offset along the I axis cannot be get.

Returns: The z offset along the I (fastest) axis.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

◆ getZIOffsetInGlobalCrs()

double resqml2::Grid2dRepresentation::getZIOffsetInGlobalCrs ( ) const

Gets the z offset along the I (fastest) axis. If the J spacing is constant, the returned offset is exactly the offset between two consecutive nodes lying on the J axis. If not, the offset length does not have any meaning. The z coordinate is given in the global CRS.

Exceptions

std::logic_error If the z offset along the I axis cannot be get.

Returns: The z offset along the I (fastest) axis.

◆ getZJOffset()

virtual double resqml2::Grid2dRepresentation::getZJOffset ( ) const

pure virtual

Gets the z offset along the J (slowest) axis. If the J spacing is constant, the returned offset is exactly the offset between two consecutive nodes lying on the J axis. If not, the offset length does not have any meaning. The z coordinate is given in the local CRS.

Exceptions

std::logic_error If the z offset along the J axis cannot be get.

Returns: The z offset along the J (slowest) axis.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

◆ getZJOffsetInGlobalCrs()

double resqml2::Grid2dRepresentation::getZJOffsetInGlobalCrs ( ) const

Gets the z offset along the J (slowest) axis. If the J spacing is constant, the returned offset is exactly the offset between two consecutive nodes lying on the J axis. If not, the offset length does not have any meaning. The z coordinate is given in the global CRS.

Exceptions

std::logic_error If the z offset along the J axis cannot be get.

Returns: The z offset along the J (slowest) axis.

◆ getZOrigin()

virtual double resqml2::Grid2dRepresentation::getZOrigin ( ) const

pure virtual

Gets the z coordinate of the origin of this 2d grid representation. The z coordinate is given in the local CRS.

Returns: NAN if the origin z coordinate cannot be get, the origin z coordinate otherwise.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

◆ getZOriginInGlobalCrs()

double resqml2::Grid2dRepresentation::getZOriginInGlobalCrs ( ) const

Gets the z coordinate of the origin of this 2d grid representation. The z coordinate is given in the global CRS.

Returns: NAN if the origin z coordinate cannot be get, the origin z coordinate otherwise.

◆ getZValues()

virtual void resqml2::Grid2dRepresentation::getZValues ( double * values ) const

pure virtual

Gets all the z values of this 2d grid representation. The z values are given in the local CRS.

Exceptions

std::logic_error If the z values cannot be get from this 2d grid representation.

Parameters

[out] values A preallocated array to receive the z values. Its size must be equal to getNodeCountAlongIAxis() * getNodeCountAlongJAxis() and it will not be freed by this method. The I dimension is the fastest.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

◆ getZValuesInGlobalCrs()

void resqml2::Grid2dRepresentation::getZValuesInGlobalCrs ( double * values ) const

Gets all the z values of this 2d grid representation. The z values are given in the global CRS.

Exceptions

std::logic_error If the z values cannot be get from this 2d grid representation.

Parameters

[out] values A preallocated array to receive the z values. Its size must be equal to getNodeCountAlongIAxis() * getNodeCountAlongJAxis() and it will not be freed by this method. The I dimension is the fastest.

◆ isISpacingConstant()

virtual bool resqml2::Grid2dRepresentation::isISpacingConstant ( ) const

pure virtual

Checks whether the spacing between nodes on I (fastest) dimension is constant or not.

Exceptions

std::logic_error If the J spacing cannot be get.

Returns: True if the J (fastest) spacing is constant, false if not.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

◆ isJSpacingConstant()

virtual bool resqml2::Grid2dRepresentation::isJSpacingConstant ( ) const

pure virtual

Checks whether the spacing between nodes on J (slowest) dimension is constant or not.

Exceptions

std::logic_error If the J spacing cannot be get.

Returns: True if the J (slowest) spacing is constant, false if not.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

◆ setGeometryAsArray2dOfExplicitZ() [1/2]

virtual void resqml2::Grid2dRepresentation::setGeometryAsArray2dOfExplicitZ	(	double *	zValues,
		unsigned int	numI,
		unsigned int	numJ,
		eml2::AbstractHdfProxy *	proxy,
		double	originX,
		double	originY,
		double	originZ,
		double	offsetIX,
		double	offsetIY,
		double	offsetIZ,
		double	spacingI,
		double	offsetJX,
		double	offsetJY,
		double	offsetJZ,
		double	spacingJ,
		resqml2::AbstractLocal3dCrs *	localCrs = `nullptr`
	)

pure virtual

Sets the geometry of this 2d grid representation. The set geometry is a 2d array of explicit z.

Exceptions

std::invalid_argument	If `proxy == nullptr` and no default HDF proxy is defined in the repository.
std::invalid_argument	If `localCrs == nullptr` and no default CRS is defined in the repository.

Parameters

[in]	zValues	An array of `numI * numJ` z values.
	numI	The number of points in the I (fastest) direction.
	numJ	The number of points in the J (slowest) direction.
[in,out]	proxy	The HDF proxy where to store the z values. If `nullptr`, the repository default HDF proxy will be used.
	originX	The origin x coordinate.
	originY	The origin y coordinate.
	originZ	The origin z coordinate.
	offsetIX	The x offset in the I (fastest) direction.
	offsetIY	The y offset in the I (fastest) direction.
	offsetIZ	The z offset in the I (fastest) direction.
	spacingI	The spacing in the I (fastest) direction.
	offsetJX	The x offset in the J (slowest) direction.
	offsetJY	The y offset in the J (slowest) direction.
	offsetJZ	The z offset in the J (slowest) direction.
	spacingJ	The spacing in the J (slowest) direction.
[in]	localCrs	(Optional) If non-null, the local CRS. If `nullptr` (default), the repository default local CRS will be used.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

◆ setGeometryAsArray2dOfExplicitZ() [2/2]

virtual void resqml2::Grid2dRepresentation::setGeometryAsArray2dOfExplicitZ	(	double *	zValues,
		unsigned int	numI,
		unsigned int	numJ,
		eml2::AbstractHdfProxy *	proxy,
		Grid2dRepresentation *	supportingGrid2dRepresentation,
		resqml2::AbstractLocal3dCrs *	localCrs = `nullptr`,
		unsigned int	startIndexI = `0`,
		unsigned int	startIndexJ = `0`,
		int	indexIncrementI = `1`,
		int	indexIncrementJ = `1`
	)

pure virtual

Sets the geometry of this 2d grid representation. The set geometry is a 2d array of explicit z based on an existing representation.

Exceptions

std::invalid_argument	If `proxy == nullptr` and no default HDF proxy is defined in the repository.
std::invalid_argument	If `supportingGrid2dRepresentation == nullptr`.
std::invalid_argument	If `localCrs == nullptr` and no default CRS is defined in the repository.

Parameters

[in]	zValues	An array of `numI * numJ` z values.
	numI	The number of points in the I (fastest) direction.
	numJ	The number of points in the J (slowest) direction.
[in,out]	proxy	The HDF proxy where to store the z values. If `nullptr`, the repository default HDF proxy will be used.
[in]	supportingGrid2dRepresentation	The supporting 2d grid representation.
[in]	localCrs	(Optional) If non-null, the local CRS. If `nullptr` (default), the repository default CRS will be used.
	startIndexI	(Optional) The start index in the I (fastest) direction. Default value is `0`.
	startIndexJ	(Optional) The start index in the J (slowest) direction. Default value is `0`.
	indexIncrementI	(Optional) The index increment in the I (fastest) direction. Default value is `1`.
	indexIncrementJ	(Optional) The index increment in the J (slowest) direction. Default value is `1`.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

◆ setGeometryAsArray2dOfLatticePoints3d()

virtual void resqml2::Grid2dRepresentation::setGeometryAsArray2dOfLatticePoints3d	(	unsigned int	numPointsInFastestDirection,
		unsigned int	numPointsInSlowestDirection,
		double	xOrigin,
		double	yOrigin,
		double	zOrigin,
		double	xOffsetInFastestDirection,
		double	yOffsetInFastestDirection,
		double	zOffsetInFastestDirection,
		double	xOffsetInSlowestDirection,
		double	yOffsetInSlowestDirection,
		double	zOffsetInSlowestDirection,
		double	spacingInFastestDirection,
		double	spacingInSlowestDirection,
		resqml2::AbstractLocal3dCrs *	localCrs = `nullptr`
	)

pure virtual

Sets the geometry of this 2d grid representation. The set geometry is a 2d array of 3d lattice points.

Exceptions

std::invalid_argument If localCrs == nullptr and no default CRS is defined in the repository.

Parameters

	numPointsInFastestDirection	The number of points in the fastest direction.
	numPointsInSlowestDirection	The number of points in the slowest direction.
	xOrigin	The origin x coordinate.
	yOrigin	The origin y coordinate.
	zOrigin	The origin z coordinate.
	xOffsetInFastestDirection	The x offset in the fastest direction.
	yOffsetInFastestDirection	The y offset in the fastest direction.
	zOffsetInFastestDirection	The z offset in the fastest direction.
	xOffsetInSlowestDirection	The x offset in the slowest direction.
	yOffsetInSlowestDirection	The y offset in the slowest direction.
	zOffsetInSlowestDirection	The z offset in the slowest direction.
	spacingInFastestDirection	The spacing in the fastest direction.
	spacingInSlowestDirection	The spacing in the slowest direction.
[in]	localCrs	(Optional) If non-null, the local CRS. If `nullptr` (default), the repository default CRS will be used.

Implemented in resqml2_2::Grid2dRepresentation, and resqml2_0_1::Grid2dRepresentation.

Member Data Documentation

◆ XML_TAG

const char* resqml2::Grid2dRepresentation::XML_TAG

static

The standard XML tag without 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/Grid2dRepresentation.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~Grid2dRepresentation()

Member Function Documentation

◆ getIndexOffsetOnSupportingRepresentation()

◆ getIndexOriginOnSupportingRepresentation() [1/2]

◆ getIndexOriginOnSupportingRepresentation() [2/2]

◆ getISpacing() [1/2]

◆ getISpacing() [2/2]

◆ getJSpacing() [1/2]

◆ getJSpacing() [2/2]

◆ getNodeCountAlongIAxis()

◆ getNodeCountAlongJAxis()

◆ getNodeCountOnSupportingRepresentation()

◆ getPatchCount()

◆ getSupportingRepresentation()

◆ getSupportingRepresentationDor()

◆ getXIOffset()

◆ getXIOffsetInGlobalCrs()

◆ getXJOffset()

◆ getXJOffsetInGlobalCrs()

◆ getXmlTag()

◆ getXOrigin()

◆ getXOriginInGlobalCrs()

◆ getXyzPointCountOfPatch()

◆ getXyzPointsOfPatch()

◆ getYIOffset()

◆ getYIOffsetInGlobalCrs()

◆ getYJOffset()

◆ getYJOffsetInGlobalCrs()

◆ getYOrigin()

◆ getYOriginInGlobalCrs()

◆ getZIOffset()

◆ getZIOffsetInGlobalCrs()

◆ getZJOffset()

◆ getZJOffsetInGlobalCrs()

◆ getZOrigin()

◆ getZOriginInGlobalCrs()

◆ getZValues()

◆ getZValuesInGlobalCrs()

◆ isISpacingConstant()

◆ isJSpacingConstant()

◆ setGeometryAsArray2dOfExplicitZ() [1/2]

◆ setGeometryAsArray2dOfExplicitZ() [2/2]

◆ setGeometryAsArray2dOfLatticePoints3d()

Member Data Documentation

◆ XML_TAG