データソースの定義

Kanzi アプリケーションで外部データソースからのデータを使用するには、

  1. Kanzi Engine プラグインでデータソースを定義します。データソースの定義 を参照してください。

  2. Kanzi Studio プロジェクトで、データソースを定義するデータソースプラグインを使用してください。データソースプラグインを使用する を参照してください。

Kanzi Studio プロジェクトでデータソースを使用する方法を学ぶには、データソースを使用する を参照してください。

データソースの定義

データソースを定義するには：

  1. Kanzi Studio でプロジェクトを作成し、Quick Start ウィンドウの New タブで Application with data source plugin プロジェクトテンプレートを選択します。

    ../../_images/data-sources-template.png

    Application with data source plugin テンプレートは、データソースプラグインテンプレートを含む Kanzi Engine アプリケーションを持つプロジェクトを作成します。

    Kanzi は <ProjectName>/Tool_project ディレクトリに Kanzi Studio プロジェクトを作成し、<ProjectName>/Application ディレクトリにプロジェクトのアプリケーションコードの構造を作成します。

    • bin ディレクトリには、プロジェクトの kzb ファイルと設定ファイルが含まれています。

    • configs ディレクトリには、さまざまなプラットフォーム用の構成ファイルが含まれています。デフォルトで、Kanzi はいくつかの異なるプラットフォーム用の構成ファイルを作成します。Kanzi アプリケーションの開発に推奨されるプラットフォームは Microsoft Visual Studio です。Kanzi アプリケーションのデプロイ を参照してください。

    • src ディレクトリには、アプリケーションのソースコードが含まれています。

    • CMakeLists.txt ファイルには、CMake が Kanzi アプリケーションの Visual Studio ソリューションを生成するための手順が含まれています。

    • generate_cmake_vs<Version>_solution.bat は、Kanzi アプリケーションのために Visual Studio ソリューションを生成するために使用できるスクリプトです。スクリプトは、<ProjectName>/Application/build_vs<Version> ディレクトリに Visual Studio ソリューションを生成します。

  2. Kanzi Studio で、File > Open Kanzi Command Prompt を選択します。

    Kanzi Command Prompt は、Kanzi 環境変数が設定された Windows コマンドプロンプトを開き、Kanzi のバージョンに対して Kanzi Command Prompt を開きます。

    Kanzi Command Prompt を使用すると、絶対パスを使用したり環境変数を設定したりせずに、Kanzi のユーティリティや、Gradle、CMake などのビルドツールにアクセスできます。

    ../../_images/open-kanzi-command-prompt.png

    ヒント

    Kanzi Command Prompt は、Rightware ディレクトリの Windows スタートメニューで見つけることができます。

    Kanzi のバージョンが複数インストールされている場合は、そのコマンドプロンプトで作業したい Kanzi のバージョンに対応する Kanzi Command Prompt を起動するようにしてください。

  3. <ProjectName>/Application ディレクトリ内の Kanzi Command Prompt で、アプリケーション用の Visual Studio ソリューションを生成するスクリプトを実行します。

    generate_cmake_vs2022_solution.bat

    このスクリプトは、<ProjectName>/Application/build_vs2022 ディレクトリにアプリケーション用の Visual Studio ソリューションを生成します。

  4. Visual Studioで <ProjectName>/Application/build_vs<Version>/<ProjectName>.sln Visual Studioソリューションを開きます。Visual Studioソリューションには以下が含まれています。

    • <ProjectName> という名前の Kanzi Engine プラグイン用のプロジェクトです。このプロジェクトでデータソースを定義します。この空のテンプレートプロジェクトをビルドすると、Kanzi Studio プロジェクトでデータソースを作成するために使用できるデータソースが作成されますが、そのようなデータソースには機能がありません。データソースを定義するためだけにプロジェクトを作成した場合は、このプロジェクトのみをVisual Studioソリューションで使用する必要があります。

    • <ProjectName>_executable という名前のC++アプリケーションのプロジェクト。このプロジェクトで Kanzi アプリケーションのロジックを定義します。

    ../../_images/data-source-plugin-project-in-visual-studio.png

  5. Visual Studioで、Kanzi アプリケーションのロジックとデータソースを Kanzi Engine プラグインで作成します。また、データソース内のデータをどのようにリロードするかを定義することを確認してください。データソースの定義方法の例については、チュートリアル: データソースからアプリケーションデータを取得する を参照してください。

    Kanzi アプリケーションまたは Kanzi Engine プラグインが使用するファイルを追加または削除する場合、CMakeLists.txt 内のファイルリストを set コマンドで更新し、generate_cmake_vs<Version>_solution.bat スクリプトを実行してください。

    • Kanzi アプリケーションで使用するファイルを変更する場合は、<ProjectName>/Application/src/executable/CMakeLists.txt を更新してください。

    • Kanzi Engine プラグインで使用するファイルを変更した場合は、<ProjectName>/Application/src/plugin/CMakeLists.txt を更新してください。

    例えば、tinyxml2.cpp と tinyxml2.h ファイルを Kanzi Engine プラグインに追加するには、これらのファイルを含むように <ProjectName>/Application/src/plugin/CMakeLists.txt を更新します。

    set(sources_plugin
    src/tinyxml2.cpp
    src/tinyxml2.h
    src/mykanziengineplugin.cpp
    src/mykanziengineplugin.hpp
    src/mykanziengineplugin.rc
    src/mykanziengineplugin_module.cpp
    src/mykanziengineplugin_module.hpp)

  6. 使用したいソリューション構成を選択してください。

    開発中は、Debug 構成を選択します。製品版を作成する準備ができたら、Release 構成を選択します。

    ../../_images/debug-configuration.png

  7. Visual Studioでデータソースを定義したプロジェクトを右クリックし、Buildを選択します。

    Visual Studio は、<ProjectName>/Application/lib/<PlatformName>/<ConfigurationName> ディレクトリにプラグイン DLL をビルドします。

    Kanzi Studio プロジェクトでこのプラグインを使用している場合、Visual Studio でプラグイン DLL のビルドを開始する前に、Kanzi Studio で Preview > Exit Preview を選択してください。

    ../../_images/mydatasource-vs-build.png

