Coreform公式ドキュメントを基にした日本語版です。技術仕様・対応状況の最終的な基準は公式英語版です。

coreform.probe

ソースディレクトリ: interop/abaqus/cf_app/coreform/probe

ディレクトリツリー

probe/

1 model.py

モジュールパス: coreform.probe.model

利用可能なAPIメンバー

名前	種別	説明
`IGAProbe.spec`	属性	ラップされているポータブル Probe 仕様。
`IGAProbe.name`	属性	この Probe の名前を返します。
`IGAProbe.region`	属性	この Probe のターゲット領域を返します。
`IGAProbe.variables`	属性	この Probe の出力変数名を返します。
`IGAProbe.probe_type`	属性	この Probe の型を返します。
`IGAProbe.point`	クラスメソッド	ポータブル point Probe を作成します。
`IGAProbe.line`	クラスメソッド	ポータブル line Probe を作成します。
`IGAProbe.multi_point`	クラスメソッド	ポータブル multi-point Probe を作成します。
`IGAProbe.from_spec`	クラスメソッド	既存のポータブル Probe 仕様をラップします。
`IGAProbe.to_spec`	インスタンスメソッド	ラップされているポータブル Probe 仕様を返します。
`IGAProbe.copy_with`	インスタンスメソッド	指定した仕様フィールドを置き換えた Probe を返します。
`IGAProbe.is_point`	インスタンスメソッド	この Probe が point-Probe 仕様をラップしているかを返します。
`IGAProbe.is_line`	インスタンスメソッド	この Probe が line-Probe 仕様をラップしているかを返します。
`IGAProbe.is_multi_point`	インスタンスメソッド	この Probe が multi-point-Probe 仕様をラップしているかを返します。
`IGAProbe`	クラス	1つの具体的な Probe 仕様をラップするポータブル Probe モデル。

1.1 `IGAProbe`

オブジェクトパス: coreform.probe.model.IGAProbe

1つの具体的な Probe 仕様をラップするポータブル Probe モデル。

呼び出し構文

result = IGAProbe(spec=spec)

シグネチャ

IGAProbe(spec: ProbeSpec)

パラメータ

名前	型	必須	既定値	説明
`spec`	`ProbeSpec`	はい	—	ラップする具体的なポータブル Probe 仕様。

例

>>> probe = IGAProbe.point(
...     name="Probe-1",
...     region=ProbeRegion.instances(("PART-1-1",)),
...     location=(0.0, 0.0, 0.0),
... )

1.1.1 属性

名前	型	値	説明
`spec`	`ProbeSpec`	—	ラップされているポータブル Probe 仕様。
`name`	`str`	—	この Probe の名前を返します。
`region`	`ProbeRegion`	—	この Probe のターゲット領域を返します。
`variables`	`Tuple[str, ...]`	—	この Probe の出力変数名を返します。
`probe_type`	`ProbeType`	—	この Probe の型を返します。

1.1.2 `point`

定義先: coreform.probe.model.IGAProbe.point

説明: ポータブル point Probe を作成します。

呼び出し構文

result = IGAProbe.point(spec)
result = IGAProbe.point(name=name, region=region, location=location)

戻り値

型	説明
`IGAProbe`	ポータブル point Probe を作成します。

シグネチャ

point(spec: PointProbeSpec, /) -> IGAProbe
point(name: str = None, region: ProbeRegion = None, variables: Tuple[str, ...] = tuple(), location: Point3D = None) -> IGAProbe

パラメータ

対象: point(spec: PointProbeSpec, /) -> IGAProbe:

名前	型	必須	既定値	説明
`spec`	`PointProbeSpec`	はい	—	完全なポータブル仕様。

対象: point(name: str = None, region: ProbeRegion = None, variables: Tuple[str, ...] = tuple(), location: Point3D = None) -> IGAProbe:

名前	型	必須	既定値	説明
`name`	`str`	はい	—	一意で空でない Probe 名。
`region`	`ProbeRegion`	はい	—	ポータブルなターゲット選択。
`variables`	`Tuple[str, ...]`	いいえ	`()`	出力変数名。既定値は空のタプル。
`location`	`Point3D`	はい	—	評価位置。

1.1.3 `line`

定義先: coreform.probe.model.IGAProbe.line

説明: ポータブル line Probe を作成します。

呼び出し構文

result = IGAProbe.line(spec)
result = IGAProbe.line(name=name, region=region, start_location=start_location, stop_location=stop_location)

戻り値

型	説明
`IGAProbe`	ポータブル line Probe を作成します。

シグネチャ

line(spec: LineProbeSpec, /) -> IGAProbe
line(name: str = None, region: ProbeRegion = None, variables: Tuple[str, ...] = tuple(), start_location: Point3D = None, stop_location: Point3D = None, num_eval_points: int = 2) -> IGAProbe

パラメータ

対象: line(spec: LineProbeSpec, /) -> IGAProbe:

名前	型	必須	既定値	説明
`spec`	`LineProbeSpec`	はい	—	完全なポータブル仕様。

対象: line(name: str = None, region: ProbeRegion = None, variables: Tuple[str, ...] = tuple(), start_location: Point3D = None, stop_location: Point3D = None, num_eval_points: int = 2) -> IGAProbe:

