Skip to content

Commit d5a9c2a

Browse files
authored
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]>
1 parent faf16dd commit d5a9c2a

37 files changed

+317
-274
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# HERE OLP SDK for C++ Contributor Guide
1+
# HERE Data SDK for C++ Contributor Guide
22

3-
## Contributing to HERE OLP SDK for C++
3+
## Contributing to HERE Data SDK for C++
44

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).
66

77
## Development
88

@@ -318,7 +318,7 @@ Example:
318318
```cpp
319319
/**
320320
* @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.
322322
*
323323
* The behavior of the `CatalogClient` object can be defined via
324324
* `OlpClientSettings`.

README.md

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# HERE OLP SDK for C++
1+
# HERE Data SDK for C++
22

3-
The HERE OLP SDK for C++ is a C++ client for the <a href="https://platform.here.com" target="_blank">HERE Open Location Platform</a>.
3+
The HERE Data SDK for C++ is a C++ client for the <a href="https://platform.here.com" target="_blank">HERE platform</a>.
44

55
## Health Сheck
66

@@ -23,32 +23,33 @@ The HERE OLP SDK for C++ is a C++ client for the <a href="https://platform.here.
2323

2424
## Why Use
2525

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.
2727

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.
2929

3030
This SDK lets you:
3131

32-
- Authenticate to HERE OLP using client credentials
32+
- Authenticate to HERE platform using client credentials
3333
- Read catalog and partition metadata
34-
- Retrieve data from versioned and 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
3636

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.
3838

3939
## Backward Compatibility
4040

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.
4242

4343
For more information on Data API, see its <a href="https://developer.here.com/olp/documentation/data-api/data_dev_guide/index.html" target="_blank">Developer Guide</a> and <a href="https://developer.here.com/olp/documentation/data-api/api-reference.html" target="_blank">API Reference</a>.
4444

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.
4646

47-
All of the deprecated methods, functions, and parameters are documented in the OLP SDK for C++ <a href="https://developer.here.com/olp/documentation/sdk-cpp/api_reference/index.html" target="_blank">API Reference</a> and <a href="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++ <a href="https://developer.here.com/olp/documentation/sdk-cpp/api_reference/index.html" target="_blank">API Reference</a> and <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/CHANGELOG.md" target="_blank">changelog</a>.
4849

4950
## Supported Platforms
5051

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.
5253

5354
| Platform | Minimum requirement |
5455
| :------------------------- | :---------------------- |
@@ -63,7 +64,7 @@ The table below lists the platforms on which the OLP SDK for C++ has been tested
6364

6465
## Dependencies
6566

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++.
6768

6869
| Library | Minimum version |
6970
| :------------------- | :-------------- |
@@ -77,7 +78,7 @@ The table below lists the dependencies of the HERE OLP SDK for C++.
7778

7879
### Additional Linux Dependencies
7980

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 <a href="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 <a href="https://curl.haxx.se/download.html" target="_blank">libcurl</a> 7.47.0 or later.
8182

8283
To install the dependencies on Linux, run the following command:
8384

@@ -87,9 +88,9 @@ sudo apt-get update && sudo apt-get --yes install git g++ make cmake libssl-dev
8788

8889
## Install the SDK
8990

90-
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.
9192

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.
9394

9495
Тo use the SDK directly in your CMake project, add the SDK via `add_subdirectory()`.
9596

@@ -103,7 +104,7 @@ To install the SDK on your system:
103104

104105
**Example**
105106

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++:
107108

108109
```bash
109110
cmake --build . --target install
@@ -115,7 +116,7 @@ cmake --build . --target install
115116

116117
CMake downloads <a href="https://github.com/google/leveldb" target="_blank">LevelDB</a>, <a href="https://github.com/google/snappy" target="_blank">Snappy</a>, <a href="https://github.com/Tencent/rapidjson" target="_blank">RapidJSON</a>, and <a href="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.
117118

118-
To build the HERE OLP SDK for C++:
119+
To build the HERE Data SDK for C++:
119120

120121
1. Clone the repository folder.
121122
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
136137

137138
We assume that you have installed CMake, Microsoft Visual Studio 2017, and the Visual C++ tools for CMake component.
138139

139-
To build the HERE OLP SDK for C++ on Windows:
140+
To build the HERE Data SDK for C++ on Windows:
140141

141142
1. Launch Microsoft Visual Studio as administrator.
142143

@@ -177,11 +178,11 @@ cmake --build . --target docs
177178

178179
## SDK Usage
179180

180-
To learn how to use the HERE OLP SDK for C++, see the <a href="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 <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/GettingStartedGuide.md" target="_blank">Getting Started Guide</a>.
181182

182183
## Contribution
183184

184-
For details, see the <a href="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 <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/CONTRIBUTING.md" target="_blank">HERE Data SDK C++ Contributors Guide</a>.
185186

186187
## LICENSE
187188

docs/GettingStartedGuide.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,28 @@
22

33
## Prerequisites
44

5-
To start using the HERE Open Location Platform (OLP) SDK for C++, you need an OLP user account.
5+
To start using the Data SDK for C++, you need a platform user account.
66

7-
To work with the HERE OLP SDK for C++, you need to understand the following concepts related to OLP:
7+
To work with the HERE Data SDK for C++, you need to understand the following concepts related to the HERE platform:
88