データソースプラグインを使用する

データソースプラグインの準備ができたら、それを Kanzi Studio プロジェクトで有効にするか、同じタイプのデータソースを使用したい別の Kanzi Studio プロジェクトにプラグインをインポートする必要があります。

データソースを定義するには、データソースの定義 を参照してください。

Kanzi Studio プロジェクトでデータソースプラグインを使用するには：

  • 同じ Kanzi Studio プロジェクトを使用してデータソースを定義している場合：

    1. Library > Kanzi Engine Plugins の Kanzi Studio で、Visual Studio で定義してビルドしたデータソースプラグインを右クリックし、Update Kanzi Engine Plugin を選択します。

      プラグインのソースコードを変更し、Visual Studio でプラグインをビルドするたびに、プラグインのメタデータを更新する必要があります。プラグインのメタデータを更新し、Library でプラグインを選択すると、Properties の Metadata Last Read From プロパティが、Kanzi Studio が読み込んでメタデータを読み取ったプラグインの .dll ファイルを示します。

      ../../_images/update-kanzi-engine-plugin-metadata1.png ../../_images/metadata-last-read-from1.png

    2. Library > Kanzi Engine Plugins でプラグインを選択し、Properties で Is Enabled プロパティが有効になっていることを確認してください。

      ../../_images/enable-is-enabled-property.png

      ヒント

      Kanzi Engine プラグインをプロジェクトで有効または無効にするには、Is Enabled プロパティを使用します。

  • 他の Kanzi Studio プロジェクトで、データソースを定義したプラグインを使用したい場合：

    1. Kanzi Studio でプロジェクトを作成し、Quick Start ウィンドウの New タブで Application、Application with data source plugin、または Application with Kanzi Engine plugin プロジェクトテンプレートを選択します。

    2. Kanzi Studio で、File > Open Kanzi Command Prompt を選択します。

      Kanzi Command Prompt は、Kanzi 環境変数が設定された Windows コマンドプロンプトを開き、Kanzi のバージョンに対して Kanzi Command Prompt を開きます。

      Kanzi Command Prompt を使用すると、絶対パスを使用したり環境変数を設定したりせずに、Kanzi のユーティリティや、Gradle、CMake などのビルドツールにアクセスできます。

      ../../_images/open-kanzi-command-prompt.png

      ヒント

      Kanzi Command Prompt は、Rightware ディレクトリの Windows スタートメニューで見つけることができます。

      Kanzi のバージョンが複数インストールされている場合は、そのコマンドプロンプトで作業したい Kanzi のバージョンに対応する Kanzi Command Prompt を起動するようにしてください。

    3. <ProjectName>/Application ディレクトリ内の Kanzi Command Prompt で、アプリケーション用の Visual Studio ソリューションを生成するスクリプトを実行します。

      generate_cmake_vs2022_solution.bat

      このスクリプトは、<ProjectName>/Application/build_vs2022 ディレクトリにアプリケーション用の Visual Studio ソリューションを生成します。

    4. Visual Studioで <ProjectName>/Application/build_vs<Version>/<ProjectName>.sln Visual Studioソリューションを開き、使用したいデータソースプラグインを定義した Kanzi プロジェクトからVisual Studioプロジェクトをインポートします。

    5. 使用したいソリューション構成を選択してください。

      開発中は、Debug 構成を選択します。製品版を作成する準備ができたら、Release 構成を選択します。

      ../../_images/debug-configuration.png

    6. Visual Studioでデータソースを定義したプロジェクトを右クリックし、Buildを選択します。

      Visual Studio は、<ProjectName>/Application/lib/<PlatformName>/<ConfigurationName> ディレクトリにプラグイン DLL をビルドします。

      Kanzi Studio プロジェクトでこのプラグインを使用している場合、Visual Studio でプラグイン DLL のビルドを開始する前に、Kanzi Studio で Preview > Exit Preview を選択してください。

      ../../_images/mydatasource-vs-build.png

    7. Library で右クリックして Kanzi Engine Plugins を選択し、Import Kanzi Engine Plugin を選択します。

      ../../_images/import-kanzi-engine-plugin.png

    8. データソースを定義するプラグインDLLを選択し、Open をクリックします。

    9. Library > Kanzi Engine Plugins でプラグインを選択し、Properties で Is Enabled プロパティが有効になっていることを確認してください。

      ../../_images/enable-is-enabled-property.png

      ヒント

      Kanzi Engine プラグインをプロジェクトで有効または無効にするには、Is Enabled プロパティを使用します。

関連項目

データソースを使用する

チュートリアル: データソースからアプリケーションデータを取得する