FFTParameter class is used to specify a required parameter when running a Fourier transformation for graph data.
The class can be called from Application class.
. More...

Public Member Functions
void	AddDataSet (DataSet *dataset)
	Adds a data set to run a Fourier transformation on. More...

bool	IsValid ()
	Returns True if an object is valid. More...

void	SetAxisType (String &mapper)
	Specifies the X-axis type (For example, time, steps, angle). More...

void	SetCreateGraph (bool createGraph)
	Specifies whether to create a graph. More...

void	SetDataSet (DataSet *dataset)
	Specifies a data set to run a Fourier transformation on. More...

void	SetDBMultiplier (double multiplier)
	Specifies the multiplier for decibel output. More...

void	SetFrequencyMultiplier (Variant &val)
	Specifies the Frequency Multiplier value. More...

void	SetLineType (int lineType)
	Specifies line selection type. More...

void	SetMax (Variant &val)
	Specifies the maximum X-axis range value. More...

void	SetMin (Variant &val)
	Specifies the minimum X-axis range value. More...

void	SetPeriodicity (int type)
	Specifies the periodicity. More...

void	SetPhase (Variant &val)
	Specifies the phase value. More...

void	SetSeries (Variant &val)
	Specifies the name or index of a line. More...

void	SetType (String &type)
	Specifies the type of output. More...

Detailed Description

FFTParameter class is used to specify a required parameter when running a Fourier transformation for graph data.
The class can be called from Application class.
.

Example of creating the class object:

app.CreateFFTParameter("fft_title")

Member Function Documentation

void FFTParameter::AddDataSet ( DataSet * dataset )

Adds a data set to run a Fourier transformation on.

Parameters

dataset DataSet object

bool FFTParameter::IsValid ( )

Returns True if an object is valid.

Returns: Whether or not the FFTParameter object is valid

void FFTParameter::SetAxisType ( String & mapper )

Specifies the X-axis type (For example, time, steps, angle).

Parameters

type	Name of the axis type

void FFTParameter::SetCreateGraph ( bool createGraph )

Specifies whether to create a graph.

Parameters

createGraph

Whether to create a graph
True=1 : Creates a graph
False=0 : Does not create a graph

createGraph can be omitted. When it is omitted, the value is specified as False (a graph is not created).

void FFTParameter::SetDataSet ( DataSet * dataset )

Specifies a data set to run a Fourier transformation on.

Parameters

dataset DataSet object

void FFTParameter::SetDBMultiplier ( double multiplier )

Specifies the multiplier for decibel output.

Parameters

multiplier

10

20

void FFTParameter::SetFrequencyMultiplier ( Variant & val )

Specifies the Frequency Multiplier value.

Parameters

val	Frequency multiplier value

void FFTParameter::SetLineType ( int lineType )

Specifies line selection type.

Parameters

lineType

Line selection type

True=1 : Specified dataset

False=0 : All datasets

void FFTParameter::SetMax ( Variant & max )

Specifies the maximum X-axis range value.

Parameters

max	Maximum X-axis range value

void FFTParameter::SetMin ( Variant & min )

Specifies the minimum X-axis range value.

Parameters

min	Minimum X-axis range value

void FFTParameter::SetPeriodicity ( int type )

Specifies the periodicity.

Parameters

type	Periodicity type True=1 : None False=0 : 1/2

void FFTParameter::SetPhase ( Variant & val )

Specifies the phase value.

Parameters

val	Phase value

void FFTParameter::SetSeries ( Variant & val )

Specifies the name or index of a line.

Parameters

val	Name or index of a line

void FFTParameter::SetType ( String & type )

Specifies the type of output.

Parameters

type	Output type AmplitudeAndPhase RealAndImaginary Decibel Amplitude SpecifiedPhase

Public Member Functions

Detailed Description

Member Function Documentation