Skip to main content
View as Markdown

ISourceWave interface

No description yet.

public interface ISourceWave : IWave

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Inherits: IPrimitive → IWave

Properties​

PropertyTypeAccessDescription
CumulativeErrordoubleget; set
Datapointsboolget
Generatedboolget
Importedboolget
WaveTypeTWaveTypeget; set

CumulativeError​

No description yet.

double GetProperty_CumulativeError();
void SetProperty_CumulativeError(double argValue);

Type: double · Access: read/write

Datapoints​

No description yet.

bool GetProperty_Datapoints();

Type: bool · Access: read-only

Generated​

No description yet.

bool GetProperty_Generated();

Type: bool · Access: read-only

Imported​

No description yet.

bool GetProperty_Imported();

Type: bool · Access: read-only

WaveType​

No description yet.

TWaveType GetProperty_WaveType();
void SetProperty_WaveType(TWaveType argValue);

Type: TWaveType · Access: read/write

The accessors are extension methods of ISourceWaveHelper (using SCH;).

Methods​

MethodReturnsDescription
GenerateWavevoid
MakeCopyIPlottedWave
MakeFFTWavevoid
NameChangevoid
ReplicateISourceWave

GenerateWave​

No description yet.

void GenerateWave();

Returns: nothing (void)

MakeCopy​

No description yet.

IPlottedWave MakeCopy();

Returns: IPlottedWave

Extension method of ISourceWaveHelper (using SCH;).

MakeFFTWave​

No description yet.

void MakeFFTWave(ISourceWave argWave, ref int argFFTLength);
void MakeFFTWave(object argWave, ref int argFFTLength);
ParameterTypePassing
argWaveISourceWavevalue
argFFTLengthintref

Returns: nothing (void)

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

NameChange​

No description yet.

void NameChange(int argChangeIndex);
ParameterTypePassing
argChangeIndexintvalue

Returns: nothing (void)

Replicate​

No description yet.

ISourceWave Replicate();

Returns: ISourceWave

Extension method of ISourceWaveHelper (using SCH;).

Inherited members​

Returned by​

IChart.AddNewSourceWave, IChart.SourceWave, IChart.SourceWaveByName, ISourceWaveList.SourceWave

Accepted by​

IChart.AddSourceWave, IChart.DeleteSourceWave_1, IChartCollection.AddDataPointToChart