Control

Functions
bool8_t	GenIsControllable (TpDeviceHandle_t hDevice)
	Check whether the generator can be controlled.
bool8_t	GenGetOutputOn (TpDeviceHandle_t hDevice)
	Check whether generator output is on.
bool8_t	GenSetOutputOn (TpDeviceHandle_t hDevice, bool8_t bOutputOn)
	Enable or disable generator output.
void	GenStart (TpDeviceHandle_t hDevice)
	Start generator.
void	GenStop (TpDeviceHandle_t hDevice)
	Stop generator.
bool8_t	GenIsBurstActive (TpDeviceHandle_t hDevice)
	Check whether burst is active.
uint64_t	GenGetBurstCount (TpDeviceHandle_t hDevice)
	Get burst count.
uint64_t	GenGetBurstCountMax (TpDeviceHandle_t hDevice)
	Get maximum burst count.
uint64_t	GenSetBurstCount (TpDeviceHandle_t hDevice, uint64_t qwBurstCount)
	Set burst count.
uint32_t	GenGetModes (TpDeviceHandle_t hDevice)
	Get supported generator modes.
uint32_t	GenGetModesEx (TpDeviceHandle_t hDevice, uint32_t dwSignalType)
	Get supported generator modes by signal type.
uint32_t	GenGetMode (TpDeviceHandle_t hDevice)
	Get generator mode.
uint32_t	GenSetMode (TpDeviceHandle_t hDevice, uint32_t dwMode)
	Set generator mode.
uint32_t	GenGetSignalTypes (TpDeviceHandle_t hDevice)
	Get supported signal types.
uint32_t	GenGetSignalType (TpDeviceHandle_t hDevice)
	Get signal type.
uint32_t	GenSetSignalType (TpDeviceHandle_t hDevice, uint32_t dwSignalType)
	Set signal type.
double	GenGetAmplitudeMax (TpDeviceHandle_t hDevice)
	Get maximum signal amplitude.
double	GenGetAmplitudeMin (TpDeviceHandle_t hDevice)
	Get minimum signal amplitude.
double	GenGetAmplitude (TpDeviceHandle_t hDevice)
	Get signal amplitude.
double	GenSetAmplitude (TpDeviceHandle_t hDevice, double dAmplitude)
	Set signal amplitude.
double	GenVerifyAmplitude (TpDeviceHandle_t hDevice, double dAmplitude)
	Verify signal amplitude.
void	GenGetFrequencyMinMax (TpDeviceHandle_t hDevice, uint32_t dwMode, double *pMin, double *pMax)
	Get minimum and maximum signal/sample frequency by mode.
double	GenGetFrequencyMin (TpDeviceHandle_t hDevice)
	Get minimum signal/sample frequency.
double	GenGetFrequencyMax (TpDeviceHandle_t hDevice)
	Get maximum signal/sample frequency.
double	GenGetFrequency (TpDeviceHandle_t hDevice)
	Get signal/sample frequency.
double	GenSetFrequency (TpDeviceHandle_t hDevice, double dFrequency)
	Set signal/sample frequency.
double	GenVerifyFrequency (TpDeviceHandle_t hDevice, double dFrequency)
	Verify signal/sample frequency.
double	GenVerifyFrequencyEx (TpDeviceHandle_t hDevice, double dFrequency, uint32_t dwMode)
	Verify signal/sample frequency by mode.
double	GenGetOffsetMin (TpDeviceHandle_t hDevice)
	Get minimum signal offset.
double	GenGetOffsetMax (TpDeviceHandle_t hDevice)
	Get maximum signal offset.
double	GenGetOffset (TpDeviceHandle_t hDevice)
	Get signal offset.
double	GenSetOffset (TpDeviceHandle_t hDevice, double dOffset)
	Set signal offset.
double	GenVerifyOffset (TpDeviceHandle_t hDevice, double dOffset)
	Verify signal offset.
double	GenGetPhase (TpDeviceHandle_t hDevice)
	Get signal phase.
double	GenSetPhase (TpDeviceHandle_t hDevice, double dPhase)
	Set signal phase.
double	GenVerifyPhase (TpDeviceHandle_t hDevice, double dPhase)
	Verify signal phase.
double	GenGetSymmetry (TpDeviceHandle_t hDevice)
	Get signal symmetry.
double	GenSetSymmetry (TpDeviceHandle_t hDevice, double dSymmetry)
	Set signal symmetry.
