Altium-SDK---Technical-Reference---System-API_altiumdesigner二次开发资源-CSDN文库

需积分: 45 10 浏览量 2018-12-26 11:28:32 上传评论 2 收藏 851KB PDF 举报

Altium Designer是电子设计自动化软件，用于电路设计、PCB布局、FPGA开发等领域。Altium Designer提供了一个名为Altium-SDK（软件开发工具包）的编程接口，允许开发者通过编程方式扩展和定制软件功能。文档"Altium-SDK---Technical-Reference---System-API"是一个技术参考指南，为开发者提供了Altium Designer的低级系统API的详细信息，这使得开发者可以进行脚本编写和服务器端开发。文档中提及的Altium Designer Runtime Library是Altium Designer软件运行时库，它由多个单元（Units）组成，其中一些单元为脚本系统自动暴露，以便于在脚本中使用。对于服务器端项目，需要在适当位置的server项目的Uses子句中添加所需的单元。Altium Designer的系统API提供了多种接口，例如： 1. IDynamicHelpManager：用于管理动态帮助系统。 2. IDocumentRequest：处理文档请求。 3. ILicenseManager：进行软件许可管理。 4. IOptionsManager：管理软件配置选项。 5. IOptionsReader和IOptionsWriter：用于读取和写入配置设置。 6. IOptionsPage：管理配置页面。 7. INavigationDocument：提供导航文档的功能。 8. IGUIManager：提供GUI管理功能。 9. ITimerManager：管理计时器。 10. ITranslationManager：提供本地化支持。 11. IServerModule：服务器模块接口。 12. IServerView、IServerDocumentView和IServerDocument：定义服务器视图、文档视图和文档的接口。 13. IHighlightedDocument：用于突出显示文档。 14. IServerPanelInfo：服务器面板信息接口。 15. IServerProcess、IServerRecord和IServerWindowKind：与服务器进程、记录和窗口种类相关。 16. IServerSecurity：管理服务器安全。 17. IProcessLauncher、IProcessLauncherInfo和IProcessControl：用于进程启动和控制。 18. ICommandLauncher：命令启动器接口。 19. INotificationHandler和INotificationInterface：用于处理通知。 20. IDocumentFormNotification、ISystemNotification、IMessagesNotification、IModuleNotification和IViewNotification：不同类型的事件通知。 21. IDragDropNotification和IFastCrossSelectNotification：提供拖放和快速交叉选择的通知。 22. INavigationSystemInterface、INavigationProvider和INavigateAttributes：与导航系统接口和提供者相关。 23. IEventNavigatedInterface：导航事件接口。 24. IExternalFormInterface和IExternalFormHolder：与外部表单相关。 25. ISceneViewInterface：场景视图接口。 Altium Designer Runtime Library脚本系统实现了Altium Designer RunTime Library的一部分。通常，在Altium Designer的RTL中可使用的单元，在脚本系统中也可使用。同样，在服务器端开发系统中，Server Development system使用脚本系统，但需要在Server Projects中适当的Uses子句中添加所需的Units。请注意，本文档可能经过OCR扫描，某些词汇和表述可能存在识别错误或遗漏。在使用文档时，应当充分理解每个接口的功能和用法，确保正确编程。此外，编写代码时应遵循Altium Designer的开发规范和最佳实践，以确保软件的稳定性与效率。

资源推荐

资源详情

资源评论

Technical Reference - System API

This reference provides a concise reference of the Altium Designer low level

system API as part of the Altium Designer Run Time Library.

The System Reference contains low level Application Programming Interface

information that can be used for scripting and server development in Altium

Designer.

The Altium Designer Run time Library is composed of Units and some of them

are automatically exposed for the scripting system. For the server projects,

you need to add the Units in the Uses clause in the server project where

appropriate.

Object Interfaces from Altium Designer System

API

IServerModule

Interface

IServerView Interface

IServerDocumentView

Interface

IClient Interface

IServerDocumentView

Interface

IServerDocument

Interface

IHighlightedDocument

Interface

IServerPanelInfo

Interface

IServerProcess

Interface

IServerRecord

Interface

IServerWindowKind

Interface

IServerSecurity

Interface

IProcessLauncher

Interface

IProcessLauncherInfo

Interface

IProcessControl

Interface

ICommandLauncher

Interface

INotificationHandler

Interface

INotification Interface

IDocumentFormNotification

Interface

ISystemNotification

Interface

IMessagesNotification

Interface

IModuleNotification

Interface

IViewNotification Interface

IDragDropNotification

Interface

IFastCrossSelectNotification

Interface

INavigationSystem Interface

INavigationProvider

Interface

INavigationSystem Interface

INavigateAttributes

Interface

IEventNavigated Interface

IExternalForm Interface

IExternalFormHolder

Interface

ISceneView Interface

IDynamicHelpManager

Interface

IDocumentRequest

Interface

ILicenseManager

Interface

IOptionsManager

Interface

IOptionsReader

Interface

IOptionsWriter

Interface

IOptionsPage Interface

INavigationDocument

Interface

IGUIManager Interface

ITimerManager

Interface

ITranslationManager

Interface

Client Server API Reference

The Client/Server Application Programming Interface reference covers

