diff options
| author | Even Rouault <even.rouault@mines-paris.org> | 2019-01-10 10:29:01 +0100 |
|---|---|---|
| committer | Kristian Evers <kristianevers@gmail.com> | 2019-01-10 10:29:01 +0100 |
| commit | 19dd0531886835b0012d179beb6f3e2ceb9b8983 (patch) | |
| tree | 08297432286bb6db8399e5db45eae33ee8685e8b /docs/source/development/reference | |
| parent | 763ff547aea5e1013b49254b62fc06060eccfaaf (diff) | |
| download | PROJ-19dd0531886835b0012d179beb6f3e2ceb9b8983.tar.gz PROJ-19dd0531886835b0012d179beb6f3e2ceb9b8983.zip | |
Doc: document interaction issues between objects create with proj_create() vs the ones of the C++ API (fixes #1213) (#1215)
Diffstat (limited to 'docs/source/development/reference')
| -rw-r--r-- | docs/source/development/reference/functions.rst | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/source/development/reference/functions.rst b/docs/source/development/reference/functions.rst index f1c20991..351d2ed3 100644 --- a/docs/source/development/reference/functions.rst +++ b/docs/source/development/reference/functions.rst @@ -22,6 +22,11 @@ Threading contexts Transformation setup ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +The objects returned by the functions defined in this section have minimal +interaction with the the functions of the +`C API for ISO-19111 functionality`_, and vice versa. See its introduction +paragraph for more details. + .. c:function:: PJ* proj_create(PJ_CONTEXT *ctx, const char *definition) Create a transformation object from a proj-string. @@ -574,6 +579,18 @@ Various C API for ISO-19111 functionality +++++++++++++++++++++++++++++++++ +The PJ* objects returned by :c:func:`proj_create_from_user_input`, +:c:func:`proj_create_from_wkt`, :c:func:`proj_create_from_proj_string`, +:c:func:`proj_create_from_database` and other functions +will have generally minimal interaction with the functions declared in the +previous sections (calling those functions on those objects +will either return an error or default/non-sensical values). The exception is +for ISO19111 objects of type CoordinateOperation that can be exported as a +valid PROJ pipeline. In this case, objects will work for example with +:c:func:`proj_trans_generic`. +Conversely, objects returned by :c:func:`proj_create` and :c:func:`proj_create_argv` will +return an error when used with functions of this section. + .. doxygengroup:: iso19111_functions :project: cpp_stuff :content-only: |