FPGA API Workbench Interfaces

Old Content - visit altium.com/documentation

Parent page: Technical Reference - FPGA API

FPGA API: Nexus WorkBench Interfaces

Contents of this reference:

Nexus WorkBench Interfaces
IDeviceLink Interface
INexusCore Interface
INexusWorkbench Interface
INexusNotification Interface
IPCBProjectLink Interface
IProjectLink Interface
ISchComponentLink Interface

Nexus WorkBench Interfaces

INexusWorkBench and its interfaces
IDeviceLink interface
INexusCore interface
INexusWorkBench interface
INexusNotification interface
IPCBProjectLink interface
IProjectLink interface
ISchComponentLink interface

Constants

Nexus Notifications values

cNexusDeviceStatusesChanged     = 0;
cNexusHardDeviceChainChanged    = 1;
cNexusSoftDeviceChainChanged    = 2;
cNexusCurrentHardDeviceChanged  = 3;
cNexusCurrentSoftDeviceChanged  = 4;
cNexusProjectCoreTreeChanged    = 5;
cNexusProcessFlowStatusChanged  = 6;
cNexusConnectionStatusChanged   = 7;
cNexusCurrentBoardDeviceChanged = 8;
cNexusBoardDeviceChainChanged   = 9;
cNexusProjectListChanged        = 10;
cNexusOnIdle                    = 11;
cNexusBeginUpdate               = 12;
cNexusEndUpdate                 = 13;

Nexus Parameter Names

cNexusParameterName_Device    = 'NEXUS_JTAG_DEVICE';
cNexusParameterName_Connector = 'NEXUS_JTAG_CONNECTOR';
cNexusParameterName_Order     = 'NEXUS_JTAG_ORDER';
cNexusParameterName_Index     = 'NEXUS_JTAG_INDEX';
cNexusParameterName_Core      = 'NEXUS_CORE';
cNexusParameterName_FPGA      = 'NEXUS_FPGA_DEVICE';
 
cNexusParameterName_MemoryDepth       = 'Memory_Depth';
cNexusParameterName_MemoryWidth       = 'Memory_Width';
cNexusParameterName_MemoryDepthA      = 'Memory_DepthA';
cNexusParameterName_MemoryWidthA      = 'Memory_WidthA';
cNexusParameterName_MemoryDepthB      = 'Memory_DepthB';
cNexusParameterName_MemoryWidthB      = 'Memory_WidthB';
cNexusParameterName_MemoryType        = 'Memory_Type';
cNexusParameterName_MemoryUse         = 'Memory_Use';
cNexusParameterName_MemoryClockEdge   = 'Memory_ClockEdge';
cNexusParameterName_MemoryEnablePin   = 'Memory_EnablePin';
cNexusParameterName_MemoryContentFile = 'Memory_ContentFile';
cNexusParameterName_MemoryProgramFile = 'Memory_ProgramFile';
cNexusParameterName_MemoryResetPin    = 'Memory_ResetPin';
cNexusParameterName_MemoryByteIndex   = 'Memory_ByteIndex';
cNexusParameterName_MemoryHalfIndex   = 'Memory_HalfIndex';
cNexusParameterName_MemoryByteWrites  = 'Memory_ByteWrites';
 
cNexusParameterName_ClockCount          = 'Clk_Count';
cNexusParameterName_ClockInputFrequency = 'Clk_InputFreq_MHz';
cNexusParameterName_ClockAOperation     = 'ClkA_Operation';
cNexusParameterName_ClockBOperation     = 'ClkB_Operation';
cNexusParameterName_ClockCOperation     = 'ClkC_Operation';
cNexusParameterName_ClockDOperation     = 'ClkD_Operation';

cNexusCoreKindString

cNexusCoreKindString : Array[TNexusCoreKind] Of WideString =
(
    {eNexusCoreKind_None              } 'None'              ,
    {eNexusCoreKind_Processor_OCDS    } 'Processor_OCDS'    ,
    {eNexusCoreKind_Processor_Standard} 'Processor_Normal'  ,
    {eNexusCoreKind_Processor_Hard    } 'Processor_Hard'    ,
    {eNexusCoreKind_Memory_Program    } 'Memory_Program'    ,
    {eNexusCoreKind_Memory_Data       } 'Memory_Data'       ,
    {eNexusCoreKind_Instrument        } 'Instrument'        ,
    {eNexusCoreKind_ClockManager      } 'ClockManager'     
);

cNexusCoreInstancePrefixString