名前	型	必須	既定値	説明
`name`	`str`	はい	—	一意で空でない Probe 名。
`region`	`ProbeRegion`	はい	—	ポータブルなターゲット選択。
`variables`	`Tuple[str, ...]`	いいえ	`()`	出力変数名。既定値は空のタプル。
`start_location`	`Point3D`	はい	—	線分の第1端点。
`stop_location`	`Point3D`	はい	—	第2端点。start_location と異なる必要があります。
`num_eval_points`	`int`	いいえ	`2`	両端点を含む評価点数。2以上である必要があります。

1.1.4 `multi_point`

定義先: coreform.probe.model.IGAProbe.multi_point

説明: ポータブル multi-point Probe を作成します。

呼び出し構文

result = IGAProbe.multi_point(spec)
result = IGAProbe.multi_point(name=name, region=region, locations=locations)

戻り値

型	説明
`IGAProbe`	ポータブル multi-point Probe を作成します。

シグネチャ

multi_point(spec: MultiPointProbeSpec, /) -> IGAProbe
multi_point(name: str = None, region: ProbeRegion = None, variables: Tuple[str, ...] = tuple(), locations: Tuple[Point3D, ...] = tuple()) -> IGAProbe

パラメータ

対象: multi_point(spec: MultiPointProbeSpec, /) -> IGAProbe:

名前	型	必須	既定値	説明
`spec`	`MultiPointProbeSpec`	はい	—	完全なポータブル仕様。

対象: multi_point(name: str = None, region: ProbeRegion = None, variables: Tuple[str, ...] = tuple(), locations: Tuple[Point3D, ...] = tuple()) -> IGAProbe:

名前	型	必須	既定値	説明
`name`	`str`	はい	—	一意で空でない Probe 名。
`region`	`ProbeRegion`	はい	—	ポータブルなターゲット選択。
`variables`	`Tuple[str, ...]`	いいえ	`()`	出力変数名。既定値は空のタプル。
`locations`	`Tuple[Point3D, ...]`	はい	—	1つ以上の明示的な評価位置。

1.1.5 `from_spec`

定義先: coreform.probe.model.IGAProbe.from_spec

説明: 既存のポータブル Probe 仕様をラップします。

呼び出し構文

result = IGAProbe.from_spec(spec=spec)

戻り値

型	説明
`IGAProbe`	既存のポータブル Probe 仕様をラップします。

シグネチャ

from_spec(spec: ProbeSpec) -> 'IGAProbe'

パラメータ

名前	型	必須	既定値	説明
`spec`	`ProbeSpec`	はい	—	ラップする具体的なポータブル Probe 仕様。

1.1.6 `to_spec`

定義先: coreform.probe.model.IGAProbe.to_spec

説明: ラップされているポータブル Probe 仕様を返します。

呼び出し構文

result = probe.to_spec()

戻り値

型	説明
`ProbeSpec`	ラップされているポータブル Probe 仕様を返します。

シグネチャ

to_spec() -> ProbeSpec

パラメータ

なし。

1.1.7 `copy_with`

定義先: coreform.probe.model.IGAProbe.copy_with

説明: 指定した仕様フィールドを置き換えた Probe を返します。

呼び出し構文

result = probe.copy_with(...)

戻り値

型	説明
`IGAProbe`	指定した仕様フィールドを置き換えた Probe を返します。

シグネチャ

copy_with(*, name: str = ..., region: ProbeRegion = ..., variables: Tuple[str, ...] = ..., location: Point3D = ...) -> IGAProbe
copy_with(*, name: str = ..., region: ProbeRegion = ..., variables: Tuple[str, ...] = ..., start_location: Point3D = ..., stop_location: Point3D = ..., num_eval_points: int = ...) -> IGAProbe
copy_with(*, name: str = ..., region: ProbeRegion = ..., variables: Tuple[str, ...] = ..., locations: Tuple[Point3D, ...] = ...) -> IGAProbe

パラメータ

対象: copy_with(*, name: str = ..., region: ProbeRegion = ..., variables: Tuple[str, ...] = ..., location: Point3D = ...) -> IGAProbe:

名前	適用対象	型	必須	既定値	説明
`name`	すべて	`str`	いいえ	現在値	一意で空でない Probe 名。
`region`	すべて	`ProbeRegion`	いいえ	現在値	ポータブルなターゲット選択。
`variables`	すべて	`Tuple[str, ...]`	いいえ	現在値	出力変数名。既定値は空のタプル。
`location`	`PointProbeSpec`	`Point3D`	いいえ	現在値	評価位置。

対象: copy_with(*, name: str = ..., region: ProbeRegion = ..., variables: Tuple[str, ...] = ..., start_location: Point3D = ..., stop_location: Point3D = ..., num_eval_points: int = ...) -> IGAProbe:

名前	適用対象	型	必須	既定値	説明
`name`	すべて	`str`	いいえ	現在値	一意で空でない Probe 名。
`region`	すべて	`ProbeRegion`	いいえ	現在値	ポータブルなターゲット選択。
`variables`	すべて	`Tuple[str, ...]`	いいえ	現在値	出力変数名。既定値は空のタプル。
`start_location`	`LineProbeSpec`	`Point3D`	いいえ	現在値	線分の第1端点。
`stop_location`	`LineProbeSpec`	`Point3D`	いいえ	現在値	第2端点。start_location と異なる必要があります。
`num_eval_points`	`LineProbeSpec`	`int`	いいえ	現在値	両端点を含む評価点数。2以上である必要があります。

