Fesapi  2.0.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Public Member Functions | Static Public Attributes | List of all members
resqml2_2::Grid2dRepresentation Class Referencefinal

#include <Grid2dRepresentation.h>

Inheritance diagram for resqml2_2::Grid2dRepresentation:
resqml2::Grid2dRepresentation resqml2::AbstractSurfaceRepresentation resqml2::AbstractRepresentation common::AbstractObject

Public Member Functions

 Grid2dRepresentation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 Grid2dRepresentation (resqml2::AbstractFeatureInterpretation *interp, const std::string &guid, const std::string &title)
 
 Grid2dRepresentation (gsoap_eml2_3::_resqml22__Grid2dRepresentation *fromGsoap)
 
 ~Grid2dRepresentation ()=default
 
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...
 
uint64_t getNodeCountAlongIAxis () const final
 
uint64_t getNodeCountAlongJAxis () const final
 
void getZValues (double *values) const final
 
double getXOrigin () const final
 
double getYOrigin () const final
 
double getZOrigin () const final
 
double getXJOffset () const final
 
double getYJOffset () const final
 
double getZJOffset () const final
 
double getXIOffset () const final
 
double getYIOffset () const final
 
double getZIOffset () const final
 
bool isJSpacingConstant () const final
 
bool isISpacingConstant () const final
 
double getJSpacing () const final
 
void getJSpacing (double *jSpacings) const final
 
double getISpacing () const final
 
void getISpacing (double *iSpacings) const final
 
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) final
 
void setGeometryAsArray2dOfExplicitZ (double *zValues, unsigned int numI, unsigned int numJ, eml2::AbstractHdfProxy *proxy, resqml2::Grid2dRepresentation *supportingGrid2dRepresentation, resqml2::AbstractLocal3dCrs *localCrs=nullptr, unsigned int startIndexI=0, unsigned int startIndexJ=0, int indexIncrementI=1, int indexIncrementJ=1) final
 
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) final
 
common::DataObjectReference getSupportingRepresentationDor () const final
 
int getIndexOriginOnSupportingRepresentation () const final
 
int getIndexOriginOnSupportingRepresentation (unsigned int dimension) const final
 
int getNodeCountOnSupportingRepresentation (unsigned int dimension) const final
 
int getIndexOffsetOnSupportingRepresentation (unsigned int dimension) const final
 Gets the index offset of the nodes of the current geometry on a particular dimension of the supporting representation. More...
 
std::string getXmlNamespace () const final
 
- Public Member Functions inherited from resqml2::Grid2dRepresentation
uint64_t getXyzPointCountOfPatch (unsigned int patchIndex) const final
 
void getXyzPointsOfPatch (unsigned int patchIndex, double *xyzPoints) const final
 
void getZValuesInGlobalCrs (double *values) const
 
double getXOriginInGlobalCrs () const
 
double getYOriginInGlobalCrs () const
 
double getZOriginInGlobalCrs () const
 
double getXJOffsetInGlobalCrs () const
 
double getYJOffsetInGlobalCrs () const
 
double getZJOffsetInGlobalCrs () const
 
double getXIOffsetInGlobalCrs () const
 
double getYIOffsetInGlobalCrs () const
 
double getZIOffsetInGlobalCrs () const
 
Grid2dRepresentationgetSupportingRepresentation () const
 
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 AbstractLocal3dCrsgetLocalCrs (unsigned int patchIndex) const
 
virtual common::DataObjectReference getLocalCrsDor (unsigned int patchIndex) const
 
std::vector< class AbstractProperty * > getPropertySet () const
 
void setInterpretation (class AbstractFeatureInterpretation *interp)
 
class AbstractFeatureInterpretationgetInterpretation () 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
 
