diff --git a/README.md b/README.md index 0f206cb..399f7fb 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,27 @@ APIのカテゴリとしては、その目的の応じて以下の3ケース ![スクリーンショット 2024-01-04 14 04 47](https://github.com/toppers/hakoniwa-core-cpp-client/assets/164193/80d2d524-c115-486a-8b99-5da2b83a6fa8) +# 目次 +- [箱庭アセット API](#箱庭アセット-api) + - [箱庭アセットのユースケース分類](#箱庭アセットのユースケース分類) + - [箱庭アセットの処理フロー](#箱庭アセットの処理フロー) + - [箱庭 API 仕様](#箱庭-api-仕様) + - [箱庭アセットを登録する](#箱庭アセットを登録する) + - [箱庭アセットのシミュレーションを開始する](#箱庭アセットのシミュレーションを開始する) + - [箱庭アセットの処理を実行する](#箱庭アセットの処理を実行する) + - [箱庭アセットの初期化処理](#箱庭アセットの初期化処理) + - [箱庭アセットの周期イベント実行処理](#箱庭アセットの周期イベント実行処理) + - [箱庭アセットの手動タイミング制御処理](#箱庭アセットの手動タイミング制御処理) + - [箱庭アセットのリセット処理](#箱庭アセットのリセット処理) + - [箱庭PDUデータを読み込みする](#箱庭pduデータを読み込みする) + - [箱庭PDUデータを書き込みする](#箱庭pduデータを書き込みする) + - [箱庭シミュレーション時間を取得する](#箱庭シミュレーション時間を取得する) + - [スリープする](#スリープする) + - [サンプルコード](#サンプルコード) +- [箱庭コマンド API](#箱庭コマンド-api) +- [箱庭コンダクタ API](#箱庭コンダクタ-api) + + # 箱庭アセット API @@ -59,7 +80,6 @@ APIのカテゴリとしては、その目的の応じて以下の3ケース スクリーンショット 2024-01-11 7 55 07 - ## 箱庭 API 仕様 ### 箱庭アセットを登録する @@ -530,6 +550,10 @@ int main() { } ``` +## サンプルコード + +箱庭アセットAPIを深く利用するための動作確認およびサンプルコードを用意しています。 +[こちら](https://github.com/toppers/hakoniwa-core-cpp-client/tree/main/examples)を参照ください。 # 箱庭コマンド API