double	GenVerifySymmetry (TpDeviceHandle_t hDevice, double dSymmetry)
	Verify signal symmetry.

Detailed Description

Function Documentation

double GenGetAmplitude

(

TpDeviceHandle_t

hDevice

)

Get signal amplitude.

Parameters

hDevice

A device handle.

Returns

Signal amplitude.

double GenGetAmplitudeMax

(

TpDeviceHandle_t

hDevice

)

Get maximum signal amplitude.

Parameters

hDevice

A device handle.

Returns

Maximum signal amplitude.

double GenGetAmplitudeMin

(

TpDeviceHandle_t

hDevice

)

Get minimum signal amplitude.

Parameters

hDevice

A device handle.

Returns

Minimum signal amplitude.

uint64_t GenGetBurstCount

(

TpDeviceHandle_t

hDevice

)

Get burst count.

Parameters

hDevice

A device handle.

Returns

Burst count.

uint64_t GenGetBurstCountMax

(

TpDeviceHandle_t

hDevice

)

Get maximum burst count.

Parameters

hDevice

A device handle.

Returns

Maximum burst count.

double GenGetFrequency

(

TpDeviceHandle_t

hDevice

)

Get signal/sample frequency.

Parameters

hDevice

A device handle.

Returns

Signal/sample frequency.

double GenGetFrequencyMax

(

TpDeviceHandle_t

hDevice

)

Get maximum signal/sample frequency.

Parameters

hDevice

A device handle.

Returns

Minimum signal/sample frequency.

double GenGetFrequencyMin

(

TpDeviceHandle_t

hDevice

)

Get minimum signal/sample frequency.

Parameters

hDevice

A device handle.

Returns

Minimum signal/sample frequency.

void GenGetFrequencyMinMax	(	TpDeviceHandle_t	hDevice,
		uint32_t	dwMode,
		double *	pMin,
		double *	pMax
	)

Get minimum and maximum signal/sample frequency by mode.

Parameters

hDevice	A device handle.
dwMode	Generator mode, a FM_* value.
pMin
pMax

uint32_t GenGetMode

(

TpDeviceHandle_t

hDevice

)

Get generator mode.

Parameters

hDevice

A device handle.

Returns

Generator mode, a FM_* value.

uint32_t GenGetModes

(

TpDeviceHandle_t

hDevice

)

Get supported generator modes.

Parameters

hDevice

A device handle.

Returns

Supported generator modes, a set of OR-ed FM_* values.

uint32_t GenGetModesEx	(	TpDeviceHandle_t	hDevice,
		uint32_t	dwSignalType
	)

Get supported generator modes by signal type.

Parameters

hDevice	A device handle.
dwSignalType	A ST_* signal type.

Returns

Supported generator modes by signal type, a set of OR-ed FM_* values.

double GenGetOffset

(

TpDeviceHandle_t

hDevice

)

Get signal offset.

Parameters

hDevice

A device handle.

Returns

Signal offset.

double GenGetOffsetMax

(

TpDeviceHandle_t

hDevice

)

Get maximum signal offset.

Parameters

hDevice

A device handle.

Returns

Maximum signal offset.

double GenGetOffsetMin

(

TpDeviceHandle_t

hDevice

)

Get minimum signal offset.

Parameters

hDevice

A device handle.

Returns

Minimum signal offset.

bool8_t GenGetOutputOn

(

TpDeviceHandle_t

hDevice

)

Check whether generator output is on.

Parameters

hDevice

A device handle.

Returns

BOOL8_TRUE if output is on, BOOL8_FALSE if output is off.

double GenGetPhase

(

TpDeviceHandle_t

hDevice

)

Get signal phase.

Parameters

hDevice

A device handle.

Returns

Signal phase, 0..1.

uint32_t GenGetSignalType

(

TpDeviceHandle_t

hDevice

)

Get signal type.

Parameters

hDevice

A device handle.

Returns

Signal type, a ST_* value.

uint32_t GenGetSignalTypes

(

TpDeviceHandle_t

hDevice

)

Get supported signal types.

Parameters

hDevice

A device handle.

Returns

Supported signal types, a set of ST_* values.

double GenGetSymmetry

(

TpDeviceHandle_t

hDevice

)

Get signal symmetry.

Parameters

hDevice

A device handle.

Returns

Signal symmetry, 0..1.

bool8_t GenIsBurstActive

(

TpDeviceHandle_t

hDevice

)