対象: copy_with(*, name: str = ..., region: ProbeRegion = ..., variables: Tuple[str, ...] = ..., locations: Tuple[Point3D, ...] = ...) -> IGAProbe:

名前	適用対象	型	必須	既定値	説明
`name`	すべて	`str`	いいえ	現在値	一意で空でない Probe 名。
`region`	すべて	`ProbeRegion`	いいえ	現在値	ポータブルなターゲット選択。
`variables`	すべて	`Tuple[str, ...]`	いいえ	現在値	出力変数名。既定値は空のタプル。
`locations`	`MultiPointProbeSpec`	`Tuple[Point3D, ...]`	いいえ	現在値	1つ以上の明示的な評価位置。

パラメータ規則

規則	要件
適用範囲	`location` は次の場合にのみ適用されます: `PointProbeSpec`.
適用範囲	`start_location` は次の場合にのみ適用されます: `LineProbeSpec`.
適用範囲	`stop_location` は次の場合にのみ適用されます: `LineProbeSpec`.
適用範囲	`num_eval_points` は次の場合にのみ適用されます: `LineProbeSpec`.
適用範囲	`locations` は次の場合にのみ適用されます: `MultiPointProbeSpec`.

1.1.8 `is_point`

定義先: coreform.probe.model.IGAProbe.is_point

説明: この Probe が point-Probe 仕様をラップしているかを返します。

呼び出し構文

result = probe.is_point()

戻り値

型	説明
`bool`	ラップされた仕様が PointProbeSpec の場合は True、それ以外は False。

シグネチャ

is_point() -> bool

パラメータ

なし。

1.1.9 `is_line`

定義先: coreform.probe.model.IGAProbe.is_line

説明: この Probe が line-Probe 仕様をラップしているかを返します。

呼び出し構文

result = probe.is_line()

戻り値

型	説明
`bool`	ラップされた仕様が LineProbeSpec の場合は True、それ以外は False。

シグネチャ

is_line() -> bool

パラメータ

なし。

1.1.10 `is_multi_point`

定義先: coreform.probe.model.IGAProbe.is_multi_point

説明: この Probe が multi-point-Probe 仕様をラップしているかを返します。

呼び出し構文

result = probe.is_multi_point()

戻り値

型	説明
`bool`	ラップされた仕様が MultiPointProbeSpec の場合は True、それ以外は False。

シグネチャ

is_multi_point() -> bool

パラメータ

なし。

2 specs.py

モジュールパス: coreform.probe.specs

利用可能なAPIメンバー

