You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Change product name and add info on stream layer (#860)
* Change product name in documentation.
* Specify that we support reading data from a stream layer.
* Modify broken links.
Relates-To: OLPEDGE-1867
Signed-off-by: Halyna Dumych <[email protected]>
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
-
# HERE OLP SDK for C++ Contributor Guide
1
+
# HERE Data SDK for C++ Contributor Guide
2
2
3
-
## Contributing to HERE OLP SDK for C++
3
+
## Contributing to HERE Data SDK for C++
4
4
5
-
First off, thanks for taking the time to contribute! The team behind the [HERE OLP SDK for C++](https://github.com/heremaps/here-data-sdk-cpp) gratefully accepts contributions via [pull requests](https://help.github.com/articles/about-pull-requests/) filed against the [GitHub project](https://github.com/heremaps/here-data-sdk-cpp/pulls). As part of filing a pull request, we ask you to sign off the [Developer Certificate of Origin](https://developercertificate.org/) (DCO).
5
+
First off, thanks for taking the time to contribute! The team behind the [HERE Data SDK for C++](https://github.com/heremaps/here-data-sdk-cpp) gratefully accepts contributions via [pull requests](https://help.github.com/articles/about-pull-requests/) filed against the [GitHub project](https://github.com/heremaps/here-data-sdk-cpp/pulls). As part of filing a pull request, we ask you to sign off the [Developer Certificate of Origin](https://developercertificate.org/) (DCO).
6
6
7
7
## Development
8
8
@@ -318,7 +318,7 @@ Example:
318
318
```cpp
319
319
/**
320
320
* @brief Provides a high-level interface to access data hosted on `OLP` using
321
-
* the HERE Open Location Platform (OLP) Data API.
321
+
* the Data API.
322
322
*
323
323
* The behavior of the `CatalogClient` object can be defined via
Copy file name to clipboardExpand all lines: README.md
+22-21Lines changed: 22 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# HERE OLP SDK for C++
1
+
# HERE Data SDK for C++
2
2
3
-
The HERE OLP SDK for C++ is a C++ client for the <ahref="https://platform.here.com"target="_blank">HERE Open Location Platform</a>.
3
+
The HERE Data SDK for C++ is a C++ client for the <ahref="https://platform.here.com"target="_blank">HERE platform</a>.
4
4
5
5
## Health Сheck
6
6
@@ -23,32 +23,33 @@ The HERE OLP SDK for C++ is a C++ client for the <a href="https://platform.here.
23
23
24
24
## Why Use
25
25
26
-
The Open Location Platform (OLP) SDK for C++ provides support for the core HERE OLP use cases through a set of native C++ interfaces. The SDK is intended to save your time and effort on using OLP REST APIs. It provides a set of stable APIs that simplify complex OLP operations and keeps up to date with the latest OLP REST API changes.
26
+
The HERE Data SDK for C++ provides support for the core HERE platform use cases through a set of native C++ interfaces. The SDK is intended to save your time and effort on using HERE REST APIs. It provides a set of stable APIs that simplify complex platform operations and keeps up to date with the latest HERE REST API changes.
27
27
28
-
The OLP SDK for C++ is a modern (C++11), lightweight, and modular SDK with minimal dependencies targeted towards a wide range of hardware platforms from embedded devices to desktops.
28
+
The Data SDK for C++ is a modern (C++11), lightweight, and modular SDK with minimal dependencies targeted towards a wide range of hardware platforms from embedded devices to desktops.
29
29
30
30
This SDK lets you:
31
31
32
-
- Authenticate to HERE OLP using client credentials
32
+
- Authenticate to HERE platform using client credentials
33
33
- Read catalog and partition metadata
34
-
- Retrieve data from versionedand volatile layers of OLP catalogs
35
-
- Upload data to OLP
34
+
- Retrieve data from versioned, volatile, and stream layers of the platform catalogs
35
+
- Upload data to the platform
36
36
37
-
Additionally, the SDK includes classes for work with geospatial tiling schemes that are used by most OLP catalog layers.
37
+
Additionally, the SDK includes classes for work with geospatial tiling schemes that are used by most platform catalog layers.
38
38
39
39
## Backward Compatibility
40
40
41
-
We try to develop and maintain our API in a way that preserves its compatibility with the existing applications. Changes in OLP SDK for C++ are greatly influenced by the Data API development. Data API introduces breaking changes 6 months in advance. Therefore, you may need to migrate to a new version of OLP SDK for C++ every half a year.
41
+
We try to develop and maintain our API in a way that preserves its compatibility with the existing applications. Changes in the Data SDK for C++ are greatly influenced by the Data API development. Data API introduces breaking changes 6 months in advance. Therefore, you may need to migrate to a new version of the Data SDK for C++ every half a year.
42
42
43
43
For more information on Data API, see its <ahref="https://developer.here.com/olp/documentation/data-api/data_dev_guide/index.html"target="_blank">Developer Guide</a> and <ahref="https://developer.here.com/olp/documentation/data-api/api-reference.html"target="_blank">API Reference</a>.
44
44
45
-
When new API is introduced in OLP SDK for C++, the old one is not deleted straight away. The standard API deprecation time is 6 months. It gives you time to switch to new code. However, we do not provide ABI backward compatibility.
45
+
When new API is introduced in the Data SDK for C++, the old one is not deleted straight away. The standard API deprecation time is 6 months. It gives you time to switch to new code. However, we do not provide ABI backward compatibility.
46
46
47
-
All of the deprecated methods, functions, and parameters are documented in the OLP SDK for C++ <ahref="https://developer.here.com/olp/documentation/sdk-cpp/api_reference/index.html"target="_blank">API Reference</a> and <ahref="https://github.com/heremaps/here-data-sdk-cpp/blob/master/CHANGELOG.md"target="_blank">changelog</a>.
47
+
48
+
All of the deprecated methods, functions, and parameters are documented in the Data SDK for C++ <ahref="https://developer.here.com/olp/documentation/sdk-cpp/api_reference/index.html"target="_blank">API Reference</a> and <ahref="https://github.com/heremaps/here-data-sdk-cpp/blob/master/CHANGELOG.md"target="_blank">changelog</a>.
48
49
49
50
## Supported Platforms
50
51
51
-
The table below lists the platforms on which the OLP SDK for C++ has been tested.
52
+
The table below lists the platforms on which the HERE Data SDK for C++ has been tested.
@@ -63,7 +64,7 @@ The table below lists the platforms on which the OLP SDK for C++ has been tested
63
64
64
65
## Dependencies
65
66
66
-
The table below lists the dependencies of the HERE OLP SDK for C++.
67
+
The table below lists the dependencies of the HERE Data SDK for C++.
67
68
68
69
| Library | Minimum version |
69
70
| :------------------- | :-------------- |
@@ -77,7 +78,7 @@ The table below lists the dependencies of the HERE OLP SDK for C++.
77
78
78
79
### Additional Linux Dependencies
79
80
80
-
To build the HERE OLP SDK for C++ on Linux, additionally to the dependencies listed in the previous section, you also need to have <ahref="https://curl.haxx.se/download.html"target="_blank">libcurl</a> 7.47.0 or later.
81
+
To build the HERE Data SDK for C++ on Linux, additionally to the dependencies listed in the previous section, you also need to have <ahref="https://curl.haxx.se/download.html"target="_blank">libcurl</a> 7.47.0 or later.
81
82
82
83
To install the dependencies on Linux, run the following command:
By default, the HERE OLP SDK for C++ downloads and compiles its dependencies. The versions of the downloaded dependencies may conflict with the versions that are already installed on your system. Therefore, the downloaded dependencies are not added to the install targets.
91
+
By default, the HERE Data SDK for C++ downloads and compiles its dependencies. The versions of the downloaded dependencies may conflict with the versions that are already installed on your system. Therefore, the downloaded dependencies are not added to the install targets.
91
92
92
-
You can use the HERE OLP SDK for C++ in your CMake project or install it on your system.
93
+
You can use the HERE Data SDK for C++ in your CMake project or install it on your system.
93
94
94
95
Тo use the SDK directly in your CMake project, add the SDK via `add_subdirectory()`.
95
96
@@ -103,7 +104,7 @@ To install the SDK on your system:
103
104
104
105
**Example**
105
106
106
-
The following command builds and installs the HERE OLP SDK for C++:
107
+
The following command builds and installs the HERE Data SDK for C++:
CMake downloads <ahref="https://github.com/google/leveldb"target="_blank">LevelDB</a>, <ahref="https://github.com/google/snappy"target="_blank">Snappy</a>, <ahref="https://github.com/Tencent/rapidjson"target="_blank">RapidJSON</a>, and <ahref="https://www.boost.org/"target="_blank">Boost</a>. To disable downloading, set `OLP_SDK_BUILD_EXTERNAL_DEPS` to `OFF`. For details on CMake flags, see the [CMake Flags](#cmake-flags) section.
117
118
118
-
To build the HERE OLP SDK for C++:
119
+
To build the HERE Data SDK for C++:
119
120
120
121
1. Clone the repository folder.
121
122
2. In the root of the repository folder, run the following commands:
@@ -136,7 +137,7 @@ If you cannot build the SDK on Windows using this instruction, see [Build on Win
136
137
137
138
We assume that you have installed CMake, Microsoft Visual Studio 2017, and the Visual C++ tools for CMake component.
138
139
139
-
To build the HERE OLP SDK for C++ on Windows:
140
+
To build the HERE Data SDK for C++ on Windows:
140
141
141
142
1. Launch Microsoft Visual Studio as administrator.
To learn how to use the HERE OLP SDK for C++, see the <ahref="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/GettingStartedGuide.md"target="_blank">Getting Started Guide</a>.
181
+
To learn how to use the HERE Data SDK for C++, see the <ahref="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/GettingStartedGuide.md"target="_blank">Getting Started Guide</a>.
181
182
182
183
## Contribution
183
184
184
-
For details, see the <ahref="https://github.com/heremaps/here-data-sdk-cpp/blob/master/CONTRIBUTING.md"target="_blank">HERE OLP SDK C++ Contributors Guide</a>.
185
+
For details, see the <ahref="https://github.com/heremaps/here-data-sdk-cpp/blob/master/CONTRIBUTING.md"target="_blank">HERE Data SDK C++ Contributors Guide</a>.
For more information, see the [HERE OLP Data User Guide](https://developer.here.com/olp/documentation/data-user-guide/index.html).
14
+
For more information, see the [Data User Guide](https://developer.here.com/olp/documentation/data-user-guide/index.html).
15
15
16
16
## Get Credentials
17
17
18
-
To work with catalog or service requests to the HERE Open Location Platform (OLP), you need to get authentication and authorization credentials.
18
+
To work with catalog or service requests to the HERE platform, you need to get authentication and authorization credentials.
19
19
20
-
You can authenticate to OLP within your application with the platform credentials available on the OLP portal by means of the HERE OLP SDK for C++ authentication library. For instructions on how to get credentials, see [the related section](https://developer.here.com/olp/documentation/access-control/user-guide/topics/get-credentials.html) in the Terms and Permissions User Guide.
20
+
You can authenticate to the HERE platform within your application with the platform credentials available on the HERE platform Portal by means of the Data SDK for C++ authentication library. For instructions on how to get credentials, see the [related section](https://developer.here.com/olp/documentation/access-control/user-guide/topics/get-credentials.html) in the Terms and Permissions User Guide.
21
21
22
22
## Available Components
23
23
24
-
The HERE OLP SDK for C++ contains separate libraries, each of which has a distinct functionality. For more information about the components, see the [architectural overview](OverallArchitecture.md).
24
+
The HERE Data SDK for C++ contains separate libraries, each of which has a distinct functionality. For more information about the components, see the [architectural overview](OverallArchitecture.md).
25
25
26
-
## HERE OLP SDK for C++ in CMake Projects
26
+
## HERE Data SDK for C++ in CMake Projects
27
27
28
28
Once the libraries are installed, you can find them using the `find_package()` function within your project. For more information on how to install libraries, see [the related section](../README.md#install-the-sdk) in the README.md file.
Copy file name to clipboardExpand all lines: docs/OverallArchitecture.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
-
# Overall Architecture of HERE OLP SDK for C++
1
+
# Overall Architecture of HERE Data SDK for C++
2
2
3
3
## Outline
4
4
5
-
This document describes the overall architecture of the HERE OLP SDK for C++ (here also referred to as SDK). For an overview of the scope and the features of the SDK, see [README.md](../README.md#why-use).
5
+
This document describes the overall architecture of the HERE Data SDK for C++ (here also referred to as SDK). For an overview of the scope and the features of the SDK, see [README.md](../README.md#why-use).
6
6
7
7
## Component Overview
8
8
9
-
The HERE OLP SDK for C++ consists of three main independent modules:
9
+
The HERE Data SDK for C++ consists of three main independent modules:
10
10
11
11
***olp-cpp-sdk-authentication**
12
12
***olp-cpp-sdk-dataservice-read**
@@ -20,14 +20,14 @@ In the following sections, you find description of each of these modules.
20
20
21
21
The following diagram shows an overview of the SDK components and their relationship with the HERE Cloud.
22
22
23
-

23
+

24
24
25
25
#### olp-cpp-sdk-core
26
26
27
27
The core module offers the following platform-independent functionality:
28
28
29
29
***cache** - disk and memory cache
30
-
***client** - generic HTTP client that performs communication with the HERE Open Location Platform (OLP)
30
+
***client** - generic HTTP client that performs communication with the HERE platform
31
31
***geo** - geo utilities
32
32
***logging** - logging to file, console or any customer-defined logger
33
33
***math** - geo math utilities
@@ -38,13 +38,13 @@ The core module offers the following platform-independent functionality:
38
38
For more information on how to use cache, see the [cache example](dataservice-cache-example.md).
39
39
#### olp-cpp-sdk-authentication
40
40
41
-
The authentication module wraps the HERE Authentication and Authorization REST API. It's an OAuth 2.0 compliant REST API that lets you obtain short-lived access tokens that are used to authenticate requests to HERE services. Tokens expire after 24 hours.
41
+
The authentication module wraps the HERE Authentication and Authorization REST API. It's an OAuth 2.0 compliant REST API that lets you obtain short-lived access tokens that are used to authenticate requests to the HERE platform Services. Tokens expire after 24 hours.
42
42
43
43
For more information on how to use this module, see the [read and write examples](../docs).
44
44
45
45
#### olp-cpp-sdk-dataservice-read
46
46
47
-
The dataservice-read module wraps a subset of the HERE Open Location Platform Data REST API related to reading data from OLP catalogs. It allows reading of data from the following layer types and with the listed Data APIs:
47
+
The dataservice-read module wraps a subset of the Data REST API related to reading data from platform catalogs. It allows reading of data from the following layer types and with the listed Data APIs:
For more information on how to use this module, see the [read example](dataservice-read-catalog-example.md).
67
67
68
68
#### olp-cpp-sdk-dataservice-write
69
69
70
-
The dataservice-write module wraps a subset of the HERE Open Location Platform Data REST API related to writing data to OLP catalogs. It allows writing of data to the following layer types and with the listed Data APIs:
70
+
The dataservice-write module wraps a subset of the Data REST API related to writing data to platform catalogs. It allows writing of data to the following layer types and with the listed Data APIs:
0 commit comments