Coreform公式ドキュメントを基にした日本語版です。技術仕様・対応状況の最終的な基準は公式英語版です。
coreform
ソースディレクトリ: interop/abaqus/cf_app/coreform
ディレクトリツリー
1 types.py
モジュールパス: coreform.types
利用可能なAPIメンバー
1.1 Float3
オブジェクトパス: coreform.types.Float3
型: Tuple[float, float, float]
3つの浮動小数点成分。
1.2 Point3D
オブジェクトパス: coreform.types.Point3D
型: Tuple[float, float, float]
3つの浮動小数点座標で表される点。
1.3 Vector3D
オブジェクトパス: coreform.types.Vector3D
型: Tuple[float, float, float]
3つの浮動小数点成分で表されるベクトル。
2 validation.py
モジュールパス: coreform.validation
利用可能なAPIメンバー
| 名前 | 種別 | 説明 |
|---|---|---|
ValidationIssue.path |
属性 | ネストされた仕様内で問題箇所を示すフィールドパス。 |
ValidationIssue.code |
属性 | 安定した機械可読の問題識別子。 |
ValidationIssue.message |
属性 | 問題についての人間可読な説明。 |
ValidationError.issues |
属性 | この例外が保持する構造化された検証問題。 |
ValidationIssue |
クラス | 安定したパスとコードを用いて1件の検証問題を表します。 |
ValidationError |
クラス | 1件以上の構造化されたCoreform検証問題をまとめます。 |
2.1 ValidationIssue
オブジェクトパス: coreform.validation.ValidationIssue
安定したパスとコードを用いて1件の検証問題を表します。
呼び出し構文
result = ValidationIssue(path=path, code=code, message=message)シグネチャ
ValidationIssue(path: Tuple[str, ...], code: str, message: str)パラメータ
| 名前 | 型 | 必須 | 既定値 | 説明 |
|---|---|---|---|---|
path |
Tuple[str, ...] |
はい | — | ネストされた仕様内で問題箇所を示すフィールドパス。 |
code |
str |
はい | — | 安定した機械可読の問題識別子。 |
message |
str |
はい | — | 問題についての人間可読な説明。 |
2.1.1 属性
| 名前 | 型 | 値 | 説明 |
|---|---|---|---|
path |
Tuple[str, ...] |
— | ネストされた仕様内で問題箇所を示すフィールドパス。 |
code |
str |
— | 安定した機械可読の問題識別子。 |
message |
str |
— | 問題についての人間可読な説明。 |
2.2 ValidationError
オブジェクトパス: coreform.validation.ValidationError
1件以上の構造化されたCoreform検証問題をまとめます。
呼び出し構文
result = ValidationError(issues=issues)シグネチャ
ValidationError(issues: Union['ValidationError', str, Iterable[ValidationIssue]])パラメータ
| 名前 | 型 | 必須 | 既定値 | 説明 |
|---|---|---|---|---|
issues |
Union['ValidationError', str, Iterable[ValidationIssue]] |
はい | — | 既存のエラー、フォールバックメッセージ、または空でない構造化問題コレクション。 |
2.2.1 属性
| 名前 | 型 | 値 | 説明 |
|---|---|---|---|
issues |
Tuple[ValidationIssue, ...] |
tuple(issues) |
この例外が保持する構造化された検証問題。 |