Control
[Generator]

Functions
bool8_t	GenGetOutputOn (TpDeviceHandle_t hDevice)
bool8_t	GenSetOutputOn (TpDeviceHandle_t hDevice, bool8_t bOutputOn)
void	GenStart (TpDeviceHandle_t hDevice, int64_t iBurstCount)
void	GenStop (TpDeviceHandle_t hDevice)
uint32_t	GenGetMode (TpDeviceHandle_t hDevice)
uint32_t	GenSetMode (TpDeviceHandle_t hDevice, uint32_t dwMode)
uint32_t	GenGetSignalTypes (TpDeviceHandle_t hDevice)
uint32_t	GenGetSignalType (TpDeviceHandle_t hDevice)
uint32_t	GenSetSignalType (TpDeviceHandle_t hDevice, uint32_t dwSignalType)
double	GenGetAmplitudeMax (TpDeviceHandle_t hDevice)
double	GenGetAmplitude (TpDeviceHandle_t hDevice)
double	GenSetAmplitude (TpDeviceHandle_t hDevice, double dAmplitude)
double	GenGetFrequencyMin (TpDeviceHandle_t hDevice)
double	GenGetFrequencyMax (TpDeviceHandle_t hDevice)
double	GenGetFrequency (TpDeviceHandle_t hDevice)
double	GenSetFrequency (TpDeviceHandle_t hDevice, double dFrequency)
double	GenGetOffsetMin (TpDeviceHandle_t hDevice)
double	GenGetOffsetMax (TpDeviceHandle_t hDevice)
double	GenGetOffset (TpDeviceHandle_t hDevice)
double	GenSetOffset (TpDeviceHandle_t hDevice, double dOffset)
double	GenGetSymmetry (TpDeviceHandle_t hDevice)
double	GenSetSymmetry (TpDeviceHandle_t hDevice, double dSymmetry)

---

Function Documentation

double GenGetAmplitude

(

TpDeviceHandle_t

hDevice

)

Get current signal amplitude

Parameters:

hDevice

a device handle

Returns:

generator amplitude in Volts

double GenGetAmplitudeMax

(

TpDeviceHandle_t

hDevice

)

Get maximum signal amplitude

Parameters:

hDevice

a device handle

Returns:

maximum generator amplitude in Volts

double GenGetFrequency

(

TpDeviceHandle_t

hDevice

)

Get current signal frequency

Parameters:

hDevice

a device handle

Returns:

current signal frequency in Hz

double GenGetFrequencyMax

(

TpDeviceHandle_t

hDevice

)

Get maximum signal frequency

Parameters:

hDevice

a device handle

Returns:

minimum signal frequency in Hz

double GenGetFrequencyMin

(

TpDeviceHandle_t

hDevice

)

Get minimum signal frequency

Parameters:

hDevice

a device handle

Returns:

minimum signal frequency in Hz

uint32_t GenGetMode

(

TpDeviceHandle_t

hDevice

)

Get generator mode

See also:

gm

Parameters:

hDevice

a device handle

Returns:

current generator mode, a FM_* value

double GenGetOffset

(

TpDeviceHandle_t

hDevice

)

Get current signal offset

Parameters:

hDevice

a device handle

Returns:

current generator offset in Volts

double GenGetOffsetMax

(

TpDeviceHandle_t

hDevice

)

Get maximum signal offset

Parameters:

hDevice

a device handle

Returns:

maximum generator offset in Volts

double GenGetOffsetMin

(

TpDeviceHandle_t

hDevice

)

Get minimum signal offset

Parameters:

hDevice

a device handle

Returns:

minimum generator offset in Volts

bool8_t GenGetOutputOn

(

TpDeviceHandle_t

hDevice

)

Check if generator output is on

Parameters:

hDevice

a device handle

Returns:

1 if output is on, 0 if output is off.

uint32_t GenGetSignalType

(

TpDeviceHandle_t

hDevice

)

Get the currently selected signal type.

See also:

Signal types

Parameters:

hDevice

a device handle

Returns:

the currently selected signal type, a ST_* value

uint32_t GenGetSignalTypes

(

TpDeviceHandle_t

hDevice

)

Get available signal types.

See also:

Signal types

Parameters:

hDevice

a device handle

Returns:

available signal types, set of ST_* values

double GenGetSymmetry

(

TpDeviceHandle_t

hDevice

)

Get current signal symmetry

Parameters:

hDevice

a device handle

Returns:

current signal symmetry 0...1

double GenSetAmplitude	(	TpDeviceHandle_t	hDevice,
		double	dAmplitude
	)

Set signal amplitude

Parameters:

	hDevice	a device handle
	dAmplitude	generator amplitude in Volts

Returns:

generator amplitude in Volts

double GenSetFrequency	(	TpDeviceHandle_t	hDevice,
		double	dFrequency
	)

Set signal frequency

Parameters:

	hDevice	a device handle
	dFrequency	signal frequency in Hz

Returns:

current signal frequency in Hz

uint32_t GenSetMode	(	TpDeviceHandle_t	hDevice,
		uint32_t	dwMode
	)

Set generator mode

Note:

Only FM_DDS is supported

See also:

gm

Parameters:

	hDevice	a device handle
	dwMode	generator mode, a FM_* value

Returns:

current generator mode, a FM_* value

double GenSetOffset	(	TpDeviceHandle_t	hDevice,
		double	dOffset
	)

Set signal offset

Parameters:

	hDevice	a device handle
	dOffset	generator offset in Volts

Returns:

current generator offset in Volts

bool8_t GenSetOutputOn	(	TpDeviceHandle_t	hDevice,
		bool8_t	bOutputOn
	)

Enable or disable generator output

Parameters:

	hDevice	a device handle
	bOutputOn	?

Returns:

1 if output is on, 0 if output is off.

uint32_t GenSetSignalType	(	TpDeviceHandle_t	hDevice,
		uint32_t	dwSignalType
	)

Sets the signal type of the generator.

See also:

Signal types

Parameters:

	hDevice	a device handle
	dwSignalType	signal type, a ST_* value

Returns:

the currently selected signal type, a ST_* value

double GenSetSymmetry	(	TpDeviceHandle_t	hDevice,
		double	dSymmetry
	)

Set signal symmetry

Parameters:

	hDevice	a device handle
	dSymmetry	signal symmetry 0...1

Returns:

current signal symmetry 0...1

void GenStart	(	TpDeviceHandle_t	hDevice,
		int64_t	iBurstCount
	)

Start generator

Parameters:

	hDevice	a device handle
	iBurstCount	number of periods before stop, -1 means continously mode

void GenStop

(

TpDeviceHandle_t

hDevice

)

Stop generator

Parameters:

hDevice

a device handle