名前	種別	説明
`ProbeType.POINT`	属性	1つの位置で評価する point Probe。
`ProbeType.LINE`	属性	2端点間をサンプリングする line Probe。
`ProbeType.MULTI_POINT`	属性	明示的な位置で評価する multi-point Probe。
`ProbeRegionKind.INSTANCES`	属性	名前付き assembly instance をターゲットにします。
`ProbeRegionKind.SETS`	属性	名前付き assembly set をターゲットにします。
`ProbeRegionKind.PARTS`	属性	名前付き model part をターゲットにします。
`ProbeRegion.schemaVersion`	属性	シリアライズされた仕様スキーマのバージョン。
`ProbeRegion.kind`	属性	ターゲットリポジトリの種類。
`ProbeRegion.names`	属性	1つ以上のターゲット名。
`PointProbeSpec.schemaVersion`	属性	シリアライズされた仕様スキーマのバージョン。
`PointProbeSpec.name`	属性	一意で空でない Probe 名。
`PointProbeSpec.region`	属性	ポータブルなターゲット選択。
`PointProbeSpec.variables`	属性	出力変数名。既定値は空のタプル。
`PointProbeSpec.location`	属性	評価位置。
`PointProbeSpec.probeType`	属性	Point-Probe の型識別子。
`LineProbeSpec.schemaVersion`	属性	シリアライズされた仕様スキーマのバージョン。
`LineProbeSpec.name`	属性	一意で空でない Probe 名。
`LineProbeSpec.region`	属性	ポータブルなターゲット選択。
`LineProbeSpec.variables`	属性	出力変数名。既定値は空のタプル。
`LineProbeSpec.start_location`	属性	線分の第1端点。
`LineProbeSpec.stop_location`	属性	第2端点。start_location と異なる必要があります。
`LineProbeSpec.num_eval_points`	属性	両端点を含む評価点数。2以上である必要があります。
`LineProbeSpec.probeType`	属性	Line-Probe の型識別子。
`MultiPointProbeSpec.schemaVersion`	属性	シリアライズされた仕様スキーマのバージョン。
`MultiPointProbeSpec.name`	属性	一意で空でない Probe 名。
`MultiPointProbeSpec.region`	属性	ポータブルなターゲット選択。
`MultiPointProbeSpec.variables`	属性	出力変数名。既定値は空のタプル。
`MultiPointProbeSpec.locations`	属性	1つ以上の明示的な評価位置。
`MultiPointProbeSpec.probeType`	属性	Multi-point-Probe の型識別子。
`ProbeSpec`	属性	サポートされる任意のポータブル Probe 仕様。
`ProbeRegion.validate`	インスタンスメソッド	この仕様の検証上の問題を返します。
`ProbeRegion.to_dict`	インスタンスメソッド	この仕様をバージョン付き辞書へシリアライズします。
`ProbeRegion.to_json`	インスタンスメソッド	この仕様をバージョン付き JSON 文書へシリアライズします。
`ProbeRegion.from_json`	クラスメソッド	JSON 文書から検証済み仕様を作成します。
`ProbeRegion.copy_with`	インスタンスメソッド	指定フィールドを置き換えた検証済みコピーを返します。
`ProbeRegion.instances`	クラスメソッド	名前付き instance をターゲットとする領域を作成します。
`ProbeRegion.sets`	クラスメソッド	名前付き set をターゲットとする領域を作成します。
`ProbeRegion.parts`	クラスメソッド	名前付き part をターゲットとする領域を作成します。
`ProbeRegion.from_dict`	クラスメソッド	マッピングペイロードから検証済み Probe 領域を作成します。
`PointProbeSpec.validate`	インスタンスメソッド	この仕様の検証上の問題を返します。
`PointProbeSpec.to_dict`	インスタンスメソッド	この仕様をバージョン付き辞書へシリアライズします。
`PointProbeSpec.to_json`	インスタンスメソッド	この仕様をバージョン付き JSON 文書へシリアライズします。
`PointProbeSpec.from_dict`	クラスメソッド	マッピングペイロードから検証済み仕様を作成します。
`PointProbeSpec.from_json`	クラスメソッド	JSON 文書から検証済み仕様を作成します。
`PointProbeSpec.copy_with`	インスタンスメソッド	指定フィールドを置き換えた検証済みコピーを返します。
`LineProbeSpec.to_dict`	インスタンスメソッド	この仕様をバージョン付き辞書へシリアライズします。
`LineProbeSpec.to_json`	インスタンスメソッド	この仕様をバージョン付き JSON 文書へシリアライズします。
`LineProbeSpec.from_dict`	クラスメソッド	マッピングペイロードから検証済み仕様を作成します。
`LineProbeSpec.from_json`	クラスメソッド	JSON 文書から検証済み仕様を作成します。
`LineProbeSpec.copy_with`	インスタンスメソッド	指定フィールドを置き換えた検証済みコピーを返します。
`LineProbeSpec.validate`	インスタンスメソッド	この line-Probe 仕様の検証上の問題を返します。
`MultiPointProbeSpec.validate`	インスタンスメソッド	この仕様の検証上の問題を返します。
`MultiPointProbeSpec.to_dict`	インスタンスメソッド	この仕様をバージョン付き辞書へシリアライズします。
`MultiPointProbeSpec.to_json`	インスタンスメソッド	この仕様をバージョン付き JSON 文書へシリアライズします。
`MultiPointProbeSpec.from_dict`	クラスメソッド	マッピングペイロードから検証済み仕様を作成します。
`MultiPointProbeSpec.from_json`	クラスメソッド	JSON 文書から検証済み仕様を作成します。
`MultiPointProbeSpec.copy_with`	インスタンスメソッド	指定フィールドを置き換えた検証済みコピーを返します。
`ProbeType`	クラス	サポートされる Probe ジオメトリ型を識別します。
`ProbeRegionKind`	クラス	サポートされる Abaqus ターゲットリポジトリの種類を識別します。
`ProbeRegion`	クラス	1つの Probe ターゲットリポジトリとその名前を表すポータブル選択。
`PointProbeSpec`	クラス	ポータブル point-Probe 仕様。
`LineProbeSpec`	クラス	ポータブル line-Probe 仕様。
`MultiPointProbeSpec`	クラス	ポータブル multi-point-Probe 仕様。

2.1 `ProbeType`

オブジェクトパス: coreform.probe.specs.ProbeType

サポートされる Probe ジオメトリ型を識別します。

2.1.1 属性

名前	型	値	説明
`POINT`	`ProbeType`	`'PointProbe'`	1つの位置で評価する point Probe。
`LINE`	`ProbeType`	`'LineProbe'`	2端点間をサンプリングする line Probe。
`MULTI_POINT`	`ProbeType`	`'MultiPointProbe'`	明示的な位置で評価する multi-point Probe。

2.2 `ProbeRegionKind`

オブジェクトパス: coreform.probe.specs.ProbeRegionKind

サポートされる Abaqus ターゲットリポジトリの種類を識別します。

2.2.1 属性

名前	型	値	説明
`INSTANCES`	`ProbeRegionKind`	`'instances'`	名前付き assembly instance をターゲットにします。
`SETS`	`ProbeRegionKind`	`'sets'`	名前付き assembly set をターゲットにします。
`PARTS`	`ProbeRegionKind`	`'parts'`	名前付き model part をターゲットにします。

2.3 `ProbeRegion`

オブジェクトパス: coreform.probe.specs.ProbeRegion

1つの Probe ターゲットリポジトリとその名前を表すポータブル選択。

呼び出し構文

result = ProbeRegion(kind=kind, names=names)

シグネチャ

ProbeRegion(kind: ProbeRegionKind = None, names: Tuple[str, ...] = tuple())

パラメータ

名前	型	必須	既定値	説明
`kind`	`ProbeRegionKind`	はい	—	ターゲットリポジトリの種類。
`names`	`Tuple[str, ...]`	はい	—	1つ以上のターゲット名。

2.3.1 属性

名前	型	値	説明
`schemaVersion`	`int`	`0`	シリアライズされた仕様スキーマのバージョン。
`kind`	`ProbeRegionKind`	`None`	ターゲットリポジトリの種類。
`names`	`Tuple[str, ...]`	`field(default_factory=tuple, metadata={'required': True})`	1つ以上のターゲット名。

2.3.2 `validate`

