INexusCore interface

No description yet.

public interface INexusCore

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Properties

Property	Type	Access	Description
EmbeddedProjectPath	string	get; set

EmbeddedProjectPath

No description yet.

string GetEmbeddedProjectPath();
void SetEmbeddedProjectPath(string argProjectPath);

Type: string · Access: read/write

Methods

Method	Returns	Description
CrossProbe	void
DownloadProgramMemory	void
Export_CoreGenParameters	void
Export_CoreGenParametersToString	string
Export_ToParameters	void
Export_ToParameterString	string
FindFileInProjectPaths	string
GetAspComponentDesignator	string
GetBaseComponentDesignator	string
GetChildCore	INexusCore
GetChildCoreCount	int
GetChildCoreDesignator	string
GetChildProgramMemoryCore	INexusCore
GetChildProgramMemoryCoreCount	int
GetComponentDesignator	string
GetComponentDocumentPath	string
GetCoreKind	TNexusCoreKind
GetCrossViewProcessId	int
GetDescription	string
GetDeviceName	string
GetEmbeddedProject	IProject
GetFPGAProject	IProject
GetFPGAProjectPath	string
GetHexFileEndianness	string
GetHexFilename	string
GetHexFilePath	string
GetHexFileState	TFlowState
GetJTagIndex_FromCore	int
GetLibraryReference	string
GetNexusWorkbench	INexusWorkbench
GetParameterValue	string
GetUniqueId	string
Import_FromParameters	void
Import_FromParameterString	void
MatchesOtherCore	bool
SetCrossViewProcessId	void
SupportsParameter	bool
UpdateHexFileState	void
VerifyProgramMemory	void

CrossProbe

No description yet.

void CrossProbe();

Returns: nothing (void)

DownloadProgramMemory

No description yet.

void DownloadProgramMemory(INexusDevice argNexusDevice);
void DownloadProgramMemory(object argNexusDevice);

Parameter	Type	Passing
argNexusDevice	INexusDevice	value

Returns: nothing (void)

The first overload is an extension method of INexusCoreHelper (using SCH;) with typed parameters; the second is declared by the interface.

Export_CoreGenParameters

No description yet.

void Export_CoreGenParameters(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

Export_CoreGenParametersToString

No description yet.

string Export_CoreGenParametersToString();

Returns: string

Export_ToParameters

No description yet.

void Export_ToParameters(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

Export_ToParameterString

No description yet.

string Export_ToParameterString();

Returns: string

FindFileInProjectPaths

No description yet.

string FindFileInProjectPaths(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: string

GetAspComponentDesignator

No description yet.

string GetAspComponentDesignator();

Returns: string

GetBaseComponentDesignator

No description yet.

string GetBaseComponentDesignator();

Returns: string

GetChildCore

No description yet.

INexusCore GetChildCore(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: INexusCore

Extension method of INexusCoreHelper (using SCH;).

GetChildCoreCount

No description yet.

int GetChildCoreCount();

Returns: int

GetChildCoreDesignator

No description yet.

string GetChildCoreDesignator(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: string

GetChildProgramMemoryCore

No description yet.

INexusCore GetChildProgramMemoryCore(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: INexusCore

Extension method of INexusCoreHelper (using SCH;).

GetChildProgramMemoryCoreCount

No description yet.

int GetChildProgramMemoryCoreCount();

Returns: int

GetComponentDesignator

No description yet.

string GetComponentDesignator();

Returns: string

GetComponentDocumentPath

No description yet.

string GetComponentDocumentPath();

Returns: string

GetCoreKind

No description yet.

TNexusCoreKind GetCoreKind();

Returns: TNexusCoreKind

Extension method of INexusCoreHelper (using SCH;).

GetCrossViewProcessId

No description yet.

int GetCrossViewProcessId();

Returns: int

GetDescription

No description yet.

string GetDescription();

Returns: string

GetDeviceName

No description yet.

string GetDeviceName();

Returns: string

GetEmbeddedProject

No description yet.

IProject GetEmbeddedProject();

Returns: IProject

Extension method of INexusCoreHelper (using SCH;).

GetFPGAProject

No description yet.

IProject GetFPGAProject();

Returns: IProject

Extension method of INexusCoreHelper (using SCH;).

GetFPGAProjectPath

No description yet.

string GetFPGAProjectPath();

Returns: string

GetHexFileEndianness

No description yet.

string GetHexFileEndianness();

Returns: string

GetHexFilename

No description yet.

string GetHexFilename();

Returns: string

GetHexFilePath

No description yet.

string GetHexFilePath();

Returns: string

GetHexFileState

No description yet.

TFlowState GetHexFileState();

Returns: TFlowState

Extension method of INexusCoreHelper (using SCH;).

GetJTagIndex_FromCore

No description yet.

int GetJTagIndex_FromCore();

Returns: int

GetLibraryReference

No description yet.

string GetLibraryReference();

Returns: string

GetNexusWorkbench

No description yet.

INexusWorkbench GetNexusWorkbench();

Returns: INexusWorkbench

Extension method of INexusCoreHelper (using SCH;).

GetParameterValue

No description yet.

string GetParameterValue(string argName);

Parameter	Type	Passing
argName	string	value

Returns: string

GetUniqueId

No description yet.

string GetUniqueId();

Returns: string

Import_FromParameters

No description yet.

void Import_FromParameters(string argParameters);

Parameter	Type	Passing
argParameters	string	value

Returns: nothing (void)

Import_FromParameterString

No description yet.

void Import_FromParameterString(string argParameters);

Parameter	Type	Passing
argParameters	string	value

Returns: nothing (void)

MatchesOtherCore

No description yet.

bool MatchesOtherCore(INexusCore argCore);
bool MatchesOtherCore(object argCore);

Parameter	Type	Passing
argCore	INexusCore	value

Returns: bool

The first overload is an extension method of INexusCoreHelper (using SCH;) with typed parameters; the second is declared by the interface.

SetCrossViewProcessId

No description yet.

void SetCrossViewProcessId(UIntPtr argProcessID);
void SetCrossViewProcessId(object argProcessID);

Parameter	Type	Passing
argProcessID	UIntPtr	value

Returns: nothing (void)

The first overload is an extension method of INexusCoreHelper (using SCH;) with typed parameters; the second is declared by the interface.

SupportsParameter

No description yet.

bool SupportsParameter(string argName);

Parameter	Type	Passing
argName	string	value

Returns: bool

UpdateHexFileState

No description yet.

void UpdateHexFileState();

Returns: nothing (void)

VerifyProgramMemory

No description yet.

void VerifyProgramMemory(INexusDevice argNexusDevice);
void VerifyProgramMemory(object argNexusDevice);

Parameter	Type	Passing
argNexusDevice	INexusDevice	value

Returns: nothing (void)

The first overload is an extension method of INexusCoreHelper (using SCH;) with typed parameters; the second is declared by the interface.

Returned by

IDeviceLink.GetNexusCore, INexusWorkbench.GetCoreFromDesignator, INexusWorkbench.GetCoreFromDevice, IProjectLink.GetCoreFromDesignator, IProjectLink.GetNexusCore_All, IProjectLink.GetNexusCore_Instrument