Old Content - visit altium.com/documentation

Parent page: Altium Designer API Reference

This section of the Altium Designer API documentation provides a detailed reference of the FPGA API interfaces.

The Altium Designer scripting system implements a subset of the complete Altium Designer API and its Object Interfaces. The Altium DXP Developer, used for developing Altium Designer server Extensions, has access to the full Altium Designer API via a set of API SDK source units.

The FPGA API reference covers interfaces for FPGA objects in the Altium Designer application FPGA Object Model. The FPGA interfaces exist as long there are associated existing objects in memory, thus when writing a script or server code, 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.

To obtain the interface which represents the FPGA work bench object, invoke the GetNexusWorkbench function in your script which returns you the INexusWorkbench interface. Which you can then extract data from FPGA objects and invoke FPGA object's methods.

Example

    NexusWorkBench := GetNexusWorkbench;
    If NexusWorkBench.GetSoftDeviceCount > 0 Then 
        SoftDeviceCount := NexusWorkBench.GetSoftDeviceCount
    Else Exit;
FPGA API components

The FPGA API is covered in three separate files; RT_FPGA, RT_NexusWorkspace and RT_NexusDevice units.

Main FPGA Interfaces

The INexusWorkbench interface is the main interface in FPGA API. To use FPGA interfaces, invoke the GetNexusWorkbench function to retrieve the INexusWorkbench interface.

Script Examples
There are FPGA script examples in the \Examples\Scripts\DelphiScript\FPGA folder that demonstrate the use of FPGA interfaces.

References for the FPGA API

Separate references for other Altium Designer APIs

 

FPGA Interfaces Overview

When you need to deal with the objects associated with the NanoBoard and the FPGA editor software, the starting point is to invoke the GetNexusWorkbench function or the GetDeviceManager function in your script. This function returns you the INexusWorkbench object interface or the IDeviceManager object interface.

Main interfaces for the Nexus WorkBench

INexusWorkbench
IProjectLink
IPCBProjectLink

Main interfaces for the Nexus Devices

INexusDevice
INexusBreakpoint   
IMemorySpace       
IProcessorRegister 
IInstrumentView    
IJTagChannel       
IBSDLObject        
IBSDLEntity        
IScanPin           
IPinMapping        
IBoundaryCell      
IInstructionOpCode 
IRegisterAssociation
IDeviceInformation 

FPGA low level routines

Constants
Types
Functions
Classes

You are reporting an issue with the following selected text and/or image within the active document:
Altium Designer 免费试用
Altium Designer Free Trial
我们开始吧!首先,您或者您的公司已经在使用Altium Designer了吗?

如果您有任何需求,请点击这里联系获取当地办公室销售代表联系方式。.
Copyright © 2019 Altium Limited

既然您在使用Altium Designer,为何仍需要试用?

如果您有任何需求,请点击这里联系获取当地办公室销售代表联系方式。.
Copyright © 2019 Altium Limited

好的,实际上您无需下载一个试用版本。

点击下方按钮下载最新版本的Altium Designer安装包

下载Altium Designer 安装包

如果您有任何需求,请点击这里联系获取当地办公室销售代表联系方式。.
Copyright © 2019 Altium Limited

填写下方表格,获取Altium Designer最新报价。

点击[获取免费试用],并同意我们的隐私政策。您会接收到来自Altium的资讯,并允许其改变您的通知首选项。

如果您是Altium维保期内客户,您不需要下载试用版本。

如果您不是Altium维保客户,请填写下方表格免费试用。

点击[获取免费试用],并同意我们的隐私政策。您会接收到来自Altium的资讯,并允许其改变您的通知首选项。

您为何想要试用Altium Designer?

如果您有任何需求,请点击这里联系获取当地办公室销售代表联系方式。.
Copyright © 2019 Altium Limited

那您来对地方了!请填写下方表格申请试用吧。

点击[获取免费试用],并同意我们的隐私政策。您会接收到来自Altium的资讯,并允许其改变您的通知首选项。

听上去很棒!您知道我们为学生提供了特殊折扣么?欲知详情,请点击这里。.

同时,请填写下方表格申请免费试用吧。

点击[获取免费试用],并同意我们的隐私政策。您会接收到来自Altium的资讯,并允许其改变您的通知首选项。

好的,您可以下载免费的Altium Designer Viewer查看文档,有效期6个月。

请填写下方表格申请。

点击[获取免费试用],并同意我们的隐私政策。您会接收到来自Altium的资讯,并允许其改变您的通知首选项。

好棒!创作是一件超酷的事情,我们可以为您提供完美的设计软件。

Upverter是一个社区导向的交流平台,专为您这样的创客量身定做。

点击这里看看吧!

如果您有任何需求,请点击这里联系获取当地办公室销售代表联系方式。.
Copyright © 2019 Altium Limited

好的,您可以下载免费的Altium Designer Viewer查看文档,有效期6个月。

请填写下方表格申请。

点击[获取免费试用],并同意我们的隐私政策。您会接收到来自Altium的资讯,并允许其改变您的通知首选项。