定義先: coreform.probe.specs.ProbeRegion.validate

説明: この仕様の検証上の問題を返します。

呼び出し構文

result = spec.validate()

戻り値

型	説明
`Tuple[ValidationIssue, ...]`	検出されたすべての問題。仕様が有効な場合は空のタプル。

シグネチャ

validate() -> Tuple[ValidationIssue, ...]

パラメータ

なし。

2.3.3 `to_dict`

定義先: coreform.probe.specs.ProbeRegion.to_dict

説明: この仕様をバージョン付き辞書へシリアライズします。

呼び出し構文

result = spec.to_dict()

戻り値

型	説明
`Dict[str, Any]`	トップレベルのスキーマメタデータを含む正規仕様フィールド。

シグネチャ

to_dict() -> Dict[str, Any]

パラメータ

なし。

2.3.4 `to_json`

定義先: coreform.probe.specs.ProbeRegion.to_json

説明: この仕様をバージョン付き JSON 文書へシリアライズします。

呼び出し構文

result = spec.to_json()

戻り値

型	説明
`str`	この仕様のバージョン付き JSON 表現。

シグネチャ

to_json(indent: Optional[int] = 2) -> str

パラメータ

名前	型	必須	既定値	説明
`indent`	`Optional[int]`	いいえ	`2`	JSON のインデントに使用する空白数。コンパクトな JSON の場合は `None` を指定します。

2.3.5 `from_json`

定義先: coreform.probe.specs.ProbeRegion.from_json

説明: JSON 文書から検証済み仕様を作成します。

呼び出し構文

result = ProbeRegion.from_json(text=text)

戻り値

型	説明
`CoreformSpec`	具体的な仕様クラスの検証済みインスタンス。

シグネチャ

from_json(text: str) -> ProbeRegion

パラメータ

名前	型	必須	既定値	説明
`text`	`str`	はい	—	バージョン付き JSON 仕様文書。

2.3.6 `copy_with`

定義先: coreform.probe.specs.ProbeRegion.copy_with

説明: 指定フィールドを置き換えた検証済みコピーを返します。

呼び出し構文

result = spec.copy_with(...)

戻り値

型	説明
`CoreformSpec`	同じ具体的な仕様型の検証済みコピー。

シグネチャ

copy_with(**kwargs: Any) -> CoreformSpec

パラメータ

名前	型	必須	既定値	説明
`kwargs`	`Any`	いいえ	—	仕様フィールドとその置換値。

2.3.7 `instances`

定義先: coreform.probe.specs.ProbeRegion.instances

説明: 名前付き instance をターゲットとする領域を作成します。

呼び出し構文

result = ProbeRegion.instances(names=names)

戻り値

型	説明
`ProbeRegion`	名前付き instance をターゲットとする領域を作成します。

シグネチャ

instances(names: Iterable[str]) -> 'ProbeRegion'

パラメータ

名前	型	必須	既定値	説明
`names`	`Iterable[str]`	はい	—	1つ以上の assembly instance 名。

2.3.8 `sets`

定義先: coreform.probe.specs.ProbeRegion.sets

説明: 名前付き set をターゲットとする領域を作成します。

呼び出し構文

result = ProbeRegion.sets(names=names)

戻り値

型	説明
`ProbeRegion`	名前付き set をターゲットとする領域を作成します。

シグネチャ

sets(names: Iterable[str]) -> 'ProbeRegion'

パラメータ

名前	型	必須	既定値	説明
`names`	`Iterable[str]`	はい	—	1つ以上の assembly set 名。

2.3.9 `parts`

定義先: coreform.probe.specs.ProbeRegion.parts

説明: 名前付き part をターゲットとする領域を作成します。

呼び出し構文

result = ProbeRegion.parts(names=names)

戻り値

型	説明
`ProbeRegion`	名前付き part をターゲットとする領域を作成します。

シグネチャ

parts(names: Iterable[str]) -> 'ProbeRegion'

パラメータ

名前	型	必須	既定値	説明
`names`	`Iterable[str]`	はい	—	1つ以上の model part 名。

2.3.10 `from_dict`

定義先: coreform.probe.specs.ProbeRegion.from_dict

説明: マッピングペイロードから検証済み Probe 領域を作成します。

呼び出し構文

result = ProbeRegion.from_dict(payload=payload)

戻り値

型	説明
`ProbeRegion`	マッピングペイロードから検証済み Probe 領域を作成します。

シグネチャ

from_dict(payload: Mapping[str, Any]) -> 'ProbeRegion'

パラメータ

名前	型	必須	既定値	説明
`payload`	`Mapping[str, Any]`	はい	—	検証および読み込みに使用する領域の種類とターゲット名。

2.4 `PointProbeSpec`

オブジェクトパス: coreform.probe.specs.PointProbeSpec

ポータブル point-Probe 仕様。

呼び出し構文

result = PointProbeSpec(name=name, region=region, location=location)

シグネチャ

PointProbeSpec(name: str = None, region: ProbeRegion = None, variables: Tuple[str, ...] = tuple(), location: Point3D = None)

パラメータ

名前	型	必須	既定値	説明
`name`	`str`	はい	—	一意で空でない Probe 名。
`region`	`ProbeRegion`	はい	—	ポータブルなターゲット選択。
`variables`	`Tuple[str, ...]`	いいえ	`()`	出力変数名。既定値は空のタプル。
`location`	`Point3D`	はい	—	評価位置。

2.4.1 属性

