入門ガイド

このガイドでは、 Data SDK を使用して HERE platform で認証を行い、作業を開始する方法について説明します。

• 前提条件
• 概念
• 資格情報を入手する
• SDK をインストールします
• SDK を構築します
  • Windows 上で構築
  • DO2 を使用してドキュメントを生成します
  • CMake フラグ
• 利用可能なコンポーネント
• CMake プロジェクトの HERE Data SDK for C++
• 参照ドキュメント
• 例

前提条件

HERE Data SDK for C++ の使用を開始するには、プラットフォームユーザーアカウントが必要です。

Data SDK で作業するには、次の項目についての知識が必要です。

• HERE platform のコア概念についての基本的な理解。
• C++ 11 および CMake の基本的なスキル

このドキュメントに適用される利用規約につきましては、「HERE Documentation License」を参照してください。

概念

HERE Data SDK for C++ を使用するには、 HERE platform に関連する次の概念を理解しておく必要があります。

• カタログ
• レイヤー
• パーティション
• HERE リソース名 (HRNS)

詳細については 、 Data ユーザー ガイドを参照してください。

資格情報を入手します

HERE platform に対するカタログまたはサービスリクエストを処理するには、認証と承認の資格情報を取得する必要があります。

プラットフォーム資格情報で利用可能な HERE ポータルを使用して、 C++ 認証用の Data SDK ライブラリを使用して、アプリケーション内の HERE platform に対する認証を行うことができます。 使用可能な認証オプションについては、『 Identity & Access Management 開発者ガイド』を参照してください。

SDK をインストールします

デフォルトでは、 Data SDK はその依存関係をダウンロードしてコンパイルします。 ダウンロードされた依存関係のバージョンが、システムにすでにインストールされているバージョンと競合する可能性があります。 したがって、ダウンロードされた依存関係はインストールターゲットに追加されません。

データ SDK は、 CMake プロジェクトで使用することも、システムにインストールすることもできます。

CMake プロジェクトで Data SDK を直接使用する場合は、経由で Data SDK を追加 add_subdirectory()します。

Data SDK をシステムにインストールするには、次の手順を実行します。

1. Data SDK に必要なすべての依存関係をインストールします。
   依存関係の詳細については、 README.MD ファイルの「 Dependencies 」および「 Linux dependencies 」の項を参照してください。

2. （任意）システム内の必要な依存関係を検索するに OLP_SDK_BUILD_EXTERNAL_DEPSOFFは、フラグをに設定します。

3. （任意） Data SDK を共有ライブラリとして構築するに BUILD_SHARED_LIBSONは、フラグをに設定します。

例

次のコマンドを実行すると、 Data SDK がビルドされ、インストールされます。

cmake --build . --target install

SDK を構築します

CMake がメインの構築システムです。 必要な CMake の最小バージョンは 3.9 です。

CMake が LevelDB 、 Snappy 、 RapidJSON 、および Boost をダウンロードします。 ダウンロードを無効にするには OLP_SDK_BUILD_EXTERNAL_DEPS 、をに設定 OFFします。 CMake フラグの詳細について は、関連するセクションを参照してください。

Data SDK を構築するには、次の手順を実行

1. リポジトリフォルダを複製します。
2. リポジトリフォルダのルートで、次のコマンドを実行します。

    mkdir build && cd build
    cmake ..
    cmake --build .

この命令を使用して Windows で Data SDK をビルドできない場合は 、「 Windows でビルド」を参照してください。

Windows 上で構築

CMake 、 Microsoft Visual Studio 2017 、および Visual C++ tools for CMake コンポーネントがインストールされていることを前提としています。

Windows で Data SDK を構築するには、次の手順を実行します

1. 管理者として Microsoft Visual Studio を起動します。

2. Data SDK が含まれているフォルダ、または Data SDK を使用する CMake ベースのプロジェクトを開きます。

3. Microsoft Visual Studio で、ターゲットに「 ( 既定 ) 」が含まれていないことを確認します。
   たとえば、「 x64-Debug (default) 」ではなく「 x64-Debug 」を選択します。

4. Visual C++ の CMake ツールで提供される CMake メニューを使用 .cmake して、ファイルを生成し、既定のオプションを使用してプロジェクト全体をビルドします。

DO2 を使用してドキュメントを生成します

注釈の付いたソースコードからドキュメントを作成する場合 は、 DO2 および CMake バージョン 3.9 以降が必要です。

DO2 ドキュメントを生成するには OLP_SDK_BUILD_DOCON 、 CMake 設定を実行するときにフラグをに設定します。

mkdir build && cd build
cmake -DOLP_SDK_BUILD_DOC=ON ..
cmake --build . --target docs

CMake フラグ

利用可能なコンポーネント

Data SDK for C++ には、個別のライブラリが含まれており、それぞれに個別の機能があります。 コンポーネントの詳細については、アーキテクチャの概要を参照してください。

CMake プロジェクトの HERE Data SDK for C++

ライブラリがインストールされると find_package() 、プロジェクト内の機能を使用してそれらのライブラリを見つけることができます。 ライブラリのインストール方法の詳細については、「 SDK のインストール」を参照してください。

find_package(olp-cpp-sdk-core REQUIRED)
find_package(olp-cpp-sdk-authentication REQUIRED)
find_package(olp-cpp-sdk-dataservice-read REQUIRED)
find_package(olp-cpp-sdk-dataservice-write REQUIRED)

必要なターゲットをインポートしたら、ライブラリにリンクできます。

target_link_libraries(example_app
    olp-cpp-sdk-core
    olp-cpp-sdk-authentication
    olp-cpp-sdk-dataservice-read
    olp-cpp-sdk-dataservice-write
)

参照ドキュメント

Data SDK for C++ の API リファレンス ドキュメントは 、 GitHub のページから入手できます。

例

HERE Data SDK for C++ には、主な使用例の一部を示すサンプルプログラムがいくつか含まれています。 これらのサンプルプログラムは 、 examples フォルダにあります。

• 例を読む –カタログ、パーティション メタデータ、パーティション データを取得する方法を示します。
• ストリーム レイヤーの例を読む –ストリーム レイヤーからデータを取得する方法を示します。
• キャッシュの例 –パーティション データを取得して、変更可能で保護されたキャッシュを操作する方法を示します。
• 例を記述 – HERE platform にデータを公開する方法を示します。