スクリプトによる設計タスクの自動化
概略
- スクリプトプロジェクト、単体のスクリプトユニット、ダイアログベースのスクリプトフォームの構成について学びます。
- スクリプトのデバッグツールと、メニュー、ツールバー、ショートカットからスクリプトを実行する方法を紹介します。
- スクリプトのサンプルや言語サポートに関する情報に加え、従来のスクリプトを使用する際に考慮すべき制限事項を確認できます。
スクリプティングは、Altium Designerでの作業の幅を広げ、生産性を高める強力な手段です。スクリプトには一連の命令(自動化されたコマンド)が含まれ、Altium Designerでの実行時に解釈されます。スクリプトは複数の言語で記述でき、高度なダイアログを組み込むことも、Altium Designer内でデバッグすることもできます。スクリプトを使用すると、ユーザー入力を最小限に抑え、キー操作やマウスクリックを減らして設計の目的を達成できます。
スクリプトを使用すると、繰り返し作業を自動化したり、Altium Designerの既存のコマンドでは対応できない編集を行ったりできます。たとえば、スクリプトを使用してPCBドキュメント内のフィデューシャルマークを検索して更新したり、カスタマイズしたネットリストをエクスポートしたりできます。
スクリプトは、スクリプトプロジェクトまたは設計プロジェクトに保存できます。Altium Designerでは、複数のスクリプト言語を使用してスクリプトを記述できます。
スクリプティングシステムの概要と設定
Altium Designerのスクリプティングシステムには、ソフトウェア内の作業を自動化するスクリプトの作成に必要なツールと機能がすべて用意されています。
スクリプトを記述することで、繰り返し作業の自動化やAltium Designerの機能の拡張が可能です。スクリプティングシステムは、主にエディターとデバッガーの2つの部分で構成されています。スクリプトエディター、デバッガー、スクリプティング用パネルが連携し、スクリプトの記述とデバッグを容易にします。スクリプトはスクリプトエディターから直接実行できるほか、メニュー、ツールバー、ホットキーに割り当てることで、PCBなどの現在のドキュメントにいつでも適用できます。
► 詳細:Altium Designerのスクリプティングシステム
スクリプトの作成と保存
Altium Designerのスクリプトは通常、スクリプトプロジェクト(*.PrjScr)内に作成して保存しますが、どの種類のプロジェクトにも追加または保存できます。
スクリプトの記述を始めるには、まず新しいスクリプトプロジェクトを作成し、そのプロジェクトにスクリプトファイルを追加します。
スクリプトプロジェクトはスクリプトの管理に役立ち、メインメニューからFile » New » Project » Script Projectを選択して作成できます。新しいプロジェクトがProjectsパネルに表示されます。プロジェクトに新しいスクリプトを追加するには、プロジェクト名を右クリックし、コンテキストメニューからAdd New to Projectを選択します。
新しいスクリプトを作成する際は、プロジェクトの要件に応じて、スクリプトユニットとスクリプトフォームの2種類から選択できます。スクリプトユニットでは、単独で使用するプロシージャや関数を記述できます。スクリプトフォームでは、プロシージャや関数に加えて、コントロールやイベントハンドラーを備えたダイアログを作成できます。
► 詳細:Altium Designerでのスクリプトの作成と保存
スクリプトの記述
スクリプトの記述には、次のような重要な概念と用語があります。
-
プロセスは、スクリプト内でコマンドを実行するために使用できるコマンド文字列です。
-
コンポーネントは、Tool Paletteパネルにある視覚的なコントロールオブジェクトです。スクリプトフォームにドラッグ&ドロップして、設計を操作するために使用できます。
-
スクリプトフォームに配置したコンポーネントには、メソッド、プロパティ 、イベントがあります。
-
オブジェクトインターフェースは、スクリプトから設計ドキュメント上のデータを抽出および変更するために使用できる特別なオブジェクトインターフェースです。
デフォルトのスクリプト言語はDelphiScript(*.pas)に設定されています。スクリプトエンジン自体はEmbarcadero Delphiで記述されており、Tool PaletteパネルはDelphiのVCL(Visual Component Library)をベースにしています。
► 詳細:Altium Designerでのスクリプトの記述
スクリプトの編集・デバッグツール
Altium Designerのスクリプティングシステムは、主にエディターとデバッガーの2つの部分で構成されています。エディターには、スクリプトコードの記述支援機能や検査機能が各種用意されており、デバッガーではスクリプトコンポーネントやデバッグ機能にアクセスできます。スクリプトエディターのツールは、スクリプトのデバッグに大いに役立ちます。
スクリプティングシステムには、スクリプトのデバッグを支援するさまざまなツールがあります。スクリプト内への複数のブレークポイントの設定、Watch Listパネルを使用した変数の値の監視、ブックマークを使用した効率的な移動、ステップインやステップオーバー機能を使用したスクリプトの実行の追跡などが可能です。
► 詳細:Altium Designerのスクリプト編集ツール
► 詳細:Altium Designerでのスクリプトのデバッグ
スクリプトの実行
Altium Designerのスクリプティングシステムでは、Altium Designer向けに高度な自動化処理を作成できますが、作成したスクリプトには設計作業中に簡単にアクセスできる必要もあります。たとえば、PCBの編集中に複雑な一連の操作を行うために作成したスクリプトは、PCBエディター内ですぐに利用でき、1~2回のマウスクリックで実行できることが望まれます。
Altium Designerでは、スクリプトをプロセスランチャーに割り当てることで、これを実現します。これにより、スクリプトをメニュー、ツールバー、ショートカットに割り当て可能なコマンドとして使用できます。
スクリプトエディターで開いているスクリプトは、エディターのRunコマンドで実行できます。ただし、この方法ではAltium Designerでスクリプトプロジェクトを開いておく必要があるため、たとえばPCB設計作業中に必要なスクリプトにアクセスする方法としては便利ではありません。別の方法として、Select Item To Runダイアログ(File » Run Script)で、ローカルハードドライブまたは接続先のWorkspaceにあるスクリプトを参照し、目的のプロセスを実行できます。スクリプトは現在のセッション中、読み込まれたままになります。
よく使用するスクリプトにアクセスするには、PreferencesダイアログのScripting System – Global Projectsページから、そのプロジェクトをグローバルプロジェクトとしてインストールする方法がより適しています。この場合、Altium Designerの起動時にプロジェクトが自動的に読み込まれ、File » Run Scriptコマンドからいつでも実行できます。
► 詳細:Altium Designerでのスクリプトの実行
スクリプト用グラフィカルコンポーネント
Altium Designerのスクリプトで使用できるビジュアルフォームコンポーネントの多くは、EmbarcaderoのVisual Component Library(VCL)に由来します。VCLは、DelphiおよびC++言語を使用してWindowsアプリケーションを開発するために定義されたビジュアルコンポーネントのコレクションです。
ビジュアルクラスライブラリとして開発されたVCLのクラスは、直線的なオブジェクト階層においてTComponentオブジェクトから派生しています(このオブジェクト自体は、ルートオブジェクトであるTObjectから派生しています)。そのため、TButtonオブジェクトなどの一般的なスクリプトコンポーネントは、上位オブジェクトのプロパティ、メソッド、イベントを継承します。この場合のクラス階層は、TObject → TPersistent → TComponent → TControl → TWinControl → TButtonControl → TButtonです。
TControlオブジェクトから派生するコンポーネントは通常、ビジュアルコンポーネント(コントロール)であり、TWinControlから派生する一般的なコンポーネントの多くはWindows APIのラッパーであることに注意してください。
Altium Designerのスクリプトエディターでフォームを作成する際は、Tool Paletteパネルからコンポーネントにアクセスします。スクリプトフォームには、フォームの構成、コンポーネントの配置、その他の属性の詳細を含む*.DFMファイルが関連付けられています。このファイルは、スクリプトプロジェクトの保存先フォルダーにあります。Altium Designerでは、スクリプトフォームの設計時に、DelphiScriptまたはVBScriptのどちらからでもコンポーネントを使用できます。
► 詳細:Altium Designerのスクリプト用グラフィカルコンポーネント
スクリプトの例
スクリプトシステムの全般的な仕組みと、スクリプトでのDelphiおよびX2オブジェクトモデルの使用方法をより深く理解できるように、基板外形のコピーとネットリストの生成を行う2つのサンプルプロジェクトを、機能の観点から解説します。Board Outline CopierスクリプトとNetlisterスクリプトは、Altium Designerのスクリプトシステムの機能を示すために、X2オブジェクトモデルを使用して開発されています。
これらの既存のスクリプトは、Altiumが提供するサンプルのダウンロード から入手できます。このZIPファイルは、Altium Designer 10のリリース時に作成されたものであることに注意してください。ZIPファイル内のScriptsフォルダーには、スクリプト言語別に整理されたサブフォルダーが含まれています。
Altium DesignerのGitHubコレクションには、さまざまな便利なスクリプトが用意されています。
► 詳しくは、Altium Designerのスクリプトサンプルの解析をご覧ください
► 詳しくは、Altium Designerのスクリプトサンプルリファレンスをご覧ください
スクリプト言語のサポート
Altium Designerのスクリプトは、複数のスクリプト言語で記述できます。主要な言語であり、スクリプト関連ドキュメントで最も多く取り上げられているのは、Embarcadero Delphi™と密接な関係にあるDelphiScriptです。






