IProject インターフェース

Overview 
IProject インターフェースは、Altium Designer で開かれているプロジェクトを扱います。プロジェクトバリアントおよびドキュメントバリアントがあり、実際にはプロジェクトまたはドキュメントに対してプロジェクトバリアントまたはドキュメントバリアントを指定できます（実体としてのプロジェクト / ドキュメントバリアントが存在するわけではありません）。そして、これらのドキュメントバリアント上にコンポーネントバリアントを持たせることができます。
プロジェクトのデータにアクセスするには、まずコンパイルを実行する必要があります。プロジェクトは論理ドキュメントと物理ドキュメントを扱います。論理ドキュメントは、設計の一部として相互接続されたドキュメントであり、この設計に関連付けられた PCB ドキュメントを含みます。物理ドキュメントは、フラット化された設計プロジェクトのように、Altium Designer コンパイラによって展開されたソースドキュメントです。
したがって、プロジェクトにはソースドキュメントと実装ドキュメントが含まれます。プロジェクトの最新データにアクセスするには、まずプロジェクトをコンパイルする必要があります。コンパイラは、すべての論理ソースドキュメントを物理ドキュメントへマッピング（または展開）します。
通常、単純なフラット設計プロジェクトでは、1 つの論理ドキュメントに対して 1 つの物理ドキュメントが対応します。しかし、階層設計プロジェクト（たとえばマルチチャネルプロジェクト）では、Repeat ステートメントを持つシートシンボルを含むドキュメントにおいて、論理ドキュメントが複数の物理ドキュメントへ展開されます。
Altium Designer には、利用可能な出力ジェネレータで構成される Output Job があります。

The IProject インターフェース階層は次のとおりです;

メソッド

DM_AddConfigurationParameters method 

(IProject interface)
Syntax 
Procedure DM_AddConfigurationParameters(Configuration : WideString);
Description 
構成は、FPGA プロジェクトのピンとポートのマッピングを管理する制約ファイルのリストです。このメソッドを呼び出すと、FPGA プロジェクト用に指定した構成ファイルのパラメータを追加します。
See also 
IProject interface

DM_AddConfigurationParameters_Physical method 
(IProject interface)
Syntax 
Procedure DM_AddConfigurationParameters_Physical(Configuration : WideString);
Description 
構成は、FPGA プロジェクトのピンとポートのマッピングを管理する制約ファイルのリストです。このメソッドを呼び出すと、FPGA プロジェクト用に指定した構成ファイルのパラメータを追加します。
See also 
IProject interface

DM_AddControlPanel method 
(IProject interface)
Syntax 
Procedure DM_AddControlPanel (Filename : WideString);
Description 
このプロシージャは、プロジェクトの一部であるドキュメント、またはフリードキュメントである可能性のあるドキュメントを、パネルのメインセクションに追加します。
See also 
IProject interface

DM_AddGeneratedDocument method 
(IProject interface)
Syntax 
Procedure DM_AddGeneratedDocument (Filename : WideString);
Description 
このプロシージャは、現在のプロジェクトに filename パラメータで参照される新しい生成ドキュメントを追加し、このドキュメントは Altium Designer の Projects パネルにあるこのプロジェクトのGenerated フォルダに表示されます。
See also 
IProject interface

DM_AddSearchPath method 
(IProject interface)
Syntax 
Procedure DM_AddSearchPath (SearchPath : WideString; IncludeSubFolders : Boolean);
Description 
このプロシージャは、現在のプロジェクトに新しい検索パスを追加します。
See also 
IProject interface

DM_AddSourceDocument method 
(IProject interface)
Syntax 
Procedure DM_AddSourceDocument (Filename : WideString);
Description 
このプロシージャは、現在のプロジェクトに filename パラメータで参照されるソースドキュメントを追加します。
See also 
IProject interface

DM_ChannelDesignatorFormat method 
(IProject interface)
Syntax 
Function DM_ChannelDesignatorFormat : WideString;
Description 
この関数は、書式設定されたチャネルデジグネータ文字列を返します。この文字列は、Project » Project Options メニュー項目から開く Project Options ダイアログの Multi-Channel ページで定義された設定に基づいています。
See also 
IProject interface