cNexusCoreInstancePrefixString : Array[TNexusCoreKind] Of WideString =
(
    {eNexusCoreKind_None              } ''       ,
    {eNexusCoreKind_Processor_OCDS    } ''       ,
    {eNexusCoreKind_Processor_Standard} ''       ,
    {eNexusCoreKind_Processor_Hard    } ''       ,
    {eNexusCoreKind_Memory_Program    } 'Memory_',
    {eNexusCoreKind_Memory_Data       } 'Memory_',
    {eNexusCoreKind_Instrument        } ''       ,
    {eNexusCoreKind_ClockManager      } 'Clock_'
);

cConfigurableComponentInstancePrefix

cConfigurableComponentInstancePrefix = 'Configurable_';

cNexusProcessorsAndHardProcessor

cNexusProcessorsAndHardProcessor : Set Of TNexusCoreKind =
[
   eNexusCoreKind_Processor_OCDS,
   eNexusCoreKind_Processor_Standard,
   eNexusCoreKind_Processor_Hard
];

cNexusProcessors

cNexusProcessors : Set Of TNexusCoreKind =
[
   eNexusCoreKind_Processor_OCDS,
   eNexusCoreKind_Processor_Standard
];

cNexusInstruments

cNexusInstruments : Set Of TNexusCoreKind =
[
   eNexusCoreKind_Processor_OCDS,
   eNexusCoreKind_Instrument
];

cNexusMemories

cNexusMemories : Set Of TNexusCoreKind =
[
    eNexusCoreKind_Memory_Data,
    eNexusCoreKind_Memory_Program
];

cNexusClockManagers

cNexusClockManagers : Set Of TNexusCoreKind =
[
    eNexusCoreKind_ClockManager
];

Types

TNexusCoreKind = (eNexusCoreKind_None,
                  eNexusCoreKind_Processor_OCDS,
                  eNexusCoreKind_Processor_Standard,
                  eNexusCoreKind_Processor_Hard,
                  eNexusCoreKind_Memory_Program,
                  eNexusCoreKind_Memory_Data,
                  eNexusCoreKind_Instrument,
                  eNexusCoreKind_ClockManager);

Functions

Function GetNexusWorkbench                                  : INexusWorkbench;      SafeCall;
Function GetNexusCoreKindFromParameters    (Parameters : PChar) : TNexusCoreKind;
Function GetNexusCoreKindFromString        (S : TDynamicString) : TNexusCoreKind;

IDeviceLink Interface

Overview
The IDeviceLink interface hierarchy is as follows;

IDeviceLink methods
ProcessFlow
DownloadFlow
AnyFlowsRunning
GetParent
GetChildCount
GetChild
GetNexusDevice
GetNexusCore
GetProject
GetConfiguration
GetJTAGDevice
GetDeviceName
GetUniqueDescription
GetIndex
GetParentIndex
GetJTAGIndex
GetShortDescription
IDeviceLink properties

See also

AnyFlowsRunning method

(IDeviceLink interface)
Syntax
Function AnyFlowsRunning : Boolean;
Description
Example
See also
IDeviceLink interface

DownloadFlow method

(IDeviceLink interface)
Syntax
Function DownloadFlow : IProcessFlow;
Description
Example
See also
IDeviceLink interface

GetChild method

(IDeviceLink interface)
Syntax
Function GetChild(Index : Integer) : IDeviceLink;
Description
Example
See also
IDeviceLink interface

GetChildCount method

(IDeviceLink interface)
Syntax
Function GetChildCount : Integer;
Description
Example
See also
IDeviceLink interface

GetConfiguration method

(IDeviceLink interface)
Syntax
Function GetConfiguration : WideString;
Description
Example
See also
IDeviceLink interface

GetDeviceName method

(IDeviceLink interface)
Syntax
Function GetDeviceName : WideString;
Description
Example
See also
IDeviceLink interface

GetIndex method

(IDeviceLink interface)
Syntax
Function GetIndex : Integer;
Description
Example
See also
IDeviceLink interface

GetJTAGDevice method

(IDeviceLink interface)
Syntax
Function GetJTAGDevice : IJTAGDevice;
Description
Example
See also
IDeviceLink interface

GetJTAGIndex method

(IDeviceLink interface)
Syntax
Function GetJTAGIndex : Integer;
Description
Example
See also
IDeviceLink interface

GetNexusCore method

(IDeviceLink interface)
Syntax
Function GetNexusCore : INexusCore;
Description
Example
See also
IDeviceLink interface

GetNexusDevice method

(IDeviceLink interface)
Syntax
Function GetNexusDevice : INexusDevice;
Description
Example
See also
IDeviceLink interface

GetParent method

(IDeviceLink interface)
Syntax
Function GetParent : IDeviceLink;
Description
Example
See also
IDeviceLink interface

GetParentIndex method

(IDeviceLink interface)
Syntax
Function GetParentIndex : Integer;
Description
Example
See also
IDeviceLink interface

GetProject method

(IDeviceLink interface)
Syntax
Function GetProject : IProject;
Description
Example
See also
IDeviceLink interface

GetShortDescription method

(IDeviceLink interface)
Syntax
Function GetShortDescription : WideString;
Description
Example
See also
IDeviceLink interface

GetUniqueDescription method

(IDeviceLink interface)
Syntax
Function GetUniqueDescription : WideString;
Description
Example
See also
IDeviceLink interface

ProcessFlow method

(IDeviceLink interface)
Syntax
Function ProcessFlow : IProcessFlow;
Description
Example
See also
IDeviceLink interface

INexusCore Interface

Overview
The INexusCore interface hierarchy is as follows;

INexusCore methods
GetEmbeddedProject
GetFPGAProject
DownloadProgramMemory
GetNexusWorkbench
GetEmbeddedProjectPath
GetFPGAProjectPath
GetCoreKind
GetComponentDesignator
GetBaseComponentDesignator
GetLibraryReference
GetComponentDocumentPath
GetHexFilePath
GetJTagIndex_FromCore
GetHexFilename
GetHexFileState
GetUniqueId
GetDescription
MatchesOtherCore
Import_FromParameters
Export_ToParameters
SupportsParameter
GetParameterValue
Export_CoreGenParameters
FindFileInProjectPaths
GetChildCore
GetChildCoreDesignator
GetChildCoreCount
GetCrossViewProcessId
SetCrossViewProcessId
CrossProbe
GetChildProgramMemoryCore
SetEmbeddedProjectPath
UpdateHexFileState
GetChildProgramMemoryCoreCount
Import_FromParameterString
Export_ToParameterString
Export_CoreGenParametersToString
INexusCore properties

See also

CrossProbe method

(INexusCore interface)
Syntax
Procedure CrossProbe;
Description
Example
See also
INexusCore interface

DownloadProgramMemory method

(INexusCore interface)
Syntax
Procedure DownloadProgramMemory(NexusDevice : INexusDevice);
Description
Example
See also
INexusCore interface

Export_CoreGenParameters method

(INexusCore interface)
Syntax
Procedure Export_CoreGenParameters(Parameters : PChar);
Description
Example
See also
INexusCore interface

Export_CoreGenParametersToString method

(INexusCore interface)
Syntax
Function Export_CoreGenParametersToString : WideString;
Description
Example
See also
INexusCore interface

Export_ToParameters method

(INexusCore interface)
Syntax
Procedure Export_ToParameters (Parameters : PChar);
Description
Example
See also
INexusCore interface

Export_ToParameterString method

(INexusCore interface)
Syntax
Function Export_ToParameterString : WideString;
Description
Example
See also
INexusCore interface

FindFileInProjectPaths method

(INexusCore interface)
Syntax
Function FindFileInProjectPaths(FileName : WideString) : WideString;
Description
Example
See also
INexusCore interface

GetBaseComponentDesignator method

(INexusCore interface)
Syntax
Function GetBaseComponentDesignator : WideString;
Description
Example
See also
INexusCore interface

GetChildCore method

(INexusCore interface)
Syntax
Function GetChildCore (Index : Integer ) : INexusCore;
Description
Example
See also
INexusCore interface

GetChildCoreCount method

(INexusCore interface)
Syntax
Function GetChildCoreCount : Integer;
Description
Example
See also
INexusCore interface

GetChildCoreDesignator method

(INexusCore interface)
Syntax
Function GetChildCoreDesignator(Index : Integer ) : WideString;
Description
Example
See also
INexusCore interface

GetChildProgramMemoryCore method

(INexusCore interface)
Syntax
Function GetChildProgramMemoryCore(Index : Integer = 0) : INexusCore;
Description
Example
See also
INexusCore interface

GetChildProgramMemoryCoreCount method

(INexusCore interface)
Syntax
Function GetChildProgramMemoryCoreCount : Integer;
Description
Example
See also
INexusCore interface

GetComponentDesignator method

(INexusCore interface)
Syntax
Function GetComponentDesignator : WideString;
Description
Example
See also
INexusCore interface

GetComponentDocumentPath method

(INexusCore interface)
Syntax
Function GetComponentDocumentPath : WideString;
Description
Example
See also
INexusCore interface

GetCoreKind method

(INexusCore interface)
Syntax
Function GetCoreKind : TNexusCoreKind;
Description
Example
See also
INexusCore interface

GetCrossViewProcessId method

(INexusCore interface)
Syntax
Function GetCrossViewProcessId : Integer;
Description
Example
See also
INexusCore interface

GetDescription method

(INexusCore interface)
Syntax
Function GetDescription : WideString;
Description
Example
See also
INexusCore interface

GetEmbeddedProject method

(INexusCore interface)
Syntax
Function GetEmbeddedProject : IProject;
Description
Example
See also
INexusCore interface

GetEmbeddedProjectPath method

(INexusCore interface)
Syntax
Function GetEmbeddedProjectPath : WideString;
Description
Example
See also
INexusCore interface

GetFPGAProject method

(INexusCore interface)
Syntax
Function GetFPGAProject : IProject;
Description
Example
See also
INexusCore interface

GetFPGAProjectPath method

(INexusCore interface)
Syntax
Function GetFPGAProjectPath : WideString;
Description
Example
See also
INexusCore interface

GetHexFilename method

(INexusCore interface)
Syntax
Function GetHexFilename : WideString;
Description
Example
See also
INexusCore interface

GetHexFilePath method

(INexusCore interface)
Syntax
Function GetHexFilePath : WideString;
Description
Example
See also
INexusCore interface

GetHexFileState method

(INexusCore interface)
Syntax
Function GetHexFileState : TFlowState;
Description
Example
See also
INexusCore interface

GetJTagIndex_FromCore method

(INexusCore interface)
Syntax
Function GetJTagIndex_FromCore : Integer;
Description
Example
See also
INexusCore interface

GetLibraryReference method

(INexusCore interface)
Syntax
Function GetLibraryReference : WideString;
Description
Example
See also
INexusCore interface

GetNexusWorkbench method

(INexusCore interface)
Syntax
Function GetNexusWorkbench : INexusWorkbench;
Description
This method retrieves the Nexus workbench which encapsulates the workbench. You can use this interface to retrieve interfaces representing objects associated with this nexus workbench.
Example

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

See also
INexusCore interface

GetParameterValue method

(INexusCore interface)
Syntax
Function GetParameterValue (Name : WideString) : WideString;
Description
A component can have a number of parameters and each parameter has 2 strings – Name and Value. The GetParameterValue retrieves a Value string based on the specified Name parameter.
Example
See also
INexusCore interface

GetUniqueId method

(INexusCore interface)
Syntax
Function GetUniqueId : WideString;
Description
This method retrieves the Unique ID for thie Nexus core component. Ideally all components used in a design should have unique IDs for synchronization purposes.
Example
See also
INexusCore interface

Import_FromParameters method

(INexusCore interface)
Syntax
Procedure Import_FromParameters (Parameters : PChar);
Description
Example
See also
INexusCore interface

Import_FromParameterString method

(INexusCore interface)
Syntax
Procedure Import_FromParameterString (Const Parameters : WideString);
Description
Example
See also
INexusCore interface

MatchesOtherCore method

(INexusCore interface)
Syntax
Function MatchesOtherCore (ACore : INexusCore) : Boolean;
Description
Example
See also
INexusCore interface

SetCrossViewProcessId method

(INexusCore interface)
Syntax
Procedure SetCrossViewProcessId(ProcessID : THandle);
Description
Example
See also
INexusCore interface

SetEmbeddedProjectPath method

(INexusCore interface)
Syntax
Procedure SetEmbeddedProjectPath(AProjectPath : WideString);
Description
This method sets the project path to an embedded project. A parent FPGA project can have child embedded projects.
Example
See also
INexusCore interface

SupportsParameter method

(INexusCore interface)
Syntax
Function SupportsParameter (Name : WideString) : Boolean;
Description
Example
See also
INexusCore interface

UpdateHexFileState method

(INexusCore interface)
Syntax
Procedure UpdateHexFileState;
Description
Example
See also
INexusCore interface

INexusWorkbench Interface

Overview
The INexusWorkBench interface represents the workbench in Altium Designer that deals with the Nanoboard, its hard devices and the soft devices (processor cores and virtual instruments) inside the FPGA device on the Nanoboard.
The INexusWorkbench interface and its methods/properties are as follows:

INexusWorkbench methods
GetIsConnected
GetNexusCoreFromUniqueId
GetCoreFromDesignator
GetSoftDeviceFromDeviceId
GetProgrammableDeviceFromDeviceId
GetHardDeviceCount
GetSoftDeviceCount
GetBoardDeviceCount
GetProgrammableDeviceCount
GetHardDevice
GetSoftDevice
GetBoardDevice
GetProgrammableDevice
GetCurrentHardDevice
SetCurrentHardDevice
GetCurrentSoftDevice
SetCurrentSoftDevice
GetCurrentBoardDevice
SetCurrentBoardDevice
GetCurrentProgrammableDevice
SetCurrentProgrammableDevice
SetCurrentCore
GetProjectLinkCount
GetPCBProjectLinkCount
GetProjectLink
GetPCBProjectLink
ProcessFlowRunner
AddHardDeviceByName
RemoveHardDevice
SynthesizeCoresForProject
GetPoll
SetPoll
GetPollInterval
SetPollInterval
GetLive
SetLive
GetGoLiveAtStartup
SetGoLiveAtStartup
GetIgnoreSoftwareInHardFlow
SetIgnoreSoftwareInHardFlow
GetIgnoreFPGASourcesInFlow
SetIgnoreFPGASourcesInFlow
GetIgnoreVendorToolsVersion
SetIgnoreVendorToolsVersion
GetShowResultsSummary
SetShowResultsSummary
INexusWorkbench properties
HardDevices
SoftDevices
BoardDevices
ProjectLinks
PCBProjectLinks
ProgrammableDevices

See also

GetState and SetState methods

GetBoardDevice method

(INexusWorkbench interface)
Syntax
Function GetBoardDevice (Index : Integer) : IDeviceLink;
Description
Example
See also
INexusWorkbench interface

GetHardDevice method

(INexusWorkbench interface)
Syntax
Function GetHardDevice (Index : Integer) : IDeviceLink;
Description
Example
See also
INexusWorkbench interface

GetPCBProjectLink method

(INexusWorkbench interface)
Syntax
Function GetPCBProjectLink (aIndex : Integer) : IPCBProjectLink;
Description
Example
See also
INexusWorkbench interface

GetProjectLink method

(INexusWorkbench interface)
Syntax
Function GetProjectLink (aIndex : Integer) : IProjectLink;
Description
Example
See also
INexusWorkbench interface

GetSoftDevice method

(INexusWorkbench interface)
Syntax
Function GetSoftDevice (Index : Integer) : IDeviceLink;
Description
Example
See also
INexusWorkbench interface

Methods

AddHardDeviceByName method

(INexusWorkbench interface)
Syntax
Function AddHardDeviceByName (aDeviceName : WideString) : IDeviceLink;
Description
Example
See also
INexusWorkbench interface

GetBoardDeviceCount method

(INexusWorkbench interface)
Syntax
Function GetBoardDeviceCount : Integer;
Description
Example
See also
INexusWorkbench interface

GetCoreFromDesignator method

(INexusWorkbench interface)
Syntax
Function GetCoreFromDesignator (Designator : WideString;Project : IProject ) : INexusCore;
Description
Example
See also
INexusWorkbench interface

GetCurrentBoardDevice method

(INexusWorkbench interface)
Syntax
Function GetCurrentBoardDevice : IDeviceLink;
Description
Example
See also
INexusWorkbench interface

GetCurrentHardDevice method

(INexusWorkbench interface)
Syntax
Function GetCurrentHardDevice : IDeviceLink;
Description
Example
See also
INexusWorkbench interface

GetCurrentSoftDevice method

(INexusWorkbench interface)
Syntax
Function GetCurrentSoftDevice : IDeviceLink;
Description
Example
See also
INexusWorkbench interface

GetGoLiveAtStartup method

(INexusWorkbench interface)
Syntax
Function GetGoLiveAtStartup : Boolean;
Description
Example
See also
INexusWorkbench interface

GetHardDeviceCount method

(INexusWorkbench interface)
Syntax
Function GetHardDeviceCount : Integer;
Description
Example
See also
INexusWorkbench interface

GetIgnoreFPGASourcesInFlow method

(INexusWorkbench interface)
Syntax
Function GetIgnoreFPGASourcesInFlow : Boolean;
Description
Example
See also
INexusWorkbench interface

GetIgnoreSoftwareInHardFlow method

(INexusWorkbench interface)
Syntax
Function GetIgnoreSoftwareInHardFlow : Boolean;
Description
Example
See also
INexusWorkbench interface

GetIgnoreVendorToolsVersion method

(INexusWorkbench interface)
Syntax
Function GetIgnoreVendorToolsVersion : Boolean;
Description
Example
See also
INexusWorkbench interface

GetIsConnected method

(INexusWorkbench interface)
Syntax
Function GetIsConnected : LongBool;
Description
Example
See also
INexusWorkbench interface

GetLive method

(INexusWorkbench interface)
Syntax
Function GetLive : Boolean;
Description
Example
See also
INexusWorkbench interface

GetNexusCoreFromUniqueId method

(INexusWorkbench interface)
Syntax
Function GetNexusCoreFromUniqueId (AUniqueId : WideString) : INexusCore;
Description
Example
See also
INexusWorkbench interface

GetPCBProjectLinkCount method

(INexusWorkbench interface)
Syntax
Function GetPCBProjectLinkCount : Integer;
Description
Example
See also
INexusWorkbench interface

GetPoll method

(INexusWorkbench interface)
Syntax
Function GetPoll : Boolean;
Description
Example
See also
INexusWorkbench interface

GetPollInterval method

(INexusWorkbench interface)
Syntax
Function GetPollInterval : Integer;
Description
Example
See also
INexusWorkbench interface

GetProjectLinkCount method

(INexusWorkbench interface)
Syntax
Function GetProjectLinkCount : Integer;
Description
Example
See also
INexusWorkbench interface

GetShowResultsSummary method

(INexusWorkbench interface)
Syntax
Function GetShowResultsSummary : Boolean;
Description
Example
See also
INexusWorkbench interface

GetSoftDeviceCount method

(INexusWorkbench interface)
Syntax
Function GetSoftDeviceCount : Integer;
Description
Example
See also
INexusWorkbench interface

GetSoftDeviceFromDeviceId method

(INexusWorkbench interface)
Syntax
Function GetSoftDeviceFromDeviceId(AnId : WideString) : IDeviceLink;
Description
Example
See also
INexusWorkbench interface

ProcessFlowRunner method

(INexusWorkbench interface)
Syntax
Function ProcessFlowRunner : IProcessFlowRunner;
Description
Example
See also
INexusWorkbench interface

RemoveHardDevice method

(INexusWorkbench interface)
Syntax
Function RemoveHardDevice (aDeviceLink : IDeviceLink) : Boolean;
Description
Example
See also
INexusWorkbench interface

SetCurrentBoardDevice method

(INexusWorkbench interface)
Syntax
Procedure SetCurrentBoardDevice (ADevice : IDeviceLink);
Description
Example
See also
INexusWorkbench interface

SetCurrentCore method

(INexusWorkbench interface)
Syntax
Procedure SetCurrentCore (ACore : INexusCore);
Description
Example
See also
INexusWorkbench interface

SetCurrentHardDevice method

(INexusWorkbench interface)
Syntax
Procedure SetCurrentHardDevice (ADevice : IDeviceLink);
Description
Example
See also
INexusWorkbench interface

SetCurrentSoftDevice method

(INexusWorkbench interface)
Syntax
Procedure SetCurrentSoftDevice (ASoftDevice : IDeviceLink);
Description
Example
See also
INexusWorkbench interface

SetGoLiveAtStartup method

(INexusWorkbench interface)
Syntax
Procedure SetGoLiveAtStartup (aValue : Boolean);
Description
Example
See also
INexusWorkbench interface

SetIgnoreFPGASourcesInFlow method

(INexusWorkbench interface)
Syntax
Procedure SetIgnoreFPGASourcesInFlow (aValue : Boolean);
Description
Example
See also
INexusWorkbench interface

SetIgnoreSoftwareInHardFlow method

(INexusWorkbench interface)
Syntax
Procedure SetIgnoreSoftwareInHardFlow(aValue : Boolean);
Description
Example
See also
INexusWorkbench interface

SetIgnoreVendorToolsVersion method

(INexusWorkbench interface)
Syntax
Procedure SetIgnoreVendorToolsVersion(aValue : Boolean);
Description
Example
See also
INexusWorkbench interface

SetLive method

(INexusWorkbench interface)
Syntax
Procedure SetLive (aValue : Boolean);
Description
Example
See also
INexusWorkbench interface

SetPoll method

(INexusWorkbench interface)
Syntax
Procedure SetPoll (aValue : Boolean);
Description
Example
See also
INexusWorkbench interface

SetPollInterval method

(INexusWorkbench interface)
Syntax
Procedure SetPollInterval (aValue : Integer);
Description
Example
See also
INexusWorkbench interface

SetShowResultsSummary method

(INexusWorkbench interface)
Syntax
Procedure SetShowResultsSummary (aValue : Boolean);
Description
Example
See also
INexusWorkbench interface

SynthesizeCoresForProject method

(INexusWorkbench interface)
Syntax
Procedure SynthesizeCoresForProject (aProject : IAbstractVHDLProject;aConfiguration : WideString);
Description
Example
See also
INexusWorkbench interface

Properties

BoardDevices property

(INexusWorkbench interface)
Syntax
Property BoardDevices[aIndex : Integer] : IDeviceLink Read GetBoardDevice;
Description
Example
See also
INexusWorkbench interface

HardDevices property

(INexusWorkbench interface)
Syntax
Property HardDevices [aIndex : Integer] : IDeviceLink Read GetHardDevice;
Description
Example
See also
INexusWorkbench interface

PCBProjectLinks property

(INexusWorkbench interface)
Syntax
Property PCBProjectLinks [aIndex : Integer] : IPCBProjectLink Read GetPCBProjectLink;
Description
Example
See also
INexusWorkbench interface

ProjectLinks property

(INexusWorkbench interface)
Syntax
Property ProjectLinks [aIndex : Integer] : IProjectLink Read GetProjectLink;
Description
Example
See also
INexusWorkbench interface

SoftDevices property

(INexusWorkbench interface)
Syntax
Property SoftDevices [aIndex : Integer] : IDeviceLink Read GetSoftDevice;
Description
Example
See also
INexusWorkbench interface

INexusNotification Interface

Overview
The INexusNotification interface hierarchy is as follows;

INexusNotification methods
GetCode
INexusNotification properties
Code

See also

Code property

(INexusNotification interface)
Syntax
Property Code : Integer Read GetCode;
Description
Example
See also
INexusNotification interface

GetCode method

(INexusNotification interface)
Syntax
Function GetCode : Integer;
Description
Example
See also
INexusNotification interface

IPCBProjectLink Interface

Overview
The IPCBProjectLink interface hierarchy is as follows;

IPCBProjectLink methods
GetProject
GetProjectFullPath
DocumentKind
GetSchComponentLinkCount
GetSchComponentLink
ContainsProjectLink
CrossProbe
IPCBProjectLink properties

See also

ContainsProjectLink method

(IPCBProjectLink interface)
Syntax
Function ContainsProjectLink (AProjectLink : IProjectLink) : Boolean;
Description
Example
See also
IPCBProjectLink interface

CrossProbe method

(IPCBProjectLink interface)
Syntax
Procedure CrossProbe;
Description
Example
See also
IPCBProjectLink interface

DocumentKind method

(IPCBProjectLink interface)
Syntax
Function DocumentKind : WideString;
Description
Example
See also
IPCBProjectLink interface

GetProject method

(IPCBProjectLink interface)
Syntax
Function GetProject : IProject;
Description
Example
See also
IPCBProjectLink interface

GetProjectFullPath method

(IPCBProjectLink interface)
Syntax
Function GetProjectFullPath : WideString;
Description
Example
See also
IPCBProjectLink interface

GetSchComponentLink method

(IPCBProjectLink interface)
Syntax
Function GetSchComponentLink (Index : Integer) : ISchComponentLink;
Description
Example
See also
IPCBProjectLink interface

GetSchComponentLinkCount method

(IPCBProjectLink interface)
Syntax
Function GetSchComponentLinkCount : Integer;
Description
Example
See also
IPCBProjectLink interface

IProjectLink Interface

Overview
The IProjectLink interface represents the project links as part of the Nexus Workspace and the interface can fetch the fpga project, embedded project and the generic project.

IProjectLink methods
GetProject
GetFPGAProject
GetEmbeddedProject
GetProjectFullPath
DocumentKind
ContainsEmbeddedProject
GetCoreFromDesignator
GetCoreFromDesignator
GetNexusCoreCount_All
GetNexusCoreCount_Instrument
GetNexusCore_All
GetNexusCore_Instrument
IProjectLink properties
NexusCores_All
NexusCores_Instrument

See also
IProject interface

GetState and SetState Methods

GetNexusCore_All method

(IProjectLink interface)
Syntax
Function GetNexusCore_All (Index : Integer) : INexusCore;
Description
Example
See also
IProjectLink interface

GetNexusCore_Instrument method

(IProjectLink interface)
Syntax
Function GetNexusCore_Instrument(Index : Integer) : INexusCore;
Description
Example
See also
IProjectLink interface

Methods

ContainsEmbeddedProject method

(IProjectLink interface)
Syntax
Function ContainsEmbeddedProject (AProjectPath : WideString) : Boolean;
Description
Example
See also
IProjectLink interface

DocumentKind method

(IProjectLink interface)
Syntax
Function DocumentKind : WideString;
Description
Example
See also
IProjectLink interface

GetCoreFromDesignator method

(IProjectLink interface)
Syntax
Function GetCoreFromDesignator (Designator : WideString) : INexusCore;
Description
Example
See also
IProjectLink interface

GetFPGAProject method

(IProjectLink interface)
Syntax
Function GetFPGAProject : IFPGAProject;
Description
Example
See also
IProjectLink interface

GetNexusCoreCount_All method

(IProjectLink interface)
Syntax
Function GetNexusCoreCount_All : Integer;
Description
Example
See also
IProjectLink interface

GetNexusCoreCount_Instrument method

(IProjectLink interface)
Syntax
Function GetNexusCoreCount_Instrument : Integer;
Description
Example
See also
IProjectLink interface

GetProject method

(IProjectLink interface)
Syntax
Function GetProject : IProject;
Description
Example
See also
IProjectLink interface
IFPGAProject interface

GetFGPAProject method

(IProjectLink interface)
Syntax
Function GetFPGAProject : IFPGAProject;
Description
Example
See also
IProjectLink interface
IEmbeddedProject interface

GetEmbeddedProject method

(IProjectLink interface)
Syntax
Function GetEmbeddedProject : IEmbeddedProject;
Description
Example
See also
IProjectLink interface
IFPGAProject interface

GetProjectFullPath method

(IProjectLink interface)
Syntax
Function GetProjectFullPath : WideString;
Description
Example
See also
IProjectLink interface

Properties

NexusCores_All [aIndex property

(IProjectLink interface)
Syntax
Property NexusCores_All [aIndex : Integer] : INexusCore Read GetNexusCore_All;
Description
Example
See also
IProjectLink interface

NexusCores_Instrument[aIndex property

(IProjectLink interface)
Syntax
Property NexusCores_Instrument[aIndex : Integer] : INexusCore Read GetNexusCore_Instrument;
Description
Example
See also
IProjectLink interface

ISchComponentLink Interface

Overview
The ISchComponentLink interface hierarchy is as follows;

ISchComponentLink methods
GetComponentDesignator
GetLibraryReference
GetComponentDocumentPath
GetSubProjectPath
GetDescription
GetProjectPath
GetProjectLink
CrossProbe
SetSubProjectPath
ISchComponentLink properties

See also

CrossProbe method

(ISchComponentLink interface)
Syntax
Procedure CrossProbe;
Description
Example
See also
ISchComponentLink interface

GetComponentDesignator method

(ISchComponentLink interface)
Syntax
Function GetComponentDesignator : WideString;
Description
Example
See also
ISchComponentLink interface

GetComponentDocumentPath method

(ISchComponentLink interface)
Syntax
Function GetComponentDocumentPath : WideString;
Description
Example
See also
ISchComponentLink interface

GetDescription method

(ISchComponentLink interface)
Syntax
Function GetDescription : WideString;
Description
Example
See also
ISchComponentLink interface

GetLibraryReference method

(ISchComponentLink interface)
Syntax
Function GetLibraryReference : WideString;
Description
Example
See also
ISchComponentLink interface

GetProjectLink method

(ISchComponentLink interface)
Syntax
Function GetProjectLink : IProjectLink;
Description
Example
See also
ISchComponentLink interface

GetProjectPath method

(ISchComponentLink interface)
Syntax
Function GetProjectPath : WideString;
Description
Example
See also
ISchComponentLink interface

GetSubProjectPath method

(ISchComponentLink interface)
Syntax
Function GetSubProjectPath : WideString;
Description
Example
See also
ISchComponentLink interface

SetSubProjectPath method

(ISchComponentLink interface)
Syntax
Procedure SetSubProjectPath (AProjectPath : WideString);
Description
Example
See also
ISchComponentLink interface

You are reporting an issue with the following selected text and/or image within the active document:
ALTIUM DESIGNER FREE TRIAL
Altium Designer Free Trial
Let’s get started. First off, are you or your organization already using Altium Designer?

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

In that case, why do you need an evaluation license?

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

Got it. You actually don’t need an evaluation license for that.

Click the button below to download the latest Altium Designer installer.

Download Altium Designer Installer

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

Please fill out the form below to get a quote for a new seat of Altium Designer.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

If you are on Altium Subscription, you don’t need an evaluation license.

If you are not an active Altium Subscription member, please fill out the form below to get your free trial.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Why are you looking to evaluate Altium Designer?

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

You came to the right place! Please fill out the form below to get your free trial started.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Sounds exciting! Did you know we offer special discounted student licenses? For more information, click here.

In the meantime, feel free to request a free trial by filling out the form below.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Got it. You can download a free Altium Designer Viewer license which is valid for a 6 months.

Please fill out the form below to request one.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

That’s great! Making things is awesome. We have the perfect program for you.

Upverter is a free community-driven platform designed specifically to meet the needs of makers like you.

Click here to give it a try!

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

Got it. You can download a free Altium Designer Viewer license which is valid for a 6 months.

Please fill out the form below to request one.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.