マクロファイルの構造

構造

マクロを定義するファイル（*.py）の構造を下の例で示します。

パート 説明
1 実行可能なFluxプログラムのヘッダー
2 マクロの入力パラメータの記述
3 PyFlux言語のパラメータ化関数の定義

（1）プログラムヘッダー

Fluxプログラムヘッダーは必須です。マクロを実行するFluxプログラム（2Dおよび / または3D）とそのバージョン*を指定します。

注: * 指定するバージョンは、現在のソフトウェアバージョンと一致させることも、以前のバージョンにすることもできます。

（2）パラメータの記述

2つ目の部分では、マクロの入力パラメータの記述について説明します。

パラメータごとに、以下を定義する必要があります：

  • パラメータ名
  • PyFluxタイプ
  • 最小と最大のカーディナリティ（データ構造に対応する最小値と最大値の数）
  • デフォルト値またはキーワードNone

  • パラメータに関連するラベル

    （このラベルは、実行中のマクロのダイアログボックスに表示されます。）

（3）パラメータ化関数

2つ目の部分では、パラメータ化関数の説明を取り上げます。

この関数では、以下を定義する必要があります：

  • 関数名（=マクロの名前）
  • 関数の入力パラメータ
  • 関数の本体（PyFlux命令）