FunctionObjectFactory Class Reference

FunctionObjectFactory class is used to create a FunctionObject such as constant, sinusoidal or exponential functions.
The class can be created from Application class.
. More...

Public Member Functions
FunctionObject *	Composite ()
	Creates a FunctionObject object for a composite function. More...
FunctionObject *	Constant (Variant &amp)
	Creates a FunctionObject for an exponential function. More...
FunctionObject *	Exp (Variant &amp, Variant &initial, Variant &time)
	Creates a FunctionObject object for a constant value. More...
FunctionObject *	Harmonic (Variant &amp, Variant &freq, Variant &phase)
	Creates a harmonics FunctionObject object. More...
bool	IsSingleton ()
	Since this is an internal function, it is not officially supported. More...
bool	IsValid ()
	Returns True if an object is valid. More...
FunctionObject *	Pulse (Variant &amp, Variant &freq, Variant &delay, Variant &start, Variant &end, Variant &width)
	Creates a FunctionObject object for a pulse function. More...
FunctionObject *	Sin (Variant &amp, Variant &freq, Variant &phase, bool isRMS=false)
	Creates a FunctionObject object for a sinusoidal function. More...
FunctionObject *	Step (Variant &amp, Variant &freq, Variant &phase)
	Creates a FunctionObject object for a step (rectangular wave) function. More...

Detailed Description

FunctionObjectFactory class is used to create a FunctionObject such as constant, sinusoidal or exponential functions.
The class can be created from Application class.
.

Example of creating the class object:

app.FunctionFactory()

Member Function Documentation

FunctionObject * FunctionObjectFactory::Composite

(

)

Creates a FunctionObject object for a composite function.

Returns

FunctionObject object

FunctionObject * FunctionObjectFactory::Constant

(

Variant &

amp

)

Creates a FunctionObject for an exponential function.

Parameters

amp

Amplitude

Returns

FunctionObject object

FunctionObject * FunctionObjectFactory::Exp	(	Variant &	amp,
		Variant &	initial,
		Variant &	time
	)

Creates a FunctionObject object for a constant value.

Parameters

amp	Amplitude
initial	Initial value
time	Time constant

Returns

FunctionObject object

FunctionObject * FunctionObjectFactory::Harmonic	(	Variant &	amp,
		Variant &	freq,
		Variant &	phase
	)

Creates a harmonics FunctionObject object.

Parameters

amp	Amplitude
freq	Frequency
phase	Phase

Returns

FunctionObject object

bool FunctionObjectFactory::IsSingleton

(

)

Since this is an internal function, it is not officially supported.

Deprecated:

bool FunctionObjectFactory::IsValid

(

)

Returns True if an object is valid.

Returns

Whether or not the FunctionObjectFactory objects in the list are valid

FunctionObject * FunctionObjectFactory::Pulse	(	Variant &	amp,
		Variant &	freq,
		Variant &	delay,
		Variant &	start,
		Variant &	end,
		Variant &	width
	)

Creates a FunctionObject object for a pulse function.

Parameters

amp	Amplitude
freq	Frequency
delay	Delay
start	Rising
end	Falling
width	Pulse interval

Returns

FunctionObject object

FunctionObject * FunctionObjectFactory::Sin	(	Variant &	amp,
		Variant &	freq,
		Variant &	phase,
		bool	isRMS = false
	)

Creates a FunctionObject object for a sinusoidal function.

Parameters

amp	Amplitude
freq	Frequency
phase	Phase
isRMS	Flag for whether Amplitude or RMS is used

Returns

FunctionObject object

FunctionObject * FunctionObjectFactory::Step	(	Variant &	amp,
		Variant &	freq,
		Variant &	phase
	)

Creates a FunctionObject object for a step (rectangular wave) function.

Parameters

amp	Amplitude
freq	Frequency
phase	Phase

Returns

FunctionObject object