名前	型	値	説明
`schemaVersion`	`int`	`0`	シリアライズされた仕様スキーマのバージョン。
`name`	`str`	`None`	一意で空でない Probe 名。
`region`	`ProbeRegion`	`None`	ポータブルなターゲット選択。
`variables`	`Tuple[str, ...]`	`()`	出力変数名。既定値は空のタプル。
`location`	`Point3D`	`None`	評価位置。
`probeType`	`ProbeType`	`ProbeType.POINT`	Point-Probe の型識別子。

2.4.2 `validate`

定義先: coreform.probe.specs.PointProbeSpec.validate

説明: この仕様の検証上の問題を返します。

呼び出し構文

result = spec.validate()

戻り値

型	説明
`Tuple[ValidationIssue, ...]`	検出されたすべての問題。仕様が有効な場合は空のタプル。

シグネチャ

validate() -> Tuple[ValidationIssue, ...]

パラメータ

なし。

2.4.3 `to_dict`

定義先: coreform.probe.specs.PointProbeSpec.to_dict

説明: この仕様をバージョン付き辞書へシリアライズします。

呼び出し構文

result = spec.to_dict()

戻り値

型	説明
`Dict[str, Any]`	トップレベルのスキーマメタデータを含む正規仕様フィールド。

シグネチャ

to_dict() -> Dict[str, Any]

パラメータ

なし。

2.4.4 `to_json`

定義先: coreform.probe.specs.PointProbeSpec.to_json

説明: この仕様をバージョン付き JSON 文書へシリアライズします。

呼び出し構文

result = spec.to_json()

戻り値

型	説明
`str`	この仕様のバージョン付き JSON 表現。

シグネチャ

to_json(indent: Optional[int] = 2) -> str

パラメータ

名前	型	必須	既定値	説明
`indent`	`Optional[int]`	いいえ	`2`	JSON のインデントに使用する空白数。コンパクトな JSON の場合は `None` を指定します。

2.4.5 `from_dict`

定義先: coreform.probe.specs.PointProbeSpec.from_dict

説明: マッピングペイロードから検証済み仕様を作成します。

呼び出し構文

result = PointProbeSpec.from_dict(payload=payload)

戻り値

型	説明
`CoreformSpec`	具体的な仕様クラスの検証済みインスタンス。

シグネチャ

from_dict(payload: Mapping[str, Any]) -> PointProbeSpec

パラメータ

名前	型	必須	既定値	説明
`payload`	`Mapping[str, Any]`	はい	—	検証および読み込みに使用するバージョン付き仕様フィールド。

2.4.6 `from_json`

定義先: coreform.probe.specs.PointProbeSpec.from_json

説明: JSON 文書から検証済み仕様を作成します。

呼び出し構文

result = PointProbeSpec.from_json(text=text)

戻り値

型	説明
`CoreformSpec`	具体的な仕様クラスの検証済みインスタンス。

シグネチャ

from_json(text: str) -> PointProbeSpec

パラメータ

名前	型	必須	既定値	説明
`text`	`str`	はい	—	バージョン付き JSON 仕様文書。

2.4.7 `copy_with`

定義先: coreform.probe.specs.PointProbeSpec.copy_with

説明: 指定フィールドを置き換えた検証済みコピーを返します。

呼び出し構文

result = spec.copy_with(...)

戻り値

型	説明
`CoreformSpec`	同じ具体的な仕様型の検証済みコピー。

シグネチャ

copy_with(**kwargs: Any) -> CoreformSpec

パラメータ

名前	型	必須	既定値	説明
`kwargs`	`Any`	いいえ	—	仕様フィールドとその置換値。

2.5 `LineProbeSpec`

オブジェクトパス: coreform.probe.specs.LineProbeSpec

ポータブル line-Probe 仕様。

呼び出し構文

result = LineProbeSpec(name=name, region=region, start_location=start_location, stop_location=stop_location)

シグネチャ

LineProbeSpec(name: str = None, region: ProbeRegion = None, variables: Tuple[str, ...] = tuple(), start_location: Point3D = None, stop_location: Point3D = None, num_eval_points: int = 2)

パラメータ

名前	型	必須	既定値	説明
`name`	`str`	はい	—	一意で空でない Probe 名。
`region`	`ProbeRegion`	はい	—	ポータブルなターゲット選択。
`variables`	`Tuple[str, ...]`	いいえ	`()`	出力変数名。既定値は空のタプル。
`start_location`	`Point3D`	はい	—	線分の第1端点。
`stop_location`	`Point3D`	はい	—	第2端点。start_location と異なる必要があります。
`num_eval_points`	`int`	いいえ	`2`	両端点を含む評価点数。2以上である必要があります。

2.5.1 属性

名前	型	値	説明
`schemaVersion`	`int`	`0`	シリアライズされた仕様スキーマのバージョン。
`name`	`str`	`None`	一意で空でない Probe 名。
`region`	`ProbeRegion`	`None`	ポータブルなターゲット選択。
`variables`	`Tuple[str, ...]`	`()`	出力変数名。既定値は空のタプル。
`start_location`	`Point3D`	`None`	線分の第1端点。
`stop_location`	`Point3D`	`None`	第2端点。start_location と異なる必要があります。
`num_eval_points`	`int`	`2`	両端点を含む評価点数。2以上である必要があります。
`probeType`	`ProbeType`	`ProbeType.LINE`	Line-Probe の型識別子。