Check whether burst is active.

Parameters

hDevice

A device handle.

Returns

BOOL8_TRUE if active BOOL8_FALSE otherwise.

bool8_t GenIsControllable

(

TpDeviceHandle_t

hDevice

)

Check whether the generator can be controlled.

Parameters

hDevice

A device handle.

Returns

BOOL8_TRUE if controllable, BOOL8_FALSE otherwise.

double GenSetAmplitude	(	TpDeviceHandle_t	hDevice,
		double	dAmplitude
	)

Set signal amplitude.

Parameters

hDevice	A device handle.
dAmplitude	Signal amplitude.

Returns

Signal amplitude.

uint64_t GenSetBurstCount	(	TpDeviceHandle_t	hDevice,
		uint64_t	qwBurstCount
	)

Set burst count.

Parameters

hDevice	A device handle.
qwBurstCount	Burst count, 0..GenGetBurstCountMax().

Returns

Burst count.

double GenSetFrequency	(	TpDeviceHandle_t	hDevice,
		double	dFrequency
	)

Set signal/sample frequency.

Parameters

hDevice	A device handle.
dFrequency	Signal/sample frequency.

Returns

Signal/sample frequency.

uint32_t GenSetMode	(	TpDeviceHandle_t	hDevice,
		uint32_t	dwMode
	)

Set generator mode.

Parameters

hDevice	A device handle.
dwMode	Generator mode, a FM_* value.

Returns

Generator mode, a FM_* value.

double GenSetOffset	(	TpDeviceHandle_t	hDevice,
		double	dOffset
	)

Set signal offset.

Parameters

hDevice	A device handle.
dOffset	Signal offset.

Returns

Signal offset.

bool8_t GenSetOutputOn	(	TpDeviceHandle_t	hDevice,
		bool8_t	bOutputOn
	)

Enable or disable generator output.

Parameters

hDevice	A device handle.
bOutputOn	?.

Returns

BOOL8_TRUE if output is on, BOOL8_FALSE if output is off.

double GenSetPhase	(	TpDeviceHandle_t	hDevice,
		double	dPhase
	)

Set signal phase.

Parameters

hDevice	A device handle.
dPhase	Signal phase, 0..1.

Returns

Signal phase, 0..1.

uint32_t GenSetSignalType	(	TpDeviceHandle_t	hDevice,
		uint32_t	dwSignalType
	)

Set signal type.

Parameters

hDevice	A device handle.
dwSignalType	Signal type, a ST_* value.

Returns

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

Signal symmetry, 0..1.

void GenStart

(

TpDeviceHandle_t

hDevice

)

Start generator.

Parameters

hDevice

A device handle.

void GenStop

(

TpDeviceHandle_t

hDevice

)

Stop generator.

Parameters

hDevice

A device handle.

double GenVerifyAmplitude	(	TpDeviceHandle_t	hDevice,
		double	dAmplitude
	)

Verify signal amplitude.

Parameters

hDevice	A device handle.
dAmplitude	Signal amplitude.

Returns

Signal amplitude.

double GenVerifyFrequency	(	TpDeviceHandle_t	hDevice,
		double	dFrequency
	)

Verify signal/sample frequency.

Parameters

hDevice	A device handle.
dFrequency	Signal/sample frequency.

Returns

Signal/sample frequency.

double GenVerifyFrequencyEx	(	TpDeviceHandle_t	hDevice,
		double	dFrequency,
		uint32_t	dwMode
	)

Verify signal/sample frequency by mode.

Parameters

hDevice	A device handle.
dFrequency	Signal/sample frequency.
dwMode	Generator mode, a FM_* value.

Returns

Signal/sample frequency.

double GenVerifyOffset	(	TpDeviceHandle_t	hDevice,
		double	dOffset
	)

Verify signal offset.

Parameters

hDevice	A device handle.
dOffset	Signal offset.

Returns

Signal offset.

double GenVerifyPhase	(	TpDeviceHandle_t	hDevice,
		double	dPhase
	)

Verify signal phase.

Parameters

hDevice	A device handle.
dPhase	Signal phase, 0..1.

Returns

Signal phase, 0..1.

double GenVerifySymmetry	(	TpDeviceHandle_t	hDevice,
		double	dSymmetry
	)

Verify signal symmetry.

Parameters

hDevice	A device handle.
dSymmetry	Signal symmetry, 0..1.

Returns

Signal symmetry, 0..1.