DM_ChannelRoomLevelSeperator method 
(IProject interface)
Syntax 
Function DM_ChannelRoomLevelSeperator : WideString;
Description 
この関数は、Channel Room Level 文字列の区切り文字を返します。デフォルトはアンダースコア文字で、パスが存在する場合（階層設計に基づく）にルーム命名スタイルで使用されます。
See also 
IProject interface

DM_ChannelRoomNamingStyle method

(IProject interface)
Syntax 
Function DM_ChannelRoomNamingStyle : TChannelRoomNamingStyle;
Description 
この関数は TChannelRoomNamingStyle 型を返します。PCB ドキュメント上のルーム命名には複数の代替スタイルがあります。
See also 
IProject interface

DM_ClearViolations method 
(IProject interface)
Syntax 
Procedure DM_ClearViolations;
Description 
このプロシージャは、プロジェクト内に存在するすべての違反をクリアします。
See also 
IProject interface

DM_Compile method

(IProject interface)
Syntax 
Function DM_Compile : LongBool;
Description 
現在のプロジェクトをコンパイルするには、この関数を呼び出します。プロジェクトがコンパイルされると、ネットのナビゲーション、ドキュメント間の差分比較、その他のタスクを実行できます。
See also 
IProject interface

DM_CompileEx method 
(IProject interface)
Syntax 
Function DM_CompileEx(All : LongBool; Var Cancelled : LongBool) : LongBool;
Description 
Altium Designer で開いているすべてのプロジェクト内のすべてのドキュメントをコンパイルするには、この関数を呼び出します。コンパイル処理をキャンセルするには、Boolean パラメータを渡します。
See also 
IProject interface

DM_ComponentMappings method 
(IProject interface)
Syntax 
Function DM_ComponentMappings (AnImplementationDocument : WideString) : IComponentMappings;
Description 
この関数は、どの PCB コンポーネントが回路図コンポーネントにリンクされているかの詳細を示す IComponentMapping インターフェースを返します。IComponentMappings インターフェースを確認してください。
See also 
IProject interface

DM_ConfigurationCount method 
(IProject interface)
Syntax 
Function DM_ConfigurationCount : Integer;
Description 
この関数は、現在のプロジェクトの構成数を返します。DM_Configurations 関数と組み合わせて使用します。
Example

See also 
IProject interface

DM_Configurations method 
(IProject interface)
Syntax 
Function DM_Configurations (Index : Integer ) : IConfiguration;
Description 
この関数は、FPGA プロジェクトの指定インデックスの構成を返します。構成には、異なる制約ファイルのリストを含めることができます。
See also 
IProject interface

DM_CurrentProjectVariant method 
(IProject interface)
Syntax 
Function DM_CurrentProjectVariant : IProjectVariant;
Description 
この関数は、この現在のプロジェクトの現在のプロジェクトバリアントを返します。IProjectVariant インターフェースを参照してください。
See also 
IProject interface

DM_DoCrossSelection method 
(IProject interface)
Syntax 
Procedure DM_DoCrossSelection
Description 
クロスプロービング機能を有効にします。これにより、回路図オブジェクトから対応する PCB オブジェクトへジャンプできます（ソース ドキュメントとプライマリ実装ドキュメントの両方が Altium Designer で開かれている必要があります）。
See also 
IProject interface

DM_DocumentFlattened method 
(IProject interface)
Syntax 
Function DM_DocumentFlattened : IDocument;
Description 
この関数は、フラット化されたドキュメントを返します。フラット化ドキュメントは、プロジェクトのフラット化された階層の一部であり、このプロジェクトのすべてのオブジェクトが Navigator パネルの Instance リストに表示されます。
See also 
IProject interface

DM_EditOptions method 
(IProject interface)
Syntax 
Function DM_EditOptions(DefaultPage : WideString) : LongBool;
Description

Example

See also 
IProject interface