2.5.2 `to_dict`

定義先: coreform.probe.specs.LineProbeSpec.to_dict

説明: この仕様をバージョン付き辞書へシリアライズします。

呼び出し構文

result = spec.to_dict()

戻り値

型	説明
`Dict[str, Any]`	トップレベルのスキーマメタデータを含む正規仕様フィールド。

シグネチャ

to_dict() -> Dict[str, Any]

パラメータ

なし。

2.5.3 `to_json`

定義先: coreform.probe.specs.LineProbeSpec.to_json

説明: この仕様をバージョン付き JSON 文書へシリアライズします。

呼び出し構文

result = spec.to_json()

戻り値

型	説明
`str`	この仕様のバージョン付き JSON 表現。

シグネチャ

to_json(indent: Optional[int] = 2) -> str

パラメータ

名前	型	必須	既定値	説明
`indent`	`Optional[int]`	いいえ	`2`	JSON のインデントに使用する空白数。コンパクトな JSON の場合は `None` を指定します。

2.5.4 `from_dict`

定義先: coreform.probe.specs.LineProbeSpec.from_dict

説明: マッピングペイロードから検証済み仕様を作成します。

呼び出し構文

result = LineProbeSpec.from_dict(payload=payload)

戻り値

型	説明
`CoreformSpec`	具体的な仕様クラスの検証済みインスタンス。

シグネチャ

from_dict(payload: Mapping[str, Any]) -> LineProbeSpec

パラメータ

名前	型	必須	既定値	説明
`payload`	`Mapping[str, Any]`	はい	—	検証および読み込みに使用するバージョン付き仕様フィールド。

2.5.5 `from_json`

定義先: coreform.probe.specs.LineProbeSpec.from_json

説明: JSON 文書から検証済み仕様を作成します。

呼び出し構文

result = LineProbeSpec.from_json(text=text)

戻り値

型	説明
`CoreformSpec`	具体的な仕様クラスの検証済みインスタンス。

シグネチャ

from_json(text: str) -> LineProbeSpec

パラメータ

名前	型	必須	既定値	説明
`text`	`str`	はい	—	バージョン付き JSON 仕様文書。

2.5.6 `copy_with`

定義先: coreform.probe.specs.LineProbeSpec.copy_with

説明: 指定フィールドを置き換えた検証済みコピーを返します。

呼び出し構文

result = spec.copy_with(...)

戻り値

型	説明
`CoreformSpec`	同じ具体的な仕様型の検証済みコピー。

シグネチャ

copy_with(**kwargs: Any) -> CoreformSpec

パラメータ

名前	型	必須	既定値	説明
`kwargs`	`Any`	いいえ	—	仕様フィールドとその置換値。

2.5.7 `validate`

定義先: coreform.probe.specs.LineProbeSpec.validate

説明: この line-Probe 仕様の検証上の問題を返します。

呼び出し構文

result = spec.validate()

戻り値

型	説明
`Tuple[ValidationIssue, ...]`	この line-Probe 仕様の検証上の問題を返します。

シグネチャ

validate() -> Tuple[ValidationIssue, ...]

パラメータ

なし。

2.6 `MultiPointProbeSpec`

オブジェクトパス: coreform.probe.specs.MultiPointProbeSpec

ポータブル multi-point-Probe 仕様。

呼び出し構文

result = MultiPointProbeSpec(name=name, region=region, locations=locations)

シグネチャ

MultiPointProbeSpec(name: str = None, region: ProbeRegion = None, variables: Tuple[str, ...] = tuple(), locations: Tuple[Point3D, ...] = tuple())

パラメータ

名前	型	必須	既定値	説明
`name`	`str`	はい	—	一意で空でない Probe 名。
`region`	`ProbeRegion`	はい	—	ポータブルなターゲット選択。
`variables`	`Tuple[str, ...]`	いいえ	`()`	出力変数名。既定値は空のタプル。
`locations`	`Tuple[Point3D, ...]`	はい	—	1つ以上の明示的な評価位置。

2.6.1 属性

名前	型	値	説明
`schemaVersion`	`int`	`0`	シリアライズされた仕様スキーマのバージョン。
`name`	`str`	`None`	一意で空でない Probe 名。
`region`	`ProbeRegion`	`None`	ポータブルなターゲット選択。
`variables`	`Tuple[str, ...]`	`()`	出力変数名。既定値は空のタプル。
`locations`	`Tuple[Point3D, ...]`	`field(default_factory=tuple, metadata={'required': True})`	1つ以上の明示的な評価位置。
`probeType`	`ProbeType`	`ProbeType.MULTI_POINT`	Multi-point-Probe の型識別子。

2.6.2 `validate`

定義先: coreform.probe.specs.MultiPointProbeSpec.validate

説明: この仕様の検証上の問題を返します。

呼び出し構文

result = spec.validate()

戻り値

型	説明
`Tuple[ValidationIssue, ...]`	検出されたすべての問題。仕様が有効な場合は空のタプル。

シグネチャ

validate() -> Tuple[ValidationIssue, ...]

パラメータ

なし。

2.6.3 `to_dict`

定義先: coreform.probe.specs.MultiPointProbeSpec.to_dict

説明: この仕様をバージョン付き辞書へシリアライズします。

呼び出し構文

result = spec.to_dict()

戻り値

型	説明
`Dict[str, Any]`	トップレベルのスキーマメタデータを含む正規仕様フィールド。

シグネチャ

