From 54b861e14051a337d473c95389ff7f34c6ee83a8 Mon Sep 17 00:00:00 2001 From: Even Rouault Date: Tue, 15 Dec 2020 00:51:44 +0100 Subject: Doc: document error codes and proj_context_errno_string() --- docs/source/development/reference/functions.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'docs/source/development/reference/functions.rst') diff --git a/docs/source/development/reference/functions.rst b/docs/source/development/reference/functions.rst index b37eacdd..5b559d55 100644 --- a/docs/source/development/reference/functions.rst +++ b/docs/source/development/reference/functions.rst @@ -388,6 +388,8 @@ Error reporting context is read. A text representation of the error number can be retrieved with :c:func:`proj_errno_string`. + Consult :ref:`error_codes` for the list of error codes (PROJ >= 8.0) + :param P: Transformation object :type P: :c:type:`PJ` * @@ -400,6 +402,8 @@ Error reporting transformation. A text representation of the error number can be retrieved with :c:func:`proj_errno_string`. + Consult :ref:`error_codes` for the list of error codes (PROJ >= 8.0) + :param ctx: threading context. :type ctx: :c:type:`PJ_CONTEXT` * @@ -464,6 +468,22 @@ Error reporting Get a text representation of an error number. + .. deprecated:: This function is potentially thread-unsafe, replaced by :c:func:`proj_context_errno_string`. + + :param err: Error number. + :type err: `int` + + :returns: `const char*` String with description of error. + +.. c:function:: const char* proj_context_errno_string(PJ_CONTEXT* ctx, int err) + + .. versionadded:: 8.0.0 + + Get a text representation of an error number. + + :param ctx: threading context. + :type ctx: :c:type:`PJ_CONTEXT` * + :param err: Error number. :type err: `int` -- cgit v1.2.3 From 1d803550e7059729cf2734fc6190993e8b8404bf Mon Sep 17 00:00:00 2001 From: Even Rouault Date: Tue, 15 Dec 2020 01:12:58 +0100 Subject: proj_trans_array(): make it transform all coordinates even when an error occurs --- docs/source/development/reference/functions.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) (limited to 'docs/source/development/reference/functions.rst') diff --git a/docs/source/development/reference/functions.rst b/docs/source/development/reference/functions.rst index 5b559d55..08b3e669 100644 --- a/docs/source/development/reference/functions.rst +++ b/docs/source/development/reference/functions.rst @@ -368,13 +368,22 @@ Coordinate transformation Batch transform an array of :c:type:`PJ_COORD`. + Performs transformation on all points, even if errors occur on some points + (new to 8.0. Previous versions would exit early in case of failure on a given point) + + Individual points that fail to transform will have their components set to + ``HUGE_VAL`` + :param P: Transformation object :type P: :c:type:`PJ` * :param `direction`: Transformation direction. :type `direction`: PJ_DIRECTION :param n: Number of coordinates in :c:data:`coord` :type n: `size_t` - :returns: `int` 0 if all observations are transformed without error, otherwise returns error number + :returns: `int` 0 if all observations are transformed without error, otherwise returns error number. + This error number will be a precise error number if all coordinates that fail to transform + for the same reason, or a generic error code if they fail for different + reasons. Error reporting -- cgit v1.2.3 From 37755e4edc53e09286cd2bb962299d0f5118fc77 Mon Sep 17 00:00:00 2001 From: Even Rouault Date: Tue, 15 Dec 2020 18:30:50 +0100 Subject: proj_create_crs_to_crs_from_pj(): add ACCURACY and ALLOW_BALLPARK options --- docs/source/development/reference/functions.rst | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'docs/source/development/reference/functions.rst') diff --git a/docs/source/development/reference/functions.rst b/docs/source/development/reference/functions.rst index 08b3e669..34fe59ed 100644 --- a/docs/source/development/reference/functions.rst +++ b/docs/source/development/reference/functions.rst @@ -195,6 +195,11 @@ paragraph for more details. If authority is a non-empty string different of ``any``, then coordinate operations will be searched only in that authority namespace (e.g ``EPSG``). + - ACCURACY=value: to set the minimum desired accuracy (in metres) of the + candidate coordinate operations. + + - ALLOW_BALLPARK=YES/NO: can be set to NO to disallow the use of + :term:`Ballpark transformation` in the candidate coordinate operations. .. doxygenfunction:: proj_normalize_for_visualization :project: doxygen_api -- cgit v1.2.3