99
- [Catalogs](https://developer.here.com/olp/documentation/data-user-guide/portal/layers/catalogs.html)
1010
- [Layers](https://developer.here.com/olp/documentation/data-user-guide/portal/layers/layers.html)
1111
- [Partitions](https://developer.here.com/olp/documentation/data-user-guide/portal/layers/partitions.html)
1212
- [HERE Resource Names (HRNs)](https://developer.here.com/olp/documentation/data-user-guide/shared_content/topics/olp/concepts/hrn.html)
1313

14-
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).
1515

1616
## Get Credentials
1717

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.
1919

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.
2121

2222
## Available Components
2323

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).
2525

26-
## HERE OLP SDK for C++ in CMake Projects
26+
## HERE Data SDK for C++ in CMake Projects
2727

2828
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.
2929

@@ -47,11 +47,11 @@ target_link_libraries(example_app
4747

4848
## Reference Documentation
4949

50-
The API reference documentation for the HERE OLP SDK for C++ is available on our [GitHub Pages](https://heremaps.github.io/here-olp-sdk-cpp/).
50+
The API reference documentation for the HERE Data SDK for C++ is available on our [GitHub Pages](https://heremaps.github.io/here-olp-sdk-cpp/).
5151

5252
## Examples
5353

54-
To better understand the OLP SDK for C++, see the following examples:
54+
To better understand the Data SDK for C++, see the following examples:
5555

5656
- [Read example](dataservice-read-catalog-example.md) &ndash; shows how to get catalog and partition metadata, as well as partition data.
5757
- [Write example](dataservice-write-example.md) &ndash; shows how to publish data to a specific stream layer partition.

docs/OverallArchitecture.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Overall Architecture of HERE OLP SDK for C++
1+
# Overall Architecture of HERE Data SDK for C++
22

33
## Outline
44

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).
66

77
## Component Overview
88

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:
1010

1111
* **olp-cpp-sdk-authentication**
1212
* **olp-cpp-sdk-dataservice-read**
@@ -20,14 +20,14 @@ In the following sections, you find description of each of these modules.
2020

2121
The following diagram shows an overview of the SDK components and their relationship with the HERE Cloud.
2222

23-
![component_overview](diagrams/sdk-module-overview.png "HERE OLP SDK for C++ Component Overview")
23+
![component_overview](diagrams/sdk-module-overview.png "HERE Data SDK for C++ Component Overview")
2424

2525
#### olp-cpp-sdk-core
2626

2727
The core module offers the following platform-independent functionality:
2828

2929
* **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
3131
* **geo** - geo utilities
3232
* **logging** - logging to file, console or any customer-defined logger
3333
* **math** - geo math utilities
@@ -38,13 +38,13 @@ The core module offers the following platform-independent functionality:
3838
For more information on how to use cache, see the [cache example](dataservice-cache-example.md).
3939
#### olp-cpp-sdk-authentication
4040

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.
4242

4343
For more information on how to use this module, see the [read and write examples](../docs).
4444

4545
#### olp-cpp-sdk-dataservice-read
4646

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:
4848

4949
* Versioned layer. Used Data APIs:
5050
* [Config API](https://developer.here.com/olp/documentation/data-store/api-reference-config.html)
@@ -59,15 +59,15 @@ The dataservice-read module wraps a subset of the HERE Open Location Platform Da
5959
* Index layer (not supported yet). Used Data APIs:
6060
* [Index API](https://developer.here.com/olp/documentation/data-store/api-reference-index.html)
6161
* [Blob API](https://developer.here.com/olp/documentation/data-store/api-reference-blob.html)
62-
* Stream layer (not supported yet). Used Data APIs:
62+
* Stream layer. Used Data APIs:
6363
* [Stream API](https://developer.here.com/olp/documentation/data-store/api-reference-stream.html)
6464
* [Blob API](https://developer.here.com/olp/documentation/data-store/api-reference-blob.html)
6565

6666
For more information on how to use this module, see the [read example](dataservice-read-catalog-example.md).
6767

6868
#### olp-cpp-sdk-dataservice-write
6969

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:
7171

7272
* Versioned layer. Used Data APIs:
7373
* [Publish API](https://developer.here.com/olp/documentation/data-store/api-reference-publish.html)
@@ -114,13 +114,13 @@ Feature | Status
114114
---------------------------------|--------------
115115
Reading from versioned layer | Implemented
116116
Reading from volatile layer | Implemented
117-
Reading from stream layer | Planned
117+
Reading from stream layer | Implemented
118118
Reading from indexed layer | Planned
119119
API Lookup Service | Implemented
120120
Get catalog and layer configuration | Implemented
121121
Get partition metadata for all partitions | Implemented
122-
Get partition metadata for a subset of partitions | Planned
123-
OLP Statistics Service | Planned
122+
Get partition metadata for a subset of partitions | Implemented
123+
Statistics Service | Planned
124124

125125
#### Dataservice-Write
126126

@@ -146,4 +146,4 @@ The nonfunctional requirements are being finalized. After that this section is t
146146

147147
## Security Model
148148

149-
The user of the HERE OLP SDK for C++ is responsible to take care of any security and privacy requirements of the target system.
149+
The user of the HERE Data SDK for C++ is responsible to take care of any security and privacy requirements of the target system.

0 commit comments

Comments
 (0)