to_dict() -> Dict[str, Any]

パラメータ

なし。

2.6.4 `to_json`

定義先: coreform.probe.specs.MultiPointProbeSpec.to_json

説明: この仕様をバージョン付き JSON 文書へシリアライズします。

呼び出し構文

result = spec.to_json()

戻り値

型	説明
`str`	この仕様のバージョン付き JSON 表現。

シグネチャ

to_json(indent: Optional[int] = 2) -> str

パラメータ

名前	型	必須	既定値	説明
`indent`	`Optional[int]`	いいえ	`2`	JSON のインデントに使用する空白数。コンパクトな JSON の場合は `None` を指定します。

2.6.5 `from_dict`

定義先: coreform.probe.specs.MultiPointProbeSpec.from_dict

説明: マッピングペイロードから検証済み仕様を作成します。

呼び出し構文

result = MultiPointProbeSpec.from_dict(payload=payload)

戻り値

型	説明
`CoreformSpec`	具体的な仕様クラスの検証済みインスタンス。

シグネチャ

from_dict(payload: Mapping[str, Any]) -> MultiPointProbeSpec

パラメータ

名前	型	必須	既定値	説明
`payload`	`Mapping[str, Any]`	はい	—	検証および読み込みに使用するバージョン付き仕様フィールド。

2.6.6 `from_json`

定義先: coreform.probe.specs.MultiPointProbeSpec.from_json

説明: JSON 文書から検証済み仕様を作成します。

呼び出し構文

result = MultiPointProbeSpec.from_json(text=text)

戻り値

型	説明
`CoreformSpec`	具体的な仕様クラスの検証済みインスタンス。

シグネチャ

from_json(text: str) -> MultiPointProbeSpec

パラメータ

名前	型	必須	既定値	説明
`text`	`str`	はい	—	バージョン付き JSON 仕様文書。

2.6.7 `copy_with`

定義先: coreform.probe.specs.MultiPointProbeSpec.copy_with

説明: 指定フィールドを置き換えた検証済みコピーを返します。

呼び出し構文

result = spec.copy_with(...)

戻り値

型	説明
`CoreformSpec`	同じ具体的な仕様型の検証済みコピー。

シグネチャ

copy_with(**kwargs: Any) -> CoreformSpec

パラメータ

名前	型	必須	既定値	説明
`kwargs`	`Any`	いいえ	—	仕様フィールドとその置換値。

2.7 `ProbeSpec`

オブジェクトパス: coreform.probe.specs.ProbeSpec

型: Union[PointProbeSpec, LineProbeSpec, MultiPointProbeSpec]

サポートされる任意のポータブル Probe 仕様。

ディレクトリツリー

1 model.py

1.1 IGAProbe

1.1.1 属性

1.1.2 point

1.1.3 line

1.1.4 multi_point

1.1.5 from_spec

1.1.6 to_spec

1.1.7 copy_with

1.1.8 is_point

1.1.9 is_line

1.1.10 is_multi_point

2 specs.py

2.1 ProbeType

2.1.1 属性

2.2 ProbeRegionKind

2.2.1 属性

2.3 ProbeRegion

2.3.1 属性

2.3.2 validate

2.3.3 to_dict

2.3.4 to_json

2.3.5 from_json

2.3.6 copy_with

2.3.7 instances

2.3.8 sets

2.3.9 parts

2.3.10 from_dict

2.4 PointProbeSpec

2.4.1 属性

2.4.2 validate

2.4.3 to_dict

2.4.4 to_json

2.4.5 from_dict

2.4.6 from_json

2.4.7 copy_with

2.5 LineProbeSpec

2.5.1 属性

2.5.2 to_dict

2.5.3 to_json

2.5.4 from_dict

2.5.5 from_json

2.5.6 copy_with

2.5.7 validate

2.6 MultiPointProbeSpec

2.6.1 属性

2.6.2 validate

2.6.3 to_dict

2.6.4 to_json

2.6.5 from_dict

2.6.6 from_json

2.6.7 copy_with

2.7 ProbeSpec

1.1 `IGAProbe`

1.1.2 `point`

1.1.3 `line`

1.1.4 `multi_point`

1.1.5 `from_spec`

1.1.6 `to_spec`

1.1.7 `copy_with`

1.1.8 `is_point`

1.1.9 `is_line`

1.1.10 `is_multi_point`

2.1 `ProbeType`

2.2 `ProbeRegionKind`

2.3 `ProbeRegion`

2.3.2 `validate`

2.3.3 `to_dict`

2.3.4 `to_json`

2.3.5 `from_json`

2.3.6 `copy_with`

2.3.7 `instances`

2.3.8 `sets`

2.3.9 `parts`

2.3.10 `from_dict`

2.4 `PointProbeSpec`

2.4.2 `validate`

2.4.3 `to_dict`

2.4.4 `to_json`

2.4.5 `from_dict`

2.4.6 `from_json`

2.4.7 `copy_with`

2.5 `LineProbeSpec`

2.5.2 `to_dict`

2.5.3 `to_json`

2.5.4 `from_dict`

2.5.5 `from_json`

2.5.6 `copy_with`

2.5.7 `validate`

2.6 `MultiPointProbeSpec`

2.6.2 `validate`

2.6.3 `to_dict`

2.6.4 `to_json`

2.6.5 `from_dict`

2.6.6 `from_json`

2.6.7 `copy_with`

2.7 `ProbeSpec`