LibTiePie  0.9.15
Library for interfacing TiePie engineering instruments

Description

Functions for controlling the generator mode.

A generator can operate in various different modes: Continuous, Burst or Gated. In Continuous mode, the generator continuously generates the selected signal, until the generator is stopped. In Burst mode, the generator generates a specified number of periods of the selected signal or a specified number of samples from the waveform buffer and then stops automatically. In Gated mode, the generator generates (a part of) the selected signal based on a the precence of an external signal on a selected external input of the generator.

Which generator modes are available, depends on the selected signal type and frequency mode. Use GenGetModes() to find out which generator modes are supported for the current settings. Use GenGetModesNative() to find out which generator modes are supported, regardless of the current settings.

By default generator mode is set to continuous (GM_CONTINUOUS).

Modules

 Continuous
 Information on continuous mode.
 
 Burst
 Functions for controlling burst mode.
 
 Gated
 Information on gated mode.
 

Functions

uint64_t GenGetModes (LibTiePieHandle_t hDevice)
 Get the supported generator modes for the current signal type and frequency mode of a specified generator. More...
 
uint64_t GenGetModesNative (LibTiePieHandle_t hDevice)
 Get all supported generator modes of a specified generator, regardless of the signal type and frequency mode. More...
 
uint64_t GenGetMode (LibTiePieHandle_t hDevice)
 Get the current generator mode of a specified generator. More...
 
uint64_t GenSetMode (LibTiePieHandle_t hDevice, uint64_t qwGeneratorMode)
 Set the generator mode of a specified generator. More...
 

Function Documentation

uint64_t GenGetModes ( LibTiePieHandle_t  hDevice)

Get the supported generator modes for the current signal type and frequency mode of a specified generator.

Parameters
[in]hDeviceA device handle identifying the generator.
Returns
The supported generator modes, a set of OR-ed GM_* values or GMM_NONE when unsuccessful.
Status values
INVALID_HANDLE The handle is not a valid generator handle.
OBJECT_GONE The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
GenGetModesNative
GenGetMode
GenSetMode
Since
0.5
uint64_t GenGetModesNative ( LibTiePieHandle_t  hDevice)

Get all supported generator modes of a specified generator, regardless of the signal type and frequency mode.

Parameters
[in]hDeviceA device handle identifying the generator.
Returns
The supported generator modes, a set of OR-ed GM_* values or GMM_NONE when unsuccessful.
Status values
INVALID_HANDLE The handle is not a valid generator handle.
OBJECT_GONE The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
GenGetModes
GenGetMode
GenSetMode
Since
0.5
uint64_t GenGetMode ( LibTiePieHandle_t  hDevice)

Get the current generator mode of a specified generator.

Parameters
[in]hDeviceA device handle identifying the generator.
Returns
The currently set generator mode, a GM_* value, or GMM_NONE when unsuccessful.
Status values
INVALID_HANDLE The handle is not a valid generator handle.
OBJECT_GONE The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
GenGetModes
GenGetModesNative
GenSetMode
Since
0.5
uint64_t GenSetMode ( LibTiePieHandle_t  hDevice,
uint64_t  qwGeneratorMode 
)

Set the generator mode of a specified generator.

Parameters
[in]hDeviceA device handle identifying the generator.
[in]qwGeneratorModeThe requested generator mode, a GM_* value.
Returns
The actually set generator mode, a GM_* value, or GMM_NONE when unsuccessful.
Status values
NOT_SUPPORTED The generator does not support setting the generator mode.
INVALID_VALUE The requested generator mode is invalid.
INVALID_HANDLE The handle is not a valid generator handle.
OBJECT_GONE The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
Remarks
The new value becomes active after a call to GenStart().
See also
GenGetModes
GenGetModesNative
GenGetMode
Since
0.5