DM_ErrorLevels method 
(IProject interface)
Syntax 
Function DM_ErrorLevels (AErrorKind : TErrorKind) : TErrorLevel;
Description 
この関数は、指定されたエラー種別のエラーレベルを返します。違反タイプごとに、No Report、Warning、Error、Fatal Error の 4 つの異なるエラーレベルを、4 色の異なるフォルダーで設定できます。
See also 
IProject interface

DM_GeneratedDocumentCount method 
(IProject interface)
Syntax 
Function DM_GeneratedDocumentCount : Integer;
Description 
この関数は、OutPut generator（OutJob ドキュメントから）によって生成されたドキュメントなど、生成済みドキュメントの数を返します。この関数は DM_GeneratedDocuments 関数と組み合わせて使用します。
Example

See also 
IProject interface

DM_GeneratedDocuments method 
(IProject interface)
Syntax 
Function DM_GeneratedDocuments (Index : Integer ) : IDocument;
Description 
この関数は、Output Generator によって生成された指定インデックスの生成済みドキュメントを返します。
See also 
IProject interface

DM_GetAllowPortNetNames method 
(IProject interface)
Syntax 
Function DM_GetAllowPortNetNames : Boolean;
Description 
Altium Designer でナビゲーションにポート ネット名が使用されているかどうかを確認するには、この関数を呼び出します。
See also 
IProject interface

DM_GetAllowSheetEntryNetNames method 
(IProject interface)
Syntax 
Function DM_GetAllowSheetEntryNetNames : Boolean;
Description 
Altium Designer でナビゲーションにシートエントリのネット名が使用されているかどうかを確認するには、この関数を呼び出します。
See also 
IProject interface

DM_GetAppendSheetNumberToLocalNets method 
(IProject interface)
Syntax 
Function DM_GetAppendSheetNumberToLocalNets : Boolean;
Description 
シート番号がローカル ネットに付加されるかどうかを確認するには、この関数を呼び出します。
See also 
IProject interface

DM_GetConfigurationByName method 
(IProject interface)
Syntax 
Function DM_GetConfigurationByName(Configuration : WideString) : IConfiguration;
Description 
この関数は、configuration パラメータが有効な場合に、プロジェクト（通常は FPGA プロジェクト）の構成オブジェクトを返します。構成ファイルには、FPGA プロジェクトからリンクされた PCB プロジェクトへ接続するためのマッピング情報が含まれます。
See also 
IProject interface

DM_GetDefaultConfiguration method 
(IProject interface)
Syntax 
Function DM_GetDefaultConfiguration : IConfiguration;
Description 
この関数は、FPGA プロジェクトのデフォルト構成を返します。
See also 
IProject interface

DM_GetDefaultConfigurationName method 
(IProject interface)
Syntax 
Function DM_GetDefaultConfigurationName : WideString;
Description 
FPGA プロジェクトのデフォルト構成名を返します
See also 
IProject interface

DM_GetDefaultPcbType method

(IProject interface)
Syntax 
Function DM_GetDefaultPcbType : WideString;
Description

Example

See also 
IProject interface

DM_GetDocumentFromPath method

(IProject interface)
Syntax 
Function DM_GetDocumentFromPath(DocumentPath : WideString) : IDocument;
Description 
この関数は、document path パラメータに関連付けられた IDocument インターフェースを返します。それ以外の場合は Nil 値が返されます。
See also 
IProject interface

DM_GetOutputPath method 
(IProject interface)
Syntax 
Function DM_GetOutputPath : WideString;
Description 
この関数は、現在のプロジェクトの生成済みドキュメント用の出力パスを返します。
See also 
IProject interface

DM_GetScrapDocument method 
(IProject interface)
Syntax 
Function DM_GetScrapDocument(DocumentPath : WideString) : IDocument;
Description 
プロジェクトのスクラップ ドキュメントを返します。スクラップ ドキュメントは、新しいドキュメントの作成時に使用される一時ドキュメントであり、ドキュメントが保存されると、スクラップ ドキュメントの内容がコピーされて解放されます。
See also 
IProject interface

