HARK ライブラリ

NetCOMPASS
2021/05/31

0.概要
  本文書は、HARK ライブラリの構成、使用方法等について述べたものである。

1.パッケージの構成
  パッケージは、以下の git レポジトリにおいて管理されている。
  https://harkdev.backlog.jp/git/LIBHARK/hark-lib.git

  本バージョンは、ブランチ feature-harklib-1-0-master にて管理されている。

2.動作環境
  以下の環境において、ビルド・動作確認済みである。

  - Linux 環境
    Ubuntu20.04
    cmake 3.10.2
    g++ 7.5.0

  - MacOS / iOS 環境
    MacOS Big Sur 11.3.1
    Xcode 12.5
    iPad air (第4世代) (MODEL MYFN2J/A, OS v14.4)

  また、以下の外部ライブラリを参照するため、事前にインストールが必要である
  - Eigen (https://eigen.tuxfamily.org/)
    開発時に用いたバージョン: 3.3.9

    なお、cmake より、find_package(eigen) にてビルド情報を取得する。


3.使用方法
  それぞれ、以下のドキュメントを参照。
  (YYYYMMDD はファイルバージョン(日付)を表す)
  - C++ 版
    README.C++.YYYYMMDD
  - iOS 版
    README.iOS.YYYYMMDD
  - C# 版(仮)
    README.C#.YYYYMMDD

4.ファイルの構成
  本件パッケージのファイル構成は以下の通りである。
  /hark-lib: レポジトリルート
      /hark-lib
          /include: ライブラリのヘッダファイル
              /internal: 内部のみで参照するヘッダファイル
              /extlib: 外部ライブラリのヘッダファイル
              /node: 実装済みノード定義のヘッダファイル
          /src: ライブラリのソースファイル
              /node: 実装済みノード定義のソースファイル
          /samples: サンプルプログラムのソースファイル等
          /docs: 本ドキュメントを含めたドキュメント類
          /xcode: MacOS/iOS 版ソースファイル等
          /windows: Windows 版ソースファイル等(開発中)
          /python: Python 版ソースファイル等(開発中)

5.動作検証
  以下の操作により、各機能が正常に動作することを確認した。

  - 操作
    - hark-lib/samples 内の test-cas.cc をビルドして実行

  - 確認項目
    - ビルドが正常に完了すること
    - 各ノードを連携してネットワーク定義が可能であること
    - ネットワーク内にネットワークを配置することが可能であること
    - 以下の各ノードが機能すること
      AudioStreamFromWave, Constant, Delta

以上
