IDocument インターフェース
IDocument インターフェースは、Altium Designer に存在する既存ドキュメントを表します。ドキュメントには、回路図、PCB、VHDL、PCB ライブラリドキュメントなどがあります。
IDocument インターフェースの DM_DocumentKind メソッドを呼び出すと、ドキュメント種別が返されます。ドキュメントはプロジェクトの一部である場合も、フリードキュメントプロジェクトである場合もあります。
既存ドキュメントに対してクエリを実行し、このドキュメントが関連付けられているプロジェクトインターフェースを返すことができます。
The
Function DM_FullPath : WideString;
|
メソッド
(IDocument interface)
Function DM_BusCount : Integer;
この関数は、このドキュメント内のバスオブジェクト数を返します。DM_Buses(Index) と併用して、各バスオブジェクトを順に処理します。
IDocument interface
DM_Buses method
(IDocument interface)
Function DM_Buses (Index : Integer) : IBus;
この関数は、このドキュメントから指定インデックスの Bus インスタンスを返します。
IDocument interface
DM_ChannelClassCount method
(IDocument interface)
Function DM_ChannelClassCount : Integer;
この関数は、このドキュメント内のチャネルクラス数を示します。DM_ChannelClasses(index) と併用して、各チャネルクラスを順に処理します。
IDocument interface
DM_ChannelClasses method
(IDocument interface)
Function DM_ChannelClasses (Index : Integer) : IChannelClass;
この関数は、このドキュメントから指定インデックスの ChannelClass インスタンスを返します。DM_ChannelClassCount 関数と併用してください。
IDocument interface
(IDocument interface)
Function DM_ChannelIndex : Integer;
この関数は、このドキュメントのチャネルインデックスを返します。これは特にマルチチャネル設計で、単一のソースドキュメントが複数回参照される場合に使用します。
IDocument interface
(IDocument interface)
Function DM_ChannelPrefix : WideString;
この関数は、このドキュメントのチャネルプレフィックスを返します。これは特にマルチチャネル設計で、単一のソースドキュメントが複数回参照される場合に使用します。
IDocument interface
(IDocument interface)
Function DM_ChannelRoomNamingStyle : TChannelRoomNamingStyle;
この関数は、チャネルルームの命名スタイル値を返します。
IDocument interface
DM_ChildDocumentCount method
(IDocument interface)
Function DM_ChildDocumentCount : Integer;
この関数は、このドキュメントに対する子ドキュメント数を返します。
IDocument interface
(IDocument interface)
Function DM_ChildDocuments (Index : Integer) : IDocument;
この関数は、指定インデックスの子ドキュメントを返します。階層設計は、複数階層の親子ドキュメントで構成されます。
IDocument interface
DM_Compile method
(IDocument interface)
Function DM_Compile : LongBool;
この関数はコンパイラを呼び出して、このドキュメントをコンパイルします。コンパイルが成功した場合は true が返されます。
IDocument interface
DM_ComponentClassCount method
(IDocument interface)
Function DM_ComponentClassCount : Integer;
この関数は、このドキュメント内のコンポーネントクラス数を示します。DM_ComponentClasses(index) と併用して、各コンポーネントクラスを順に処理します。
IDocument interface
DM_ComponentClasses method
(IDocument interface)
Function DM_ComponentClasses (Index : Integer) : IComponentClass;
この関数は、このドキュメントから指定インデックスの ComponentClass インスタンスを返します。DM_ComponentClassCount 関数と併用してください。
IDocument interface
DM_ComponentCount method
(IDocument interface)
Function DM_ComponentCount : Integer;
この関数は、このドキュメント上のコンポーネントインスタンス数を返します。DM_Components(Index) メソッドと併用して、各コンポーネントオブジェクトを順に処理します。
IDocument interface
DM_Components method
(IDocument interface)
Function DM_Components (Index : Integer) : IComponent;
この関数は、このドキュメントから指定インデックスのコンポーネントインスタンスを返します。DM_ComponentCount メソッドと併用して使用します。
IDocument interface
DM_ConstraintGroupCount method
(IDocument interface)
Function DM_ConstraintGroupCount : Integer;
この関数は、制約グループ数を示します。
IDocument interface
DM_ConstraintGroups method
(IDocument interface)
Function DM_ConstraintGroups (Index : Integer) : IConstraintGroup;
この関数は、指定インデックスの制約グループを返します。制約グループ数は DM_ConstraintGroupCount 関数で取得します。
IDocument interface
DM_CreateViolation method
(IDocument interface)
Function DM_CreateViolation (AErrorKind : TErrorKind;AErrorString : WideString) : IViolation;
この関数は、設計が不正な場合に、エラー種別とエラー文字列に基づいて違反(Violation)を作成します。
IDocument interface
DM_CrossSheetConnectorCount method
(IDocument interface)
Function DM_CrossSheetConnectorCount : Integer;
この関数は、このドキュメント上のクロスシートコネクタ数を返します。DM_CrossConnectors(index) と併用して、各クロスコネクタオブジェクトを順に処理します。
IDocument interface
DM_CrossSheetConnectors method
(IDocument interface)
Function DM_CrossSheetConnectors (Index : Integer) : ICrossSheet;
この関数は、このドキュメントから指定インデックスのクロスシートコネクタインスタンスを返します。DM_CrossSheetConnectorCount メソッドと併用して使用します。
IDocument interface
DM_CurrentInstanceNumber method
(IDocument インターフェース)
Function DM_CurrentInstanceNumber : Integer;
この関数は、このドキュメントの現在のインスタンス番号を返します(特に、設計ドキュメントが複数回参照されるマルチチャネル設計の場合)。
IDocument
DM_DifferentialPairs メソッド
(IDocument インターフェース)
Function DM_DifferentialPairs(Index : Integer) : IDifferentialPair;
この関数は、プロジェクト内のドキュメントから、インデックス指定された差動ペアを返します。
IDocument インターフェース
IDifferentialPair インターフェース
DM_DifferentialPairCount メソッド
(IDocument インターフェース)
Function DM_DifferentialPairCount : Integer;
この関数は、プロジェクト内のドキュメントで使用されている差動ペアの数を返します。
IDocument インターフェース
IDifferentialPair インターフェース
(IDocument インターフェース)
Function DM_DocumentIsLoaded : Boolean;
この関数は、このドキュメントが Altium Designer に読み込まれているかどうかを示すブール値を返します。
IDocument
(IDocument インターフェース)
Function DM_DocumentIsTextual : Boolean;
この関数は、ドキュメントがテキストドキュメントであるかどうかを示します。
IDocument インターフェース
DM_DocumentKind method
(IDocument インターフェース)
Function DM_DocumentKind : WideString;
この関数は、現在のドキュメントのドキュメント種別を返します。ドキュメントが回路図ドキュメントであれば、返される文字列は 'SCH' になります。サーバー名については、各サーバーのインストールファイルを確認してください。
IDocument
DM_FileName method
(IDocument インターフェース)
Function DM_FileName : WideString;
この関数は、このドキュメントのファイル名文字列を返します。
IDocument
DM_FullPath method
(IDocument インターフェース)
Function DM_FullPath : WideString;
この関数は、このドキュメントが存在する場所のフルパスを返します。
IDocument
DM_IndentLevel method
(IDocument インターフェース)
Function DM_IndentLevel : Integer;
この関数は、現在のプロジェクトに対するこのドキュメントのインデントレベルを返します。
IDocument インターフェース
DM_IsPhysicalDocument method
(IDocument インターフェース)
Function DM_IsPhysicalDocument : Boolean;
この関数は、このドキュメントが物理ドキュメントであるかどうかを示すブール値を返します。マルチチャネルプロジェクトでは、ドキュメントを区別するために「論理ドキュメント」と「物理ドキュメント」という用語が使われます。マルチチャネル設計とは、1 枚のシートがチャネル設計のために繰り返し参照されることを意味し、このシートは論理ドキュメントと呼ばれます。物理ドキュメント(通常は PCB ドキュメント)には、回路図シート上のチャネルにマップされるルーム内で一意の名前を持つコンポーネントが含まれます。したがって、マルチチャネル設計は、PCB 上で一意の物理デジグネータを持つコンポーネントを含む複数のルームに変換されます。
PCB コンポーネントの物理デジグネータは、PCB コンポーネントのデジグネータが一意になるように、回路図プロジェクトの階層パスと、関連する回路図コンポーネントの論理デジグネータを含む形で算出されます。
IDocument
DM_IsPrimaryImplementationDocument method
(IDocument インターフェース)
Function DM_IsPrimaryImplementationDocument : Boolean;
この関数は、このドキュメントが主要な実装ドキュメント(例えば PCB ドキュメント)であるかどうかを示すブール値を返します。回路図ドキュメントはソースドキュメントであり、設計プロジェクトの中心となります。
IDocument
DM_LoadDocument method
(IDocument インターフェース)
Function DM_LoadDocument : Boolean;
この関数は、このドキュメントが読み込まれているかどうかを示すブール値を返します。
IDocument
DM_LogicalDocument method
(IDocument インターフェース)
Function DM_LogicalDocument : IDocument;
この関数は、有効であれば論理ドキュメントを返します。そうでない場合は nil 値が返されます。マルチチャネルプロジェクトでは、ドキュメントを区別するために「論理ドキュメント」と「物理ドキュメント」という用語が使われます。マルチチャネル設計とは、1 枚のシートがチャネル設計のために繰り返し参照されることを意味し、このシートは論理ドキュメントと呼ばれます。物理ドキュメント(通常は PCB ドキュメント)には、回路図シート上のチャネルにマップされるルーム内で一意の名前を持つコンポーネントが含まれます。したがって、マルチチャネル設計は、PCB 上で一意の物理デジグネータを持つコンポーネントを含む複数のルームに変換されます。
PCB コンポーネントの物理デジグネータは、PCB コンポーネントのデジグネータが一意になるように、回路図プロジェクトの階層パスと、関連する回路図コンポーネントの論理デジグネータを含む形で算出されます。
IDocument
DM_ModelKind method
(IDocument インターフェース)
Function DM_ModelKind : WideString;
この関数は、このドキュメントに関連するモデル種別の文字列を返します。
IDocument インターフェース
DM_NetClassCount method
(IDocument インターフェース)
Function DM_NetClassCount : Integer;
この関数は、このドキュメント上のネットクラス数を示します。各ネットクラスを走査するには、この NetClassCount を DM_NetClasses(Index) メソッドと併用してください。
IDocument インターフェース
DM_NetClasses method
(IDocument インターフェース)
Function DM_NetClasses (Index : Integer) : INetClass;
この関数は、このドキュメントからインデックス指定された NetClass インスタンスを返します。DM_NetClassCount 関数と併用してください。
IDocument インターフェース
DM_NetCount method
(IDocument インターフェース)
Function DM_NetCount : Integer;
この関数は、このドキュメントのネット数を返します。各シートシンボルオブジェクトを走査するには、この NetCount を DM_Nets(Index) と併用してください。
IDocument インターフェース
DM_Nets method
(IDocument インターフェース)
Function DM_Nets (Index : Integer) : INet;
この関数は、このドキュメントに関連付けられたインデックス指定のネットを返します。
IDocument インターフェース
DM_ParentDocumentCount method
(IDocument インターフェース)
Function DM_ParentDocumentCount : Integer;
この関数は、このドキュメントに対する親ドキュメントの数を返します。
IDocument インターフェース
DM_ParentDocuments method
(IDocument インターフェース)
Function DM_ParentDocuments (Index : Integer) : IDocument;
この関数は、インデックス指定された親ドキュメントを返します。階層設計は、複数層の親子ドキュメントで構成されます。
IDocument
DM_PartCount method
(IDocument インターフェース)
Function DM_PartCount : Integer;
この関数は、このドキュメント内のパートオブジェクト数を返します。各パートオブジェクトを走査するには、この PartCount を DM_Parts(Index) と併用してください。
IDocument インターフェース
DM_Parts method
(IDocument インターフェース)
Function DM_Parts (Index : Integer) : IPart;
この関数は、このドキュメントに関連付けられたインデックス指定のパートを返します。
IDocument インターフェース
DM_PhysicalDocumentCount method
(IDocument インターフェース)
Function DM_PhysicalDocumentCount : Integer;
この関数は、このドキュメントに関連付けられた物理ドキュメントの数を返します。
IDocument インターフェース
DM_PhysicalDocumentParent method
(IDocument インターフェース)
Function DM_PhysicalDocumentParent : IDocument;
この関数は、親となる物理ドキュメントの IDocument インターフェースを返します。例えば VHDL や PCB ドキュメントなどが該当します。
IDocument インターフェース
DM_PhysicalInstanceName method
(IDocument インターフェース)
Function DM_PhysicalInstanceName : WideString;
この関数は、有効であればこの物理ドキュメントの名前を返します。そうでない場合は空文字列が返されます。
IDocument
DM_PhysicalInstancePath method
(IDocument インターフェース)
Function DM_PhysicalInstancePath : WideString;
この関数は、有効であれば物理ドキュメントインスタンスへのパスを返します。そうでない場合は空文字列が返されます。
IDocument インターフェース
DM_PhysicalRoomName method
(IDocument インターフェース)
Function DM_PhysicalRoomName : WideString;
この関数は、有効であればこの物理ドキュメント上のルーム名を返します。そうでない場合は nil 値が返されます。
IDocument インターフェース
DM_PortCount method
(IDocument interface)
Function DM_PortCount : Integer;
この関数は、このドキュメント上のポートオブジェクト数を返します。各ポートオブジェクトを順に処理するには、DM_Ports(index) と組み合わせて使用します。
IDocument interface
DM_Ports method
(IDocument interface)
Function DM_Ports (Index : Integer) : INetItem;
この関数は、このドキュメントから指定インデックスのポートインスタンスを返します。DM_PortCount メソッドと組み合わせて使用します。
IDocument
DM_Project method
(IDocument interface)
Function DM_Project : IProject;
この関数は、このドキュメントが関連付けられている IProject オブジェクトインターフェースを返します。
IDocument
DM_RoomCount method
(IDocument interface)
Function DM_RoomCount : Integer;
この関数は、このドキュメント上のルーム数を示します。各ルームオブジェクトを順に処理するには、この RoomCount を DM_Rooms(Index) と組み合わせて使用します。
IDocument interface
DM_Rooms method
(IDocument interface)
Function DM_Rooms (Index : Integer) : IRoom;
この関数は、このドキュメントから指定インデックスのルームインスタンスを返します。DM_RoomCount 関数と組み合わせて使用します。
IDocument interface
DM_RuleCount method
(IDocument interface)
Function DM_RuleCount : Integer;
この関数は、このドキュメントに含まれるルール数を返します。各シートシンボルオブジェクトを順に処理するには、この Rule count を DM_Rules(Index) と組み合わせて使用します。
IDocument interface
DM_Rules method
(IDocument interface)
Function DM_Rules (Index : Integer) : IRule;
この関数は、このドキュメントから指定インデックスのルールを示します。このドキュメントで見つかった各ルールを順に処理するには、DM_RuleCount を DM_Rules と組み合わせて使用します。.
IDocument interface
DM_ScrapCompile method
(IDocument interface)
Function DM_ScrapCompile(ForceCompile : Boolean) : LongBool;
この関数は、スクラップコンパイル(強制する/しない)を実行します。スクラップコンパイルは、Altium Designer における設計ドキュメントのバックグラウンドコンパイルで、バスおよびワイヤオブジェクトに対する自動ジャンクションをすべて行います。また、回路図のオンラインルールチェックもスクラップコンパイルで実行されます。これは、プロジェクトをコンパイルするメインコンパイルとは完全に別物です。
IDocument interface
DM_SheetSymbolCount method
(IDocument interface)
Function DM_SheetSymbolCount : Integer;
この関数は、このドキュメントに含まれるシートシンボル数を返します。各シートシンボルオブジェクトを順に処理するには、この SheetSymbol count を DM_SheetSymbols(Index) と組み合わせて使用します。
IDocument interface
DM_SheetSymbols method
(IDocument interface)
Function DM_SheetSymbols (Index : Integer) : ISheetSymbol;
この関数は、このドキュメントに関連付けられた指定インデックスのシートシンボルを返します。
IDocument interface
DM_SignalManager method
(IDocument interface)
Function DM_SignalManager : ISignalManager;
この関数は、シグナルマネージャのインターフェースを返します。
IDocument interface
ISignalManager interface
DM_TextFrameCount method
(IDocument interface)
Function DM_TextFrameCount : Integer;
この関数は、このドキュメントに含まれるテキストフレームオブジェクト数を返します。各シートシンボルオブジェクトを順に処理するには、この TextFrame count を DM_TextFrames(Index) と組み合わせて使用します。
IDocument interface
DM_TextFrames method
(IDocument interface)
Function DM_TextFrames (Index : Integer) : ITextFrame;
この関数は、このドキュメントに関連付けられた指定インデックスのテキストフレームオブジェクトを返します。
IDocument interface
DM_UniqueComponentCount method
(IDocument interface)
Function DM_UniqueComponentCount : Integer;
この関数は、配置元のライブラリ(複数可)に基づくユニークコンポーネント数を返します。同一のコンポーネント種別の重複は 1(1個)としてカウントされます。各ユニークコンポーネントオブジェクトを順に処理するには、DM_UniqueComponents(Index) メソッドと組み合わせて使用します。
IDocument
DM_UniqueComponents method
(IDocument interface)
Function DM_UniqueComponents (Index : Integer) : IComponent;
この関数は、このドキュメントから指定インデックスのユニークコンポーネントインスタンスを返します。この関数は DM_UniqueComponentCount メソッドと組み合わせて使用します。
IDocument interface
DM_UniquePartCount method
(IDocument interface)
Function DM_UniquePartCount : Integer;
この関数は、このドキュメントに含まれるユニークパーツ数を示します。同一のパーツ種別の重複は 1(1個)としてのみカウントされます。
IDocument interface
DM_UniqueParts method
(IDocument interface)
Function DM_UniqueParts (Index : Integer) : IPart;
この関数は、このドキュメントに関連付けられた指定インデックスのユニークパーツを返します。なお、同一パーツのインスタンスが複数存在する場合でも、認識されるのはそのうち 1 つのみです。
IDocument
DM_UpdateDateModified method
(IDocument interface)
Procedure DM_UpdateDateModified;
このプロシージャは、このドキュメントの更新日時(modified date)を設定します。
IDocument interface
DM_VHDLEntities method
(IDocument interface)
Function DM_VHDLEntities (Index : Integer) : IVHDLEntity;
この関数は、このドキュメントから指定インデックスの VHDL エンティティインスタンスを返します。DM_VHDLEntityCount 関数と組み合わせて使用します。
IDocument interface
DM_VHDLEntityCount function
DM_VHDLEntityCount method
(IDocument interface)
Function DM_VHDLEntityCount : Integer;
この関数は、このドキュメントに含まれる VHDL エンティティ数を示します。各 VHDL エンティティを順に処理するには、この VHDL Entity count を DM_VHDLEntities(Index) と組み合わせて使用します。
IDocument interface
DM_VHDLEntities method