DM_HierarchyMode method 
(IProject interface)
Syntax 
Function DM_HierarchyMode : TFlattenMode;
Description 
この関数は、階層モードを TFlattenMode パラメータとして返します。
See also 
IProject interface

DM_HierarchyModeForCompile method 
(IProject interface)
Syntax 
Function DM_HierarchyModeForCompile : TFlattenMode;
Description

Example

See also 
IProject interface

DM_IndexOfSourceDocument method 
(IProject interface)
Syntax 
Function DM_IndexOfSourceDocument(Filename : WideString) : Integer;
Description 
この関数は、このドキュメントのファイル名に基づいてソース ドキュメントのインデックスを返します。これは階層化された回路図ドキュメントまたは接続された回路図ドキュメント用です。
See also 
IProject interface

DM_InitializeOutputPath method 
(IProject interface)
Syntax 
Function DM_InitializeOutputPath(AnOutputType : WideString) : WideString;
Description 
この関数は、AnOutputType パラメータに基づいて Output Generator の出力パスを返します。
See also 
IProject interface

DM_LogicalDocumentCount method 
(IProject interface)
Syntax 
Function DM_LogicalDocumentCount : Integer;
Description 
この関数は、設計プロジェクトの実際のドキュメントを表す論理ドキュメントの数を返します（設計プロジェクト内に存在していても設計の一部ではないドキュメントは論理ドキュメントではありません）。この関数は DM_LogicalDocuments 関数と組み合わせて使用します。
See also 
IProject interface

DM_LogicalDocuments method 
(IProject interface)
Syntax 
Function DM_LogicalDocuments (Index : Integer ) : IDocument;
Description 
この関数は、プロジェクトの指定インデックスの論理ドキュメントを返します。
See also 
IProject interface

DM_MoveSourceDocument method 
(IProject interface)
Syntax 
Procedure DM_MoveSourceDocument (Filename : WideString; NewIndex : Integer);
Description 
このプロシージャは、filename で参照されるソース ドキュメントに新しいインデックス番号を再割り当てします。
See also 
IProject interface

DM_NavigationZoomPrecision method 
(IProject interface)
Syntax 
Function DM_NavigationZoomPrecision : Integer;
Description 
インタラクティブ ナビゲータを使用してプロジェクト内の接続をトレースする際に、ドキュメントのズーム精度をどの程度にするかを設定します。
See also 
IProject インターフェース

DM_OptionsStorage method

(IProject インターフェース)
Syntax 
関数 DM_OptionsStorage : IOptionsStorage;
Description

Example

See also 
IProject インターフェース
DM_Outputers method 
(IProject インターフェース)
Syntax 
関数 DM_Outputers (Name : WideString) : IOutputer;
Description 
この関数は、指定されたインデックスの出力ジェネレーターを返します。出力ジェネレーターには、Simple BOM などがあります。
See also 
IProject インターフェース

DM_PhysicalDocumentCount method

(IProject インターフェース)
Syntax 
関数 DM_PhysicalDocumentCount : Integer;
Description 
この関数は、物理ソースドキュメントの数を返します（これは設計プロジェクトの展開された論理ドキュメントです）。ソースドキュメントは通常、回路図ドキュメントです。この関数は DM_PhysicalDocuments 関数と組み合わせて使用します。
See also 
IProject インターフェース

DM_PhysicalDocuments method 
(IProject インターフェース)
Syntax 
関数 DM_PhysicalDocuments (Index : Integer ) : IDocument;
Description 
この関数は、プロジェクト内の指定インデックスの物理ドキュメントを返します。
See also 
IProject インターフェース

DM_PrimaryImplementationDocument method 
(IProject インターフェース)
Syntax 
関数 DM_PrimaryImplementationDocument : IDocument;
Description 
この関数は、主実装ドキュメントを返します。たとえば PCB ドキュメントです。ソースドキュメントは、たとえば回路図ドキュメントです。
See also 
IProject インターフェース

DM_ProjectFileName method 
(IProject インターフェース)
Syntax 
関数 DM_ProjectFileName : WideString;
Description 
この関数は、Altium Designer における現在のプロジェクトのファイル名を返します。
See also 
IProject インターフェース