interfaces for Client/Server objects in the Client/Server Object Model as part

of the RT_ClientServerInterface unit from the Altium Designer RTL and

exposed for use in scripts from the Scripting System.

What are Interfaces?

Each method in the interface is implemented in the corresponding class.

Interfaces are declared like classes but cannot be directly instantiated and do

not have their own method definitions. Each interface, a class supports is

actually a list of pointers to methods. Therefore, each time a method call is

made to an interface, the interface actually diverts that call to one of it's

pointers to a method, thus giving the object that really implements it, the

chance to act.

The Client/Server interfaces exist as long there are associated existing

objects in memory, thus when writing a script, you have the responsibility of

checking whether the interface you wish to query exists or not before you

proceed to invoke the interface's methods.

You can obtain the IClient interface object by calling the Client function in a

script and execute methods from this function directly for example calling this

Client.OpenDocument('Text',FileName); method is valid.

The empty workspace or the shell of Altium Designer is the top level client

window. The client module is represented by its IClient interface object, and

you can have the ability to take a peek into a loaded server's data structures

through this IClient interface. Servers are represented by its IServerModule

interfaces which are plug in modules in Altium Designer.

Example

Var

ReportDocument : IServerDocument;

Begin

If Client = Nil Then Exit;

// Opens and shows a text file in Altium Designer

ReportDocument := Client.OpenDocument('Text',FileName);

If ReportDocument <> Nil Then

Client.ShowDocument(ReportDocument);

End;

Script Examples

There are Client / Server script examples in the \Examples\Scripts\DXP folder

Using Client / Server Interfaces

Central to the Altium Designer architecture is the concept of a single client

module as the controller collaborating with loaded servers. Each server

manages their own documents. This is a big picture view of the Altium

Designer- there is one Client executable and several servers as loaded

The Relationship of a Server and its Documents

An IServerModule interface has the following interfaces:

• ICommandLauncher (deals with a server's processes table)

• IServerDocument (represents a loaded design document in Altium Designer)

• IServerView (represents a panel that can have a view of the system)

• IServerDocumentView (deals with a document view (either the document

window or panel window))

• IExternalForm (represents Altium Designer aware Delphi form either as a

document form or a panel form. These forms are wrapped by the

IServerDocumentView or IServerView interface object. This IExternalForm

interface object has low level methods such as resizing and displaying the

form)

• IProcessControl (represents the level of stacked processes for this focussed

server document)

• INotification represents the system notifications from the Client system and

all server modules receive these notifications. There is an ability to handle a

notification and take it from there. Documents and associated panels can be

synchronized through the use of notifications as well).

Servers Documents and Panels Interfaces in

Altium Designer

The concept of documents and panels are central to understanding how

servers work in Altium Designer. The servers manage their own panels and

documents. Altium Designer has access to the currently active panels and

documents and manages the size and position of these panels and

documents. Basically there are two types of panels - panels associated with

documents and standalone panels such as the Messages panel.

Each server loaded in Altium Designer store their own documents (there can

be different document kinds, for example PCB and PCB library documents)

and each document has its corresponding panel for example the PCB panel

and the PCB document. Now, a server has its own document container which

stores the same document kind, thus for different document kinds, there are

document containers for each document kind. Each document container

stores views of documents and associated panels along with standalone

panels if any.

In the screen shot below, there are two PCB documents open in Altium

Designer with the Projects panel on the left and a floating PCB panel visible

on top of a PCB document. The add-on's floating toolbar is visible as well.

We will consider the main interfaces used to represent the servers,

documents and panels in the Altium Designer as shown in figure above.

The Client system within the Altium Designer has access to an active

剩余219页未读，继续阅读

评论收藏

内容反馈

wcz2008nihao

粉丝: 5
资源: 83

Altium-SDK---Technical-Reference---System-API

Altium+designer+元件库大全

AltiumDesigner开发FPGA教程 fpga开发.pdf

altium designer script教程

Altium Designer教程交互式布线篇__开发者必须掌握的

基于Altium Designer的电源设计

Altium-常用3D封装库（STEP）.zip

Altium-Designer-Public-24-4-1.zip

Altium Designer-常用元件3D封装库.rar

Altium-常用3D封装库（Step）【常用贴片篇】.rar

Altium-常用3D封装库（Step）【接插件篇】.rar

Altium Designer 18 及 和谐包，你懂的

Altium Designer中文官方文档教程

AltiumDesigner与SIwave接口

Altium Designer 一键导出坐标和BOM脚本,V0.7-AD_Script.zip

AltiumDesigner中文帮助手册

Altium-常用3D封装库（Step）【常用贴片篇】.zip

data-altium-com-cn-20241210213847.zip

Altium-designer-Miscellaneous-Devices分立元件库中英对照表

2-Altium-Designer-多层板设计.rar_Altium Designer_altium_层板

《Altium-Designer-案例教程》课件(完整版).ppt

LED SDK源码

Altium design 设计资料

Altium Designer 14 官方库文件

Altium Designer安装包下载-附件资源

超级Altium

altium-designer画元件封装.pdf

Altium-Designer中文版教程.pdf

Altium-PCB拼板详解

最新资源

Altium Designer 18 及和谐包，你懂的