VCSSL/Vnano プラグイン インターフェース 仕様書

Float64 Scalar Data Accessor Interface 1 (Float64 SDAI1)
インターフェース仕様書
(org.vcssl.connect.Float64ScalarDataAccessorInterface1)


概要

Float64 Scalar Data Accessor Interface 1 (Float64 SDAI1) は、 主に処理系のデータコンテナが実装してサポートする、データ入出力インターフェースの一つです。

この org.vcssl.connect パッケージ内では、スクリプトエンジン側とプラグイン側との間で、必要に応じてデータ型の変換なしにデータを受け渡しするための、 複数のデータ入出力インターフェースが提供されています。

その中でこの Float64 SDAI1 は、64bit浮動小数点数である double 型のスカラ値に対する入出力機能を提供します。

ステータス

このインターフェースの現在のステータスは "FINALIZED"(確定済み)です。

このインターフェースの仕様は、2022年8月31日時点で最終確定しました。今後は原則として、ドキュメントやコメント類以外の変更は加えられません。

現在は Vnano のスクリプトエンジンでサポートされ、同エンジンを搭載したアプリケーションのプラグイン開発において利用できます。

ライセンス

このインターフェースは、実質的な著作権フリー/パブリックドメインである CC0 に基づいて公開されています。

フィールド/メソッド等の一覧

INTERFACE_TYPE_ID
プラグインのロード時に参照される、このインターフェースの形式ID(値: "FLOAT64_SDAI")です。
INTERFACE_GENERATION
このインターフェースの世代名です(値: "1")。
void setFloat64ScalarData(double data)
double 型のスカラ値を設定します。
double getFloat64ScalarData()
double 型のスカラ値を取得します。
boolean hasFloat64ScalarData()
double 型のスカラ値を取得可能かどうかを判定します。

フィールド

名前 INTERFACE_TYPE_ID
値の意味 プラグインのロード時に参照される、このインターフェースの形式ID(値: "FLOAT64_SDAI")です。
データ型 static final String
名前 INTERFACE_GENERATION
値の意味 このインターフェースの世代名です(値: "1")。
データ型 static final String

メソッド

名前 setFloat64ScalarData
宣言形式 void setFloat64ScalarData(double data)
機能 double 型のスカラ値を設定します。
引数 data: 設定するスカラ値
戻り値 なし
名前 getFloat64ScalarData
宣言形式 double getFloat64ScalarData()
機能 double 型のスカラ値を取得します。
引数 なし
戻り値 スカラ値
名前 hasFloat64ScalarData
宣言形式 boolean hasFloat64ScalarData()
機能 double 型のスカラ値を取得可能かどうかを判定します。
引数 なし
戻り値 double 型のスカラ値を取得可能であれば true が返されます。