DM_ProjectFullPath method 
(IProject インターフェース)
Syntax 
関数 DM_ProjectFullPath : WideString;
Description 
この関数は、Altium Designer における現在のプロジェクトのフルパスを返します。
See also 
IProject インターフェース

DM_ProjectVariantCount method 
(IProject インターフェース)
Syntax 
関数 DM_ProjectVariantCount : Integer;
Description 
この関数は、現在のプロジェクトのプロジェクトバリアント数を返します。
See also 
IProject インターフェース

DM_ProjectVariants method 
(IProject インターフェース)
Syntax 
関数 DM_ProjectVariants (Index : Integer ) : IProjectVariant;
Description 
この関数は、指定インデックスの IProjectVariant インターフェースを返します。プロジェクトバリアントインターフェースは、プロジェクトバリアントを持てるプロジェクトの概念的な表現にすぎません。つまり、物理的な基板は 1 つだけですが、同じ基板でも特定のコンポーネントを無効または有効にすることで、ドキュメントバリアントが生じます。PCB 基板のバリエーションは IDocumentVariant と呼ばれ、この特定のドキュメントバリアントでどのコンポーネントが有効か無効かを確認するには、IComponentVariant インターフェースを参照してください。
これは DM_ProjectVariantCount メソッドと組み合わせて使用します。
See also 
IProject インターフェース

DM_RemoveSourceDocument method 
(IProject インターフェース)
Syntax 
手続き DM_RemoveSourceDocument (Filename : WideString);
Description 
この手続きは、ファイル名で参照されるソースドキュメントを現在のプロジェクトから削除します。
See also 
IProject インターフェース

DM_SearchPathCount method 
(IProject インターフェース)
Syntax 
関数 DM_SearchPathCount : Integer;
Description 
この関数は、現在のプロジェクトの検索パス数を返します。この関数は DM_SearchPaths 関数と組み合わせて使用します。
See also 
IProject インターフェース

DM_SearchPaths method 
(IProject インターフェース)
Syntax 
関数 DM_SearchPaths (Index : Integer ) : ISearchPath;
Description 
この関数は、このプロジェクトに定義されている指定インデックスの検索パスオブジェクトを返します。
See also 
IProject インターフェース

DM_SetAllowPortNetNames method 
(IProject インターフェース)
Syntax 
手続き DM_SetAllowPortNetNames (AAllow : Boolean);
Description 
この手続きを呼び出すと、ポートネット名をナビゲーションに使用できるようになります。
See also 
IProject インターフェース

DM_SetAllowSheetEntryNetNames method 
(IProject インターフェース)
Syntax 
手続き DM_SetAllowSheetEntryNetNames (AAllow : Boolean);
Description 
この手続きを呼び出すと、Altium Designer でシートエントリネット名をナビゲーションに使用できるようになります。
See also 
IProject インターフェース

DM_SetAppendSheetNumberToLocalNets method 
(IProject インターフェース)
Syntax 
手続き DM_SetAppendSheetNumberToLocalNets (AAppend : Boolean);
Description 
この手続きを呼び出すと、ドキュメント / プロジェクト内のローカルネットにシート番号を付加できるようになります。
See also 
IProject インターフェース

DM_SetAsCurrentProject method 
(IProject インターフェース)
Syntax 
手続き DM_SetAsCurrentProject;
Description 
この関数を呼び出すと、Altium Designer でこのプロジェクトを現在のプロジェクトとして設定します。
See also 
IProject インターフェース

DM_SetDefaultConfigurationName method 
(IProject インターフェース)
Syntax 
手続き DM_SetDefaultConfigurationName(Configuration : WideString);
Description 
この手続きは、FPGA プロジェクトのデフォルト構成名を設定します。
See also 
IProject インターフェース

DM_SetDefaultPcbType method 
(IProject インターフェース)
Syntax 
手続き DM_SetDefaultPcbType(PcbType : WideString);
Description

Example

See also 
IProject インターフェース

DM_SetErrorLevels method 
(IProject インターフェース)
Syntax 
手続き DM_SetErrorLevels(AErrorKind : TErrorKind;AErrorLevel : TErrorLevel);
Description

Example

See also 
IProject インターフェース

DM_SetHierarchyMode method 
(IProject インターフェース)
Syntax 
手続き DM_SetHierarchyMode (AFlatten : TFlattenMode);
Description 
この関数を呼び出すと、このプロジェクトの階層モードを設定します。設定可能なモードは次のとおりです: eFlatten_Smart,eFlatten_Flat,eFlatten_Hierarchical,eFlatten_Global
See also 
IProject インターフェース

DM_SetOutputPath method 
(IProject インターフェース)
Syntax 
手続き DM_SetOutputPath (AnOutputPath : WideString);
Description 
Altium Designer の出力ジェネレーターによって生成されるドキュメントの出力先パスを設定します。
See also 
IProject インターフェース

DM_StartCrossProbing method 
(IProject インターフェース)
Syntax 
手続き DM_StartCrossProbing(CtrlDoesSwitch : Boolean);
Description 
この手続きはクロスプロービング機能を呼び出します。クロスプロービングを機能させるには、ソースドキュメントと主実装ドキュメントの両方が Altium Designer で開かれている必要があります。
See also 
IProject インターフェース

DM_StartNavigation method 
(IProject インターフェース)
Syntax 
手続き DM_StartNavigation;
Description 
この手続きは、現在のプロジェクトのナビゲーションパネルを呼び出します。プロジェクトは事前にコンパイルされている必要があります。
See also 
IProject インターフェース

DM_ToDoManager method 
(IProject インターフェース)
Syntax 
関数 DM_ToDoManager : IToDoManager;
Description 
この関数を呼び出すと、IToDoManager オブジェクトにアクセスできます。この ToDo マネージャーを使用すると、現在のプロジェクトの ToDo を定義できます。
See also 
IProject インターフェース

DM_TopLevelLogicalDocument method 
(IProject インターフェース)
Syntax 
関数 DM_TopLevelLogicalDocument : IDocument;
Description 
この関数は、現在のプロジェクトの最上位論理ドキュメントを返します。論理ドキュメントは通常、回路図ドキュメントであり、たとえばマルチチャネルプロジェクトのドキュメントを表すことがあります。
See also 
IProject インターフェース

DM_TopLevelPhysicalDocument method 
(IProject インターフェース)
Syntax 
関数 DM_TopLevelPhysicalDocument : IDocument;
Description 
この関数は、現在のプロジェクトの最上位物理ドキュメントを返します。物理ドキュメントは通常、PCB ドキュメントです。
See also 
IProject インターフェース

DM_UpdateConstraints method 
(IProject インターフェース)
Syntax 
関数 DM_UpdateConstraints : LongBool;
Description 
この関数を呼び出すと、FPGA プロジェクトおよび FPGA コンポーネントを含む対応 PCB プロジェクトで使用される制約ファイルを更新します。
See also 
IProject インターフェース

DM_UserID method 
(IProject インターフェース)
Syntax 
関数 DM_UserID : WideString;
Description 
この関数は、プロジェクトの UserID を表す値を返します。
See also 
IProject インターフェース

DM_ViolationCount method 
(IProject インターフェース)
Syntax 
関数 DM_ViolationCount : Integer;
Description 
この関数は、現在のプロジェクトについて Altium Designer によって報告された違反の数を返します。
See also 
IProject インターフェース

DM_Violations method 
(IProject インターフェース)
Syntax 
関数 DM_Violations(Index : Integer) : IViolation;
Description 
現在のプロジェクトの指定インデックスの違反を返します。これは DM_ViolationCount メソッドと組み合わせて使用します。
See also 
IProject インターフェース

GetNavigationHistory method 
(IProject interface)
Syntax 
Function GetNavigationHistory : INavigationHistory;
Description 
この関数は、Altium Designer の現在のプロジェクトにおける Navigator パネルのナビゲーションボタンの状態を返します。詳細については、INavigationHistory interface を参照してください。
See also 
IProject interface