IWave interface

No description yet.

public interface IWave : IPrimitive

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Inherits: IPrimitive

Derived: IPlottedWave, ISourceWave

Properties

Property	Type	Access	Description
DataType	TDataType	get; set
Hint	string	get; set
Name	string	get; set
ParentChart	IChart	get; set
PointCount	int	get
XComplex	bool	get
XImag	float	get; set
XPlot	float	get
XReal	float	get; set
XValue	double	get
YComplex	bool	get
YImag	float	get; set
YPlot	float	get
YReal	float	get; set
YUnits	string	get; set
YValue	double	get

DataType

No description yet.

TDataType GetProperty_DataType();
void SetProperty_DataType(TDataType argValue);

Type: TDataType · Access: read/write

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

Hint

No description yet.

string GetProperty_Hint();
void SetProperty_Hint(string argValue);

Type: string · Access: read/write

Name

No description yet.

string GetProperty_Name();
void SetProperty_Name(string argValue);

Type: string · Access: read/write

ParentChart

No description yet.

IChart GetProperty_ParentChart();
void SetProperty_ParentChart(IChart argValue);

Type: IChart · Access: read/write

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

PointCount

No description yet.

int GetProperty_PointCount();

Type: int · Access: read-only

XComplex

No description yet.

bool GetProperty_XComplex();

Type: bool · Access: read-only

XImag

No description yet.

float GetProperty_XImag(int argIndex);
void SetProperty_XImag(int argIndex, float argValue);

Type: float · Access: read/write · Index: argIndex (int)

XPlot

No description yet.

float GetProperty_XPlot(int argIndex);

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

XReal

No description yet.

float GetProperty_XReal(int argIndex);
void SetProperty_XReal(int argIndex, float argValue);

Type: float · Access: read/write · Index: argIndex (int)

XValue

No description yet.

double GetProperty_XValue(double argYValue);

Type: double · Access: read-only · Index: argYValue (double)

YComplex

No description yet.

bool GetProperty_YComplex();

Type: bool · Access: read-only

YImag

No description yet.

float GetProperty_YImag(int argIndex);
void SetProperty_YImag(int argIndex, float argValue);

Type: float · Access: read/write · Index: argIndex (int)

YPlot

No description yet.

float GetProperty_YPlot(int argIndex);

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

YReal

No description yet.

float GetProperty_YReal(int argIndex);
void SetProperty_YReal(int argIndex, float argValue);

Type: float · Access: read/write · Index: argIndex (int)

YUnits

No description yet.

string GetProperty_YUnits();
void SetProperty_YUnits(string argValue);

Type: string · Access: read/write

YValue

No description yet.

double GetProperty_YValue(double argXValue);

Type: double · Access: read-only · Index: argXValue (double)

Methods

Method	Returns	Description
AddPoint	int
ClearPoints	void
GetLineValues	bool
GetMaximum	bool
GetMinimum	bool
GetNextPeak	bool
GetNextTrough	bool
GetRiseFallTime	bool
GetState_MinMax	void
GetState_MinMax_1	void
GetTopLine	bool
InsertPoint	void
SetDataIndeces	void

AddPoint

No description yet.

int AddPoint(double argRealX, double argImagX, double argRealY, double argImagY);

Parameter	Type	Passing
argRealX	double	value
argImagX	double	value
argRealY	double	value
argImagY	double	value

Returns: int

ClearPoints

No description yet.

void ClearPoints();

Returns: nothing (void)

GetLineValues

No description yet.

bool GetLineValues(Coord argMin, Coord argMax, ref double argBaseVal, ref double argTopVal);
bool GetLineValues(ICoord argMin, ICoord argMax, ref double argBaseVal, ref double argTopVal);

Parameter	Type	Passing
argMin	Coord	value
argMax	Coord	value
argBaseVal	double	ref
argTopVal	double	ref

Returns: bool

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

GetMaximum

No description yet.

bool GetMaximum(Coord argMin, Coord argMax, ref Coord argResult);
bool GetMaximum(ICoord argMin, ICoord argMax, ref ICoord argResult);

Parameter	Type	Passing
argMin	Coord	value
argMax	Coord	value
argResult	Coord	ref

Returns: bool

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

GetMinimum

No description yet.

bool GetMinimum(Coord argMin, Coord argMax, ref Coord argResult);
bool GetMinimum(ICoord argMin, ICoord argMax, ref ICoord argResult);

Parameter	Type	Passing
argMin	Coord	value
argMax	Coord	value
argResult	Coord	ref

Returns: bool

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

GetNextPeak

No description yet.

bool GetNextPeak(int argCurrentDataPoint, int argDirection, ref Coord argResult);
bool GetNextPeak(int argCurrentDataPoint, int argDirection, ref ICoord argResult);

Parameter	Type	Passing
argCurrentDataPoint	int	value
argDirection	int	value
argResult	Coord	ref

Returns: bool

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

GetNextTrough

No description yet.

bool GetNextTrough(int argCurrentDataPoint, int argDirection, ref Coord argResult);
bool GetNextTrough(int argCurrentDataPoint, int argDirection, ref ICoord argResult);

Parameter	Type	Passing
argCurrentDataPoint	int	value
argDirection	int	value
argResult	Coord	ref

Returns: bool

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

GetRiseFallTime

No description yet.

bool GetRiseFallTime(Coord argMin, Coord argMax, ref double argRiseTime, ref double argFallTime);
bool GetRiseFallTime(ICoord argMin, ICoord argMax, ref double argRiseTime, ref double argFallTime);

Parameter	Type	Passing
argMin	Coord	value
argMax	Coord	value
argRiseTime	double	ref
argFallTime	double	ref

Returns: bool

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

GetState_MinMax

No description yet.

void GetState_MinMax(ref double argMinX, ref double argMaxX, ref double argMinY, ref double argMaxY);

Parameter	Type	Passing
argMinX	double	ref
argMaxX	double	ref
argMinY	double	ref
argMaxY	double	ref

Returns: nothing (void)

GetState_MinMax_1

No description yet.

void GetState_MinMax_1(ref double argMinX, ref double argMaxX, ref double argMinY, ref double argMaxY, TScaleMode argnXScaleMode, int argLogScaleBase);
void GetState_MinMax_1(ref double argMinX, ref double argMaxX, ref double argMinY, ref double argMaxY, int argnXScaleMode, int argLogScaleBase);

Parameter	Type	Passing
argMinX	double	ref
argMaxX	double	ref
argMinY	double	ref
argMaxY	double	ref
argnXScaleMode	TScaleMode	value
argLogScaleBase	int	value

Returns: nothing (void)

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

GetTopLine

No description yet.

bool GetTopLine(Coord argMin, Coord argMax, ref double argResult);
bool GetTopLine(ICoord argMin, ICoord argMax, ref double argResult);

Parameter	Type	Passing
argMin	Coord	value
argMax	Coord	value
argResult	double	ref

Returns: bool

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

InsertPoint

No description yet.

void InsertPoint(double argRealX, double argImagX, double argRealY, double argImagY, int argIndex);

Parameter	Type	Passing
argRealX	double	value
argImagX	double	value
argRealY	double	value
argImagY	double	value
argIndex	int	value

Returns: nothing (void)

SetDataIndeces

No description yet.

void SetDataIndeces(bool argnXComplexFlag, bool argYComplexFlag);

Parameter	Type	Passing
argnXComplexFlag	bool	value
argYComplexFlag	bool	value

Returns: nothing (void)

Inherited members

• From IPrimitive: BoundingRect, ViewablePrimitiveId

Returned by

IWaveList.Wave