Skip to main content

IWaveSimDocument interface

No description yet.

public interface IWaveSimDocument

Namespace: EDP · Assembly: Altium.SDK.Interfaces

Properties​

PropertyTypeAccessDescription
RowIWaveRowget
RowCountintget

Row​

No description yet.

IWaveRow GetProperty_Row(int argIndex);

Type: IWaveRow · Access: read-only · Index: argIndex (int)

The accessors are extension methods of IWaveSimDocumentHelper (using EDP;).

RowCount​

No description yet.

int GetProperty_RowCount();

Type: int · Access: read-only

Methods​

MethodReturnsDescription
AddSignalIWaveSignal
AddSignalGroupIWaveSignalGroup
AddSignalToGroupIWaveSignal
AddSignalUncIWaveSignal
AddTypeIWaveType
AppendSignalIWaveSignal
CheckAllAccessTypesvoid
ClearAllvoid
DocumentChangevoid
GetSignalIWaveSignal
GetSignalByUidIWaveSignal
GetTypeIWaveType
Redrawvoid
RemoveSignalvoid
RestoreLayoutInformationvoid
SaveLayoutInformationvoid
SetEndOfSimTimevoid
SetSampleRatevoid
ZoomAllvoid
ZoomInvoid
ZoomOnTimeSlicevoid
ZoomOutvoid

AddSignal​

No description yet.

IWaveSignal AddSignal(string argName, string argTypeName);
ParameterTypePassing
argNamestringvalue
argTypeNamestringvalue

Returns: IWaveSignal

Extension method of IWaveSimDocumentHelper (using EDP;).

AddSignalGroup​

No description yet.

IWaveSignalGroup AddSignalGroup(string argName, string argStyleName);
ParameterTypePassing
argNamestringvalue
argStyleNamestringvalue

Returns: IWaveSignalGroup

Extension method of IWaveSimDocumentHelper (using EDP;).

AddSignalToGroup​

No description yet.

IWaveSignal AddSignalToGroup(string argName, IWaveSignalGroup argGroup, string argStyleName);
ParameterTypePassing
argNamestringvalue
argGroupIWaveSignalGroupvalue
argStyleNamestringvalue

Returns: IWaveSignal

Extension method of IWaveSimDocumentHelper (using EDP;).

AddSignalUnc​

No description yet.

IWaveSignal AddSignalUnc(string argName, string argTypeName, int argLeft, int argRight);
ParameterTypePassing
argNamestringvalue
argTypeNamestringvalue
argLeftintvalue
argRightintvalue

Returns: IWaveSignal

Extension method of IWaveSimDocumentHelper (using EDP;).

AddType​

No description yet.

IWaveType AddType(string argName, TWaveTypeKind argTypeKind);
ParameterTypePassing
argNamestringvalue
argTypeKindTWaveTypeKindvalue

Returns: IWaveType

Extension method of IWaveSimDocumentHelper (using EDP;).

AppendSignal​

No description yet.

IWaveSignal AppendSignal(string argName, string argTypeName, string argStyleName);
ParameterTypePassing
argNamestringvalue
argTypeNamestringvalue
argStyleNamestringvalue

Returns: IWaveSignal

Extension method of IWaveSimDocumentHelper (using EDP;).

CheckAllAccessTypes​

No description yet.

void CheckAllAccessTypes();

Returns: nothing (void)

ClearAll​

No description yet.

void ClearAll();

Returns: nothing (void)

DocumentChange​

No description yet.

void DocumentChange(bool argDirty);
ParameterTypePassing
argDirtyboolvalue

Returns: nothing (void)

GetSignal​

No description yet.

IWaveSignal GetSignal(string argName);
ParameterTypePassing
argNamestringvalue

Returns: IWaveSignal

Extension method of IWaveSimDocumentHelper (using EDP;).

GetSignalByUid​

No description yet.

IWaveSignal GetSignalByUid(int argUniqueId);
ParameterTypePassing
argUniqueIdintvalue

Returns: IWaveSignal

Extension method of IWaveSimDocumentHelper (using EDP;).

GetType​

No description yet.

IWaveType GetType(string argName);
ParameterTypePassing
argNamestringvalue

Returns: IWaveType

Extension method of IWaveSimDocumentHelper (using EDP;).

Redraw​

No description yet.

void Redraw();

Returns: nothing (void)

RemoveSignal​

No description yet.

void RemoveSignal(string argName);
ParameterTypePassing
argNamestringvalue

Returns: nothing (void)

RestoreLayoutInformation​

No description yet.

void RestoreLayoutInformation(bool argNameAsKey);
ParameterTypePassing
argNameAsKeyboolvalue

Returns: nothing (void)

SaveLayoutInformation​

No description yet.

void SaveLayoutInformation(bool argNameAsKey);
ParameterTypePassing
argNameAsKeyboolvalue

Returns: nothing (void)

SetEndOfSimTime​

No description yet.

void SetEndOfSimTime(double argTime);
ParameterTypePassing
argTimedoublevalue

Returns: nothing (void)

SetSampleRate​

No description yet.

void SetSampleRate(double argTime);
ParameterTypePassing
argTimedoublevalue

Returns: nothing (void)

ZoomAll​

No description yet.

void ZoomAll();

Returns: nothing (void)

ZoomIn​

No description yet.

void ZoomIn();

Returns: nothing (void)

ZoomOnTimeSlice​

No description yet.

void ZoomOnTimeSlice(double argTime1, double argTime2);
ParameterTypePassing
argTime1doublevalue
argTime2doublevalue

Returns: nothing (void)

ZoomOut​

No description yet.

void ZoomOut();

Returns: nothing (void)