AbstractRepresentationgetSeismicSupportOfPatch (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::DataObjectRepositorygetRepository () 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::ActivitygetActivity (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::Grid2dRepresentation
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() [1/3]

resqml2_2::Grid2dRepresentation::Grid2dRepresentation ( gsoap_resqml2_0_1::eml20__DataObjectReference *  partialObject)
inline

Only to be used in partial transfer context.

Parameters
[in]partialObjectIf non-nullptr, the partial object.

◆ Grid2dRepresentation() [2/3]

resqml2_2::Grid2dRepresentation::Grid2dRepresentation ( resqml2::AbstractFeatureInterpretation interp,
const std::string &  guid,
const std::string &  title 
)

Creates an instance of this class in a gSOAP context.

Exceptions
std::invalid_argumentIf interp == nullptr.
Parameters
[in]interpThe represented interpretation. It cannot be null.
guidThe guid to set to the 2d grid representation. If empty then a new guid will be generated.
titleThe title to set to the 2d grid representation. If empty then "unknown" title will be set.

◆ Grid2dRepresentation() [3/3]

resqml2_2::Grid2dRepresentation::Grid2dRepresentation ( gsoap_eml2_3::_resqml22__Grid2dRepresentation *  fromGsoap)
inline

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

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

◆ ~Grid2dRepresentation()

resqml2_2::Grid2dRepresentation::~Grid2dRepresentation ( )
virtualdefault

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

Reimplemented from resqml2::Grid2dRepresentation.

Member Function Documentation

◆ getHdfProxyDor()

common::DataObjectReference resqml2_2::Grid2dRepresentation::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_errorIf 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.

Implements resqml2::AbstractRepresentation.

◆ getIndexOffsetOnSupportingRepresentation()

int resqml2_2::Grid2dRepresentation::getIndexOffsetOnSupportingRepresentation ( unsigned int  dimension) const
finalvirtual

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

Exceptions
std::logic_errorIf no supporting representation is associated to this 2d grid representation.
std::out_of_rangeIf dimension is out of range.
Parameters
dimensionThe dimension for which we look for the index offset.
Returns
The index offset on the dimension dimension.

Implements resqml2::Grid2dRepresentation.

◆ getIndexOriginOnSupportingRepresentation() [1/2]

int resqml2_2::Grid2dRepresentation::getIndexOriginOnSupportingRepresentation ( ) const
finalvirtual

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_errorIf no supporting representation is associated to this 2d grid representation.
Returns
The index of the origin on the supporting representation.

Implements resqml2::Grid2dRepresentation.

◆ getIndexOriginOnSupportingRepresentation() [2/2]

int resqml2_2::Grid2dRepresentation::getIndexOriginOnSupportingRepresentation ( unsigned int  dimension) const
finalvirtual

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

Exceptions
std::logic_errorIf no supporting representation is associated to this 2d grid representation.
std::invalid_argumentIf dimension differs from 0 or 1.
Parameters
dimensionThe 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.

Implements resqml2::Grid2dRepresentation.

◆ getISpacing() [1/2]

double resqml2_2::Grid2dRepresentation::getISpacing ( ) const
finalvirtual

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

Exceptions
std::logic_errorIf the I spacing is not constant or cannot be get.
Returns
The constant I (fastest) spacing of this 2d grid representation.

Implements resqml2::Grid2dRepresentation.

◆ getISpacing() [2/2]

void resqml2_2::Grid2dRepresentation::getISpacing ( double *  iSpacings) const
finalvirtual

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

Exceptions
std::logic_errorIf the HDF proxy is missing of if the I spacings cannot be get.
Parameters
[out]iSpacingsA 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.

Implements resqml2::Grid2dRepresentation.

◆ getJSpacing() [1/2]

double resqml2_2::Grid2dRepresentation::getJSpacing ( ) const
finalvirtual

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

Exceptions
std::logic_errorIf the J spacing is not constant or cannot be get.
Returns
The constant J (slowest) spacing of this 2d grid representation.

Implements resqml2::Grid2dRepresentation.

◆ getJSpacing() [2/2]

void resqml2_2::Grid2dRepresentation::getJSpacing ( double *  jSpacings) const
finalvirtual

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

Exceptions
std::logic_errorIf the HDF proxy is missing of if the J spacings cannot be get.
Parameters
[out]jSpacingsA 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.

Implements resqml2::Grid2dRepresentation.

◆ getNodeCountAlongIAxis()

uint64_t resqml2_2::Grid2dRepresentation::getNodeCountAlongIAxis ( ) const
finalvirtual

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

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

Implements resqml2::Grid2dRepresentation.

◆ getNodeCountAlongJAxis()

uint64_t resqml2_2::Grid2dRepresentation::getNodeCountAlongJAxis ( ) const
finalvirtual

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

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

Implements resqml2::Grid2dRepresentation.

◆ getNodeCountOnSupportingRepresentation()

int resqml2_2::Grid2dRepresentation::getNodeCountOnSupportingRepresentation ( unsigned int  dimension) const
finalvirtual

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

Exceptions
std::logic_errorIf no supporting representation is associated to this 2d grid representation.
std::out_of_rangeIf dimension is out of range.
Parameters
dimensionThe dimension for which we look for the number of nodes.
Returns
The number of nodes on the dimension dimension.

Implements resqml2::Grid2dRepresentation.

◆ getSupportingRepresentationDor()

common::DataObjectReference resqml2_2::Grid2dRepresentation::getSupportingRepresentationDor ( ) const
finalvirtual

Gets the supporting representation data object reference.

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

Implements resqml2::Grid2dRepresentation.

◆ getXIOffset()

double resqml2_2::Grid2dRepresentation::getXIOffset ( ) const
finalvirtual

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_errorIf the x offset along the I axis cannot be get.
Returns
The x offset along the I (fastest) axis.

Implements resqml2::Grid2dRepresentation.

◆ getXJOffset()

double resqml2_2::Grid2dRepresentation::getXJOffset ( ) const
finalvirtual

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_errorIf the x offset along the J axis cannot be get.
Returns
The x offset along the J (slowest) axis.

Implements resqml2::Grid2dRepresentation.

◆ getXmlNamespace()

std::string resqml2_2::Grid2dRepresentation::getXmlNamespace ( ) const
inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ getXOrigin()

double resqml2_2::Grid2dRepresentation::getXOrigin ( ) const
finalvirtual

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.

Implements resqml2::Grid2dRepresentation.

◆ getYIOffset()

double resqml2_2::Grid2dRepresentation::getYIOffset ( ) const
finalvirtual

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_errorIf the y offset along the I axis cannot be get.
Returns
The y offset along the I (fastest) axis.

Implements resqml2::Grid2dRepresentation.

◆ getYJOffset()

double resqml2_2::Grid2dRepresentation::getYJOffset ( ) const
finalvirtual

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_errorIf the y offset along the J axis cannot be get.
Returns
The y offset along the J (slowest) axis.

Implements resqml2::Grid2dRepresentation.

◆ getYOrigin()

double resqml2_2::Grid2dRepresentation::getYOrigin ( ) const
finalvirtual

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.

Implements resqml2::Grid2dRepresentation.

◆ getZIOffset()

double resqml2_2::Grid2dRepresentation::getZIOffset ( ) const
finalvirtual

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_errorIf the z offset along the I axis cannot be get.
Returns
The z offset along the I (fastest) axis.

Implements resqml2::Grid2dRepresentation.

◆ getZJOffset()

double resqml2_2::Grid2dRepresentation::getZJOffset ( ) const
finalvirtual

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_errorIf the z offset along the J axis cannot be get.
Returns
The z offset along the J (slowest) axis.

Implements resqml2::Grid2dRepresentation.

◆ getZOrigin()

double resqml2_2::Grid2dRepresentation::getZOrigin ( ) const
finalvirtual

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.

Implements resqml2::Grid2dRepresentation.

◆ getZValues()

void resqml2_2::Grid2dRepresentation::getZValues ( double *  values) const
finalvirtual

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

Exceptions
std::logic_errorIf the z values cannot be get from this 2d grid representation.
Parameters
[out]valuesA 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.

Implements resqml2::Grid2dRepresentation.

◆ isISpacingConstant()

bool resqml2_2::Grid2dRepresentation::isISpacingConstant ( ) const
finalvirtual

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

Exceptions
std::logic_errorIf the J spacing cannot be get.
Returns
True if the J (fastest) spacing is constant, false if not.

Implements resqml2::Grid2dRepresentation.

◆ isJSpacingConstant()

bool resqml2_2::Grid2dRepresentation::isJSpacingConstant ( ) const
finalvirtual

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

Exceptions
std::logic_errorIf the J spacing cannot be get.
Returns
True if the J (slowest) spacing is constant, false if not.

Implements resqml2::Grid2dRepresentation.

◆ setGeometryAsArray2dOfExplicitZ() [1/2]

void resqml2_2::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 
)
finalvirtual

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

Exceptions
std::invalid_argumentIf proxy == nullptr and no default HDF proxy is defined in the repository.
std::invalid_argumentIf localCrs == nullptr and no default CRS is defined in the repository.
Parameters
[in]zValuesAn array of numI * numJ z values.
numIThe number of points in the I (fastest) direction.
numJThe number of points in the J (slowest) direction.
[in,out]proxyThe HDF proxy where to store the z values. If nullptr, the repository default HDF proxy will be used.
originXThe origin x coordinate.
originYThe origin y coordinate.
originZThe origin z coordinate.
offsetIXThe x offset in the I (fastest) direction.
offsetIYThe y offset in the I (fastest) direction.
offsetIZThe z offset in the I (fastest) direction.
spacingIThe spacing in the I (fastest) direction.
offsetJXThe x offset in the J (slowest) direction.
offsetJYThe y offset in the J (slowest) direction.
offsetJZThe z offset in the J (slowest) direction.
spacingJThe 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.

Implements resqml2::Grid2dRepresentation.

◆ setGeometryAsArray2dOfExplicitZ() [2/2]

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

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_argumentIf proxy == nullptr and no default HDF proxy is defined in the repository.
std::invalid_argumentIf supportingGrid2dRepresentation == nullptr.
std::invalid_argumentIf localCrs == nullptr and no default CRS is defined in the repository.
Parameters
[in]zValuesAn array of numI * numJ z values.
numIThe number of points in the I (fastest) direction.
numJThe number of points in the J (slowest) direction.
[in,out]proxyThe HDF proxy where to store the z values. If nullptr, the repository default HDF proxy will be used.
[in]supportingGrid2dRepresentationThe 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.

Implements resqml2::Grid2dRepresentation.

◆ setGeometryAsArray2dOfLatticePoints3d()

void resqml2_2::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 
)
finalvirtual

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

Exceptions
std::invalid_argumentIf localCrs == nullptr and no default CRS is defined in the repository.
Parameters
numPointsInFastestDirectionThe number of points in the fastest direction.
numPointsInSlowestDirectionThe number of points in the slowest direction.
xOriginThe origin x coordinate.
yOriginThe origin y coordinate.
zOriginThe origin z coordinate.
xOffsetInFastestDirectionThe x offset in the fastest direction.
yOffsetInFastestDirectionThe y offset in the fastest direction.
zOffsetInFastestDirectionThe z offset in the fastest direction.
xOffsetInSlowestDirectionThe x offset in the slowest direction.
yOffsetInSlowestDirectionThe y offset in the slowest direction.
zOffsetInSlowestDirectionThe z offset in the slowest direction.
spacingInFastestDirectionThe spacing in the fastest direction.
spacingInSlowestDirectionThe spacing in the slowest direction.
[in]localCrs(Optional) If non-null, the local CRS. If nullptr (default), the repository default CRS will be used.

Implements resqml2::Grid2dRepresentation.

Member Data Documentation

◆ XML_NS

const char* resqml2_2::Grid2dRepresentation::XML_NS
static

The standard XML namespace for serializing this data object.


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