Technical Reference - FPGA API

Parent page: Altium Designer API Reference

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

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

• FPGA API Workbench Interfaces
• FPGA API Devices Interfaces
• FPGA API Types and Constants
• FPGA API Nexus Functions
• FPGA API Low-level API

Separate references for other Altium Designer APIs

• System API Object Model - refer to the System API Reference
• Schematic Object Model - refer to the Schematic API Reference
• PCB Object Model  - refer to the PCB API Reference
• Integrated Library Object Model - refer to the Integrated Library API Reference
• Workspace Manager Object Model - refer to the Workspace Manager API Reference

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