Skip to main content
View as Markdown

ISignalIntegrityAnalyser interface

No description yet.

public interface ISignalIntegrityAnalyser

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Methods​

MethodReturnsDescription
AddNetErrorMessagesvoid
AddNetForCoupledCheckvoid
AddTempComponentMappingvoid
AddToCrosstalkvoid
CanEditSimulatedNetsOptionsbool
ClearCoupledCheckvoid
ClearCrosstalkvoid
ClearErrorMessagesvoid
ClearTempComponentMappingsvoid
EditPreferencesbool
EditSimulatedNetsOptionsbool
FindCoupledNetsint
GenerateScreeningDatavoid
GetCoupledNetstring
GetDocumentFileNamestring
GetPCBBoardHandleint
GetResultCountint
GetResultSetISignalIntegrityResultSet
GetSignalIntegrityReportISignalIntegrityReport
Initialisebool
NetHasErrorMessagesbool
Refreshvoid
RunCrosstalkbool
ShowNotAnalysedErrorMessagesvoid
ShowSelectedErrorMessagesvoid

AddNetErrorMessages​

No description yet.

void AddNetErrorMessages(string argNetName);
ParameterTypePassing
argNetNamestringvalue

Returns: nothing (void)

AddNetForCoupledCheck​

No description yet.

void AddNetForCoupledCheck(string argNetName);
ParameterTypePassing
argNetNamestringvalue

Returns: nothing (void)

AddTempComponentMapping​

No description yet.

void AddTempComponentMapping(string argUniqueID, string argParameters);
ParameterTypePassing
argUniqueIDstringvalue
argParametersstringvalue

Returns: nothing (void)

AddToCrosstalk​

No description yet.

void AddToCrosstalk(ISignalIntegrityResultSet argResultSet);
void AddToCrosstalk(object argResultSet);
ParameterTypePassing
argResultSetISignalIntegrityResultSetvalue

Returns: nothing (void)

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

CanEditSimulatedNetsOptions​

No description yet.

bool CanEditSimulatedNetsOptions();

Returns: bool

ClearCoupledCheck​

No description yet.

void ClearCoupledCheck();

Returns: nothing (void)

ClearCrosstalk​

No description yet.

void ClearCrosstalk();

Returns: nothing (void)

ClearErrorMessages​

No description yet.

void ClearErrorMessages();

Returns: nothing (void)

ClearTempComponentMappings​

No description yet.

void ClearTempComponentMappings();

Returns: nothing (void)

EditPreferences​

No description yet.

bool EditPreferences();

Returns: bool

EditSimulatedNetsOptions​

No description yet.

bool EditSimulatedNetsOptions(bool argFirstTimeOnly);
ParameterTypePassing
argFirstTimeOnlyboolvalue

Returns: bool

FindCoupledNets​

No description yet.

int FindCoupledNets();

Returns: int

GenerateScreeningData​

No description yet.

void GenerateScreeningData(string argNetClass);
ParameterTypePassing
argNetClassstringvalue

Returns: nothing (void)

GetCoupledNet​

No description yet.

string GetCoupledNet(int argIndex);
ParameterTypePassing
argIndexintvalue

Returns: string

GetDocumentFileName​

No description yet.

string GetDocumentFileName();

Returns: string

GetPCBBoardHandle​

No description yet.

int GetPCBBoardHandle();

Returns: int

GetResultCount​

No description yet.

int GetResultCount();

Returns: int

GetResultSet​

No description yet.

ISignalIntegrityResultSet GetResultSet(int argIndex);
ParameterTypePassing
argIndexintvalue

Returns: ISignalIntegrityResultSet

Extension method of ISignalIntegrityAnalyserHelper (using SCH;).

GetSignalIntegrityReport​

No description yet.

ISignalIntegrityReport GetSignalIntegrityReport();

Returns: ISignalIntegrityReport

Extension method of ISignalIntegrityAnalyserHelper (using SCH;).

Initialise​

No description yet.

bool Initialise();

Returns: bool

NetHasErrorMessages​

No description yet.

bool NetHasErrorMessages(string argNetName);
ParameterTypePassing
argNetNamestringvalue

Returns: bool

Refresh​

No description yet.

void Refresh();

Returns: nothing (void)

RunCrosstalk​

No description yet.

bool RunCrosstalk(string argFileName, TTerminationType argTermType, double argR1, double argR2, double argC, double argVCC);
bool RunCrosstalk(string argFileName, int argTermType, double argR1, double argR2, double argC, double argVCC);
ParameterTypePassing
argFileNamestringvalue
argTermTypeTTerminationTypevalue
argR1doublevalue
argR2doublevalue
argCdoublevalue
argVCCdoublevalue

Returns: bool

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

ShowNotAnalysedErrorMessages​

No description yet.

void ShowNotAnalysedErrorMessages();

Returns: nothing (void)

ShowSelectedErrorMessages​

No description yet.

void ShowSelectedErrorMessages();

Returns: nothing (void)