クラス: cst.results.ProjectFile のメンバー
関数名	内容
print_version_info()	モジュールのバージョン情報を表示する．
get_version_info	モジュールのバージョン情報を辞書として取得する．

クラス

モジュール: cst.results には，3個のクラス (ProjectFile, ResultModule, ResultItem) が含まれます．ここでは，これらのクラスのメンバーについて説明します．

このクラスは、CSTのプロジェクトファイル (*.cst) を読み込むための中心的なクラスです．プロジェクトを開いて，結果データにアクセスするための窓口の役割を果たします．主な役割は以下の通りです．

クラス: cst.results.ProjectFile のメンバー
種類	メンバー名	内容
メソッド	__init__(args, *kwargs)	コンストラクタです．通常，引数はプロジェクトファイル(*.cst)のパスです．
プロパティ	filename	戻り値は，プロジェクトのファイ(*.cst) のパスです．
メソッド	get_3d()	戻り値は，CST Studio の project のサブモジュール (ResultModule) のインスタンスです．
メソッド	get_schematic()	戻り値は，CST Studio の Schematic のサブモジュール (ResultModule) のインスタンスです．
メソッド	init(filepath, allow_interactive=False)	既存のインスタンスにプロジェクトファイルを後から設定・初期化します．
メソッド	list_subprojects()	プロジェクト内に含まれるサブプロジェクト（Simulation Project Tasks等）のツリーパスを一覧で返します．
メソッド	load_subproject(treepath)	指定したツリーパスのサブプロジェクトをロードし，新しい ProjectFile のインスタンスを返します．

init()がある理由は，「p = ProjectFile()」のように空のインスタンスを作成し「p.init(r"e:\foo\bar.cst")」を使い，あとからプロジェクトファイルの指定を可能にするためです．

このクラスを使うためのインスタンスは，ResultModule.get_3d() と ResultModule.get_schematic() の戻り値です．このクラスには__init()__ がなく，ユーザーが直接インスタンスを作ることが出来ません．

このクラス: ResultModuleは，プロジェクト内の結果データ (1D/0D) を一覧・取得するためのインターフェースです．主な役割は以下の通りです．

ナビゲーションツリーから結果項目をリスト化する [get_tree_items()]．
結果を取得する [get_result_item()]
パラメトリック解析の Run ID やパラメータを取得する [get_all_run_ids(), get_run_ids(), get_parameter_combination()]．

簡単に言えば，特定の結果フォルダ (3D結果やスケマティック結果) を操作するクラスです．

クラス: cst.results.ResultModule のメンバー
種類	メンバー名	内容
メソッド	get_all_run_ids(max_mesh_passes_only=True)	プロジェクト内の全てのRun ID（解析パターン）を取得します。メッシュ適応時は最大パスのみを返す設定が可能です。
メソッド	get_parameter_combination(run_id)	指定したRun IDに対応するパラメータの組み合わせを辞書で返します。
メソッド	get_result_item(treepath, run_id=0, load_impedances=True)	戻り値は，CST Studio の project のサブモジュール (ResultItem) のインスタンスです．
メソッド	get_run_ids(treepath, skip_nonparametric=False)	指定したツリー項目に関連する全Run IDを取得します。
メソッド	get_tree_items(filter='0D/1D')	ナビゲーションツリー内の項目を一覧で取得します。フィルターで0D/1Dのみなど指定可能です。

このクラスを使うためのインスタンスは，ResultModule.get_result_item() の戻り値です．このクラスには__init()__ がなく，ユーザーが直接インスタンスを作ることが出来ません．

ResultItem は，ひとつの解析結果 (1D/0D) のデータを表すクラスです．主な役割は以下の通りです．

簡単に言うと，特定のシミュレーション結果の内容を取り出すためのハンドルです．このクラスのメンバーを以下の表に示します．

クラス: cst.results.ResultItem のメンバー
種類	メンバー名	内容
メソッド	get_data()	結果データをリスト (タプル形式) や数値として取得します．
メソッド	get_parameter_combination()	この結果に対応するパラメータの組み合わせを辞書で返します．
メソッド	get_ref_imp_data()	結果の基準インピーダンスを取得します．
メソッド	get_xdata()	x軸のデータをリストで取得します．
メソッド	get_ydata()	y軸のデータをリストまたは数値で取得します．
プロパティ	length	y軸データの点の数を返します．
プロパティ	run_id	この結果が属するRun IDを返します．
プロパティ	title	結果のタイトル (名前) を文字列で返します．
プロパティ	treepath	ナビゲーションツリー上のパスを文字列で返します．
プロパティ	xlabel	x軸ラベル (単位付き) を文字列で返します．
プロパティ	ylabel	y軸ラベル (単位付き) を文字列で返します．

ページ作成情報

2025年06月26日

ページの新規作成