Renames getElementCountPerValue to getValueCountPerIndexableElement

Replaces unsigned int patchIndex parameters with uint64_t for consistency with RESQML schema datatype.

Author: philippeVerney

NOTICE

@@ -1,4 +1,4 @@
-   Copyright 2018 F2I-CONSULTING
+   Copyright 2018-2025 F2I-CONSULTING
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

example/example.cpp

@@ -2709,7 +2709,7 @@ void showAllProperties(RESQML2_NS::AbstractRepresentation const * rep, bool* ena
 				std::cout << "\tFirst value is " << values[0] << endl;
 				std::cout << "\tSecond value is " << values[1] << endl;
 
-				if (continuousProp->getElementCountPerValue() == 1) {
+				if (continuousProp->getValueCountPerIndexableElement() == 1) {
 					for (size_t cellIndex = 0; cellIndex < valueCount; ++cellIndex) {
 						if (enabledCells != nullptr && !enabledCells[cellIndex]) {
 							continue;

src/resqml2/AbstractIjkGridRepresentation.cpp

@@ -1346,7 +1346,7 @@ void AbstractIjkGridRepresentation::getXyzPointsOfBlock(double *)
 	throw std::logic_error("Partial object");
 }
 
-uint64_t AbstractIjkGridRepresentation::getXyzPointCountOfPatch(unsigned int) const
+uint64_t AbstractIjkGridRepresentation::getXyzPointCountOfPatch(uint64_t) const
 {
 	const uint64_t result = getXyzPointCountOfKInterface() * (getKCellCount() + 1 + getKGapsCount()) + getSplitNodeCount();
 
@@ -1364,7 +1364,7 @@ uint64_t AbstractIjkGridRepresentation::getXyzPointCountOfPatch(unsigned int) co
 	throw std::logic_error("The IJK Grid is in an unknown Energistics standard version.");
 }
 
-void AbstractIjkGridRepresentation::getXyzPointsOfPatch(unsigned int, double *) const
+void AbstractIjkGridRepresentation::getXyzPointsOfPatch(uint64_t, double *) const
 {
 	throw std::logic_error("Partial object");
 }

src/resqml2/AbstractIjkGridRepresentation.h

@@ -758,7 +758,7 @@ namespace RESQML2_NS
 
 		virtual COMMON_NS::DataObjectReference getHdfProxyDor() const override { throw std::logic_error("Partial object"); }
 
-		DLL_IMPORT_OR_EXPORT virtual uint64_t getXyzPointCountOfPatch(unsigned int patchIndex) const override;
+		DLL_IMPORT_OR_EXPORT virtual uint64_t getXyzPointCountOfPatch(uint64_t patchIndex) const override;
 
 		/**
 		* @copybrief AbstractRepresentation::getXyzPointsOfPatch
@@ -770,7 +770,7 @@ namespace RESQML2_NS
 		* 					with a count of <tt>((iCellCount+1) * (jCellCount+1) + splitCoordinateLineCount)</tt>
 		* 					<tt> * kCellCount.</tt>
 		*/
-		DLL_IMPORT_OR_EXPORT virtual void getXyzPointsOfPatch(unsigned int patchIndex, double * xyzPoints) const override;
+		DLL_IMPORT_OR_EXPORT virtual void getXyzPointsOfPatch(uint64_t patchIndex, double * xyzPoints) const override;
 
 		/** The standard XML tag without XML namespace for serializing this data object. */
 		DLL_IMPORT_OR_EXPORT static constexpr char const* XML_TAG = "IjkGridRepresentation";

src/resqml2/AbstractProperty.cpp

@@ -57,7 +57,7 @@ void AbstractProperty::loadTargetRelationships()
 		convertDorIntoRel<EML2_NS::PropertyKind>(dor);
 	}
 
-	for (unsigned int patchIndex = 0; patchIndex < getPatchCount(); ++patchIndex) {
+	for (uint64_t patchIndex = 0; patchIndex < getPatchCount(); ++patchIndex) {
 		dor = getHdfProxyDor(patchIndex);
 		if (!dor.isEmpty()) {
 			convertDorIntoRel(dor);
@@ -233,7 +233,7 @@ bool AbstractProperty::useInterval() const
 	throw logic_error("Not implemented yet");
 }
 
-uint64_t AbstractProperty::getElementCountPerValue() const
+uint64_t AbstractProperty::getValueCountPerIndexableElement() const
 {
 	uint64_t result;
 	if (gsoapProxy2_0_1 != nullptr) {

src/resqml2/AbstractProperty.h

@@ -68,13 +68,13 @@ namespace RESQML2_NS
 		DLL_IMPORT_OR_EXPORT AbstractRepresentation* getRepresentation() const;
 
 		/**
-		 * Gets the count of elements per property value. If the property is a scalar one then it should
+		 * Gets the count of values per indexable element. If the property is a scalar one then it should
 		 * be one. If it is a vectorial one, then it should be more than one. It is not possible to have
 		 * some tensor property values (more dimensions than a vector)
 		 *
-		 * @returns	The element count per value.
+		 * @returns	The value count per indexable element.
 		 */
-		DLL_IMPORT_OR_EXPORT uint64_t getElementCountPerValue() const;
+		DLL_IMPORT_OR_EXPORT uint64_t getValueCountPerIndexableElement() const;
 
 		/**
 		 * Gets the kind of elements on which the property values are attached to

src/resqml2/AbstractRepresentation.cpp

@@ -76,7 +76,7 @@ COMMON_NS::DataObjectReference AbstractRepresentation::getHdfProxyDorFromPointGe
 	return COMMON_NS::DataObjectReference();
 }
 
-gsoap_resqml2_0_1::resqml20__Seismic3dCoordinates* AbstractRepresentation::getSeismic3dCoordinates2_0_1(unsigned int patchIndex) const
+gsoap_resqml2_0_1::resqml20__Seismic3dCoordinates* AbstractRepresentation::getSeismic3dCoordinates2_0_1(uint64_t patchIndex) const
 {
 	gsoap_resqml2_0_1::resqml20__PointGeometry* const geom = getPointGeometry2_0_1(patchIndex);
 	if (geom == nullptr) {
@@ -90,7 +90,7 @@ gsoap_resqml2_0_1::resqml20__Seismic3dCoordinates* AbstractRepresentation::getSe
 	return nullptr;
 }
 
-gsoap_eml2_3::resqml22__Seismic3dCoordinates* AbstractRepresentation::getSeismic3dCoordinates2_2(unsigned int patchIndex) const
+gsoap_eml2_3::resqml22__Seismic3dCoordinates* AbstractRepresentation::getSeismic3dCoordinates2_2(uint64_t patchIndex) const
 {
 	gsoap_eml2_3::resqml22__PointGeometry* const geom = getPointGeometry2_2(patchIndex);
 	if (geom == nullptr) {
@@ -401,7 +401,7 @@ uint64_t AbstractRepresentation::getXyzPointCountOfAllPatches() const
 	return result;
 }
 
-void AbstractRepresentation::getXyzPointsOfPatchInGlobalCrs(unsigned int patchIndex, double* xyzPoints) const
+void AbstractRepresentation::getXyzPointsOfPatchInGlobalCrs(uint64_t patchIndex, double* xyzPoints) const
 {
 	if (getLocalCrs(patchIndex)->isPartial()) {
 		throw invalid_argument("You cannot get the points in the global CRS if the local CRS is partial");
@@ -476,7 +476,7 @@ void AbstractRepresentation::getXyzPointsOfAllPatchesInGlobalCrs(double* xyzPoin
 	getLocalCrs(0)->convertXyzPointsToGlobalCrs(xyzPoints, getXyzPointCountOfAllPatches());
 }
 
-AbstractRepresentation* AbstractRepresentation::getSeismicSupportOfPatch(const unsigned int& patchIndex) const
+AbstractRepresentation* AbstractRepresentation::getSeismicSupportOfPatch(uint64_t patchIndex) const
 {
 	if (patchIndex >= getPatchCount()) {
 		throw out_of_range("The seismic support of the patch at the specified index is out of range.");
@@ -539,7 +539,7 @@ void AbstractRepresentation::loadTargetRelationships()
 	}
 
 	// CRS
-	for (unsigned int patchIndex = 0; patchIndex < getPatchCount(); ++patchIndex) {
+	for (uint64_t patchIndex = 0; patchIndex < getPatchCount(); ++patchIndex) {
 		dor = getLocalCrsDor(patchIndex);
 		if (!dor.isEmpty()) {
 			convertDorIntoRel<EML2_NS::AbstractLocal3dCrs>(dor);
@@ -591,7 +591,7 @@ void AbstractRepresentation::loadTargetRelationships()
 	}
 }
 
-void AbstractRepresentation::addSeismic3dCoordinatesToPatch(unsigned int patchIndex, double* inlines, double* crosslines, uint64_t pointCount,
+void AbstractRepresentation::addSeismic3dCoordinatesToPatch(uint64_t patchIndex, double* inlines, double* crosslines, uint64_t pointCount,
 	RESQML2_NS::AbstractRepresentation* seismicSupport, EML2_NS::AbstractHdfProxy* proxy)
 {
 	if (gsoapProxy2_0_1 != nullptr || gsoapProxy2_3 != nullptr) {
@@ -677,7 +677,7 @@ void AbstractRepresentation::addSeismic3dCoordinatesToPatch(unsigned int patchIn
 	}
 }
 
-void AbstractRepresentation::addSeismic3dCoordinatesToPatch(unsigned int patchIndex, double startInline, double incrInline, unsigned int countInline,
+void AbstractRepresentation::addSeismic3dCoordinatesToPatch(uint64_t patchIndex, double startInline, double incrInline, unsigned int countInline,
 	double startCrossline, double incrCrossline, unsigned int countCrossline, RESQML2_NS::AbstractRepresentation* seismicSupport)
 {
 	if (gsoapProxy2_0_1 != nullptr) {
@@ -759,7 +759,7 @@ void AbstractRepresentation::addSeismic3dCoordinatesToPatch(unsigned int patchIn
 	}
 }
 
-void AbstractRepresentation::addSeismic2dCoordinatesToPatch(unsigned int patchIndex, double* lineAbscissa,
+void AbstractRepresentation::addSeismic2dCoordinatesToPatch(uint64_t patchIndex, double* lineAbscissa,
 	RESQML2_NS::AbstractRepresentation* seismicSupport, EML2_NS::AbstractHdfProxy* proxy)
 {
 	if (gsoapProxy2_0_1 != nullptr || gsoapProxy2_3 != nullptr) {
@@ -825,7 +825,7 @@ void AbstractRepresentation::addSeismic2dCoordinatesToPatch(unsigned int patchIn
 	}
 }
 
-void AbstractRepresentation::getSeismicLineAbscissaOfPointsOfPatch(unsigned int patchIndex, double* values) const
+void AbstractRepresentation::getSeismicLineAbscissaOfPointsOfPatch(uint64_t patchIndex, double* values) const
 {
 	if (gsoapProxy2_0_1 != nullptr) {
 		gsoap_resqml2_0_1::resqml20__PointGeometry* const geom = getPointGeometry2_0_1(patchIndex);
@@ -852,7 +852,7 @@ void AbstractRepresentation::getSeismicLineAbscissaOfPointsOfPatch(unsigned int
 	}
 }
 
-void AbstractRepresentation::getInlinesOfPointsOfPatch(unsigned int patchIndex, double* values) const
+void AbstractRepresentation::getInlinesOfPointsOfPatch(uint64_t patchIndex, double* values) const
 {
 	if (gsoapProxy2_0_1 != nullptr) {
 		gsoap_resqml2_0_1::resqml20__Seismic3dCoordinates* seisInfo = getSeismic3dCoordinates2_0_1(patchIndex);
@@ -881,7 +881,7 @@ void AbstractRepresentation::getInlinesOfPointsOfPatch(unsigned int patchIndex,
 	}
 }
 
-void AbstractRepresentation::getCrosslinesOfPointsOfPatch(unsigned int patchIndex, double* values) const
+void AbstractRepresentation::getCrosslinesOfPointsOfPatch(uint64_t patchIndex, double* values) const
 {
 	if (gsoapProxy2_0_1 != nullptr) {
 		gsoap_resqml2_0_1::resqml20__Seismic3dCoordinates* seisInfo = getSeismic3dCoordinates2_0_1(patchIndex);

src/resqml2/AbstractRepresentation.h

@@ -162,7 +162,7 @@ namespace RESQML2_NS
 		 *
 		 * @returns	The xyz point count of the patch at position @p patchIndex.
 		 */
-		DLL_IMPORT_OR_EXPORT virtual uint64_t getXyzPointCountOfPatch(unsigned int patchIndex) const = 0;
+		DLL_IMPORT_OR_EXPORT virtual uint64_t getXyzPointCountOfPatch(uint64_t patchIndex) const = 0;
 
 		/**
 		 * Get the xyz point count of all patches of this representation.
@@ -184,7 +184,7 @@ namespace RESQML2_NS
 		 * 							dimension. It must be preallocated with a size of <tt>3 *
 		 * 							getXyzPointCountOfPatch(patchIndex)</tt>.
 		 */
-		DLL_IMPORT_OR_EXPORT virtual void getXyzPointsOfPatch(unsigned int patchIndex, double * xyzPoints) const = 0;
+		DLL_IMPORT_OR_EXPORT virtual void getXyzPointsOfPatch(uint64_t patchIndex, double * xyzPoints) const = 0;
 
 		/**
 		 * @brief Gets all the xyz points of a particular patch of this representation. xyz points are given in
@@ -198,7 +198,7 @@ namespace RESQML2_NS
 		 * 							dimension. It must be preallocated with a size of <tt>3 *
 		 * 							getXyzPointCountOfPatch(patchIndex)</tt>.
 		 */
-		DLL_IMPORT_OR_EXPORT void getXyzPointsOfPatchInGlobalCrs(unsigned int patchIndex, double * xyzPoints) const;
+		DLL_IMPORT_OR_EXPORT void getXyzPointsOfPatchInGlobalCrs(uint64_t patchIndex, double * xyzPoints) const;
 
 		/**
 		 * @brief Gets all the xyz points of all patches of this representation. xyz points are given in the
@@ -248,7 +248,7 @@ namespace RESQML2_NS
 		 * @returns	Null if no seismic information have been provided for the patch at position @p
 		 * 			patchIndex. Else, its seismic support.
 		 */
-		DLL_IMPORT_OR_EXPORT AbstractRepresentation* getSeismicSupportOfPatch(const unsigned int & patchIndex) const;
+		DLL_IMPORT_OR_EXPORT AbstractRepresentation* getSeismicSupportOfPatch(uint64_t patchIndex) const;
 
 		/**
 		 * Gets all seismic supports of the current geometry of this representation (that is to say the
@@ -299,7 +299,7 @@ namespace RESQML2_NS
 		 * 									values. It must be already opened for writing and won't be
 		 * 									closed in this method.
 		 */
-		DLL_IMPORT_OR_EXPORT void addSeismic3dCoordinatesToPatch(unsigned int patchIndex, double* inlines, double* crosslines, uint64_t pointCount,
+		DLL_IMPORT_OR_EXPORT void addSeismic3dCoordinatesToPatch(uint64_t patchIndex, double* inlines, double* crosslines, uint64_t pointCount,
 			RESQML2_NS::AbstractRepresentation* seismicSupport, EML2_NS::AbstractHdfProxy* proxy);
 
 		/**
@@ -320,7 +320,7 @@ namespace RESQML2_NS
 		 * @param 	  	countCrossline	The crossline count.
 		 * @param [in]	seismicSupport	The representation of the seismic line.
 		 */
-		DLL_IMPORT_OR_EXPORT void addSeismic3dCoordinatesToPatch(unsigned int patchIndex, double startInline, double incrInline, unsigned int countInline,
+		DLL_IMPORT_OR_EXPORT void addSeismic3dCoordinatesToPatch(uint64_t patchIndex, double startInline, double incrInline, unsigned int countInline,
 			double startCrossline, double incrCrossline, unsigned int countCrossline,
 			RESQML2_NS::AbstractRepresentation* seismicSupport);
 
@@ -342,7 +342,7 @@ namespace RESQML2_NS
 		 * 									must be already opened for writing and won't be closed in
 		 * 									this method.
 		 */
-		DLL_IMPORT_OR_EXPORT void addSeismic2dCoordinatesToPatch(unsigned int patchIndex, double* lineAbscissa,
+		DLL_IMPORT_OR_EXPORT void addSeismic2dCoordinatesToPatch(uint64_t patchIndex, double* lineAbscissa,
 			RESQML2_NS::AbstractRepresentation * seismicSupport, EML2_NS::AbstractHdfProxy * proxy);
 
 		/**
@@ -356,7 +356,7 @@ namespace RESQML2_NS
 		 * @param [out]	values	  	The array where the abscissa are going to be stored. The count of
 		 * 							this array must be equal to <tt>getXyzPointCountOfPatch(patchIndex)</tt>.
 		 */
-		DLL_IMPORT_OR_EXPORT void getSeismicLineAbscissaOfPointsOfPatch(unsigned int patchIndex, double* values) const;
+		DLL_IMPORT_OR_EXPORT void getSeismicLineAbscissaOfPointsOfPatch(uint64_t patchIndex, double* values) const;
 
 		/**
 		 * Gets all the inline coordinates of the points of a specific patch related to seismic lattice.
@@ -370,7 +370,7 @@ namespace RESQML2_NS
 		 * 							count of this array must be equal to
 		 * 							<tt>getXyzPointCountOfPatch(patchIndex)</tt>.
 		 */
-		DLL_IMPORT_OR_EXPORT void getInlinesOfPointsOfPatch(unsigned int patchIndex, double * values) const;
+		DLL_IMPORT_OR_EXPORT void getInlinesOfPointsOfPatch(uint64_t patchIndex, double * values) const;
 
 		/**
 		 * Gets all the crossline coordinates of the points of a specific patch related to seismic
@@ -385,7 +385,7 @@ namespace RESQML2_NS
 		 * 							count of this array must be equal to
 		 * 							<tt>getXyzPointCountOfPatch(patchIndex)</tt>.
 		 */
-		DLL_IMPORT_OR_EXPORT void getCrosslinesOfPointsOfPatch(unsigned int patchIndex, double * values) const;
+		DLL_IMPORT_OR_EXPORT void getCrosslinesOfPointsOfPatch(uint64_t patchIndex, double * values) const;
 
 		/** The standard XML tag without XML namespace for serializing this data object */
 		static constexpr char const* XML_TAG = "AbstractRepresentation";
@@ -505,7 +505,7 @@ namespace RESQML2_NS
 		 *
 		 * @returns	Null if it fails, else the seismic 3D coordinates.
 		 */
-		gsoap_resqml2_0_1::resqml20__Seismic3dCoordinates* getSeismic3dCoordinates2_0_1(unsigned int patchIndex) const;
+		gsoap_resqml2_0_1::resqml20__Seismic3dCoordinates* getSeismic3dCoordinates2_0_1(uint64_t patchIndex) const;
 
 		/**
 		 * Gets seismic 3D coordinates
@@ -514,6 +514,6 @@ namespace RESQML2_NS
 		 *
 		 * @returns	Null if it fails, else the seismic 3D coordinates.
 		 */
-		gsoap_eml2_3::resqml22__Seismic3dCoordinates* getSeismic3dCoordinates2_2(unsigned int patchIndex) const;
+		gsoap_eml2_3::resqml22__Seismic3dCoordinates* getSeismic3dCoordinates2_2(uint64_t patchIndex) const;
 	};
 }

src/resqml2/AbstractValuesProperty.h

@@ -297,7 +297,7 @@ namespace RESQML2_NS
 			}
 
 			if (forceStatisticsComputation) {
-				return COMMON_NS::NumberArrayStatistics<T>(values, getValuesCountOfPatch(patchIndex), getElementCountPerValue(), nullValue);
+				return COMMON_NS::NumberArrayStatistics<T>(values, getValuesCountOfPatch(patchIndex), getValueCountPerIndexableElement(), nullValue);
 			}
 
 			return getStatistics<T>(patchIndex);
@@ -1908,7 +1908,7 @@ namespace RESQML2_NS
 				}
 			}
 			else if (gsoapProxy2_3 != nullptr) {
-				const auto valuePerIndexableElement = getElementCountPerValue();
+				const auto valuePerIndexableElement = getValueCountPerIndexableElement();
 				gsoap_eml2_3::resqml22__AbstractValuesProperty* prop = static_cast<gsoap_eml2_3::resqml22__AbstractValuesProperty*>(gsoapProxy2_3);
 				if (auto* integerArray = dynamic_cast<gsoap_eml2_3::eml23__AbstractIntegerArray*>(prop->ValuesForPatch.at(patchIndex))) {
 					if constexpr (std::is_integral_v<T>) {

src/resqml2/CommentProperty.cpp

@@ -73,7 +73,7 @@ void CommentProperty::pushBackStringHdf5ArrayOfValues(const std::vector<std::str
 	const string datasetName = pushBackRefToExistingDataset(proxy, getHdfGroup() + "/values_patch" + std::to_string(getPatchCount()));
 }
 
-std::vector<std::string> CommentProperty::getStringValuesOfPatch(unsigned int patchIndex)
+std::vector<std::string> CommentProperty::getStringValuesOfPatch(uint64_t patchIndex)
 {	
 	std::vector<std::string> result;