libtiepie-hw  1.1.3

Functions for controlling the generator mode. More...

Collaboration diagram for Mode:

Modules

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

Functions

TIEPIE_HW_API uint64_t tiepie_hw_generator_get_modes (tiepie_hw_handle handle)
 Get the supported generator modes for the current signal type and frequency mode of a specified generator. More...
 
TIEPIE_HW_API uint64_t tiepie_hw_generator_get_modes_native (tiepie_hw_handle handle)
 Get all supported generator modes of a specified generator, regardless of the signal type and frequency mode. More...
 
TIEPIE_HW_API uint64_t tiepie_hw_generator_get_mode (tiepie_hw_handle handle)
 Get the current generator mode of a specified generator. More...
 
TIEPIE_HW_API uint64_t tiepie_hw_generator_set_mode (tiepie_hw_handle handle, uint64_t value)
 Set the generator mode of a specified generator. More...
 

Detailed 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 tiepie_hw_generator_get_modes() to find out which generator modes are supported for the current settings. Use tiepie_hw_generator_get_modes_native() to find out which generator modes are supported, regardless of the current settings.

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

Function Documentation

◆ tiepie_hw_generator_get_modes()

TIEPIE_HW_API uint64_t tiepie_hw_generator_get_modes ( tiepie_hw_handle  handle)

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

Parameters
[in]handleA device handle identifying the generator.
Returns
The supported generator modes, a set of OR-ed TIEPIE_HW_GM_* values or TIEPIE_HW_GMM_NONE when unsuccessful.
Status values
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid generator handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_generator_get_modes_native
tiepie_hw_generator_get_mode
tiepie_hw_generator_set_mode
Since
1.0

◆ tiepie_hw_generator_get_modes_native()

TIEPIE_HW_API uint64_t tiepie_hw_generator_get_modes_native ( tiepie_hw_handle  handle)

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

Parameters
[in]handleA device handle identifying the generator.
Returns
The supported generator modes, a set of OR-ed TIEPIE_HW_GM_* values or TIEPIE_HW_GMM_NONE when unsuccessful.
Status values
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid generator handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_generator_get_modes
tiepie_hw_generator_get_mode
tiepie_hw_generator_set_mode
Since
1.0

◆ tiepie_hw_generator_get_mode()

TIEPIE_HW_API uint64_t tiepie_hw_generator_get_mode ( tiepie_hw_handle  handle)

Get the current generator mode of a specified generator.

Parameters
[in]handleA device handle identifying the generator.
Returns
The currently set generator mode, a TIEPIE_HW_GM_* value, or TIEPIE_HW_GMM_NONE when unsuccessful.
Status values
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid generator handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_generator_get_modes
tiepie_hw_generator_get_modes_native
tiepie_hw_generator_set_mode
Since
1.0

◆ tiepie_hw_generator_set_mode()

TIEPIE_HW_API uint64_t tiepie_hw_generator_set_mode ( tiepie_hw_handle  handle,
uint64_t  value 
)

Set the generator mode of a specified generator.

Parameters
[in]handleA device handle identifying the generator.
[in]valueThe requested generator mode, a TIEPIE_HW_GM_* value.
Returns
The actually set generator mode, a TIEPIE_HW_GM_* value, or TIEPIE_HW_GMM_NONE when unsuccessful.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The generator does not support setting the generator mode.
TIEPIE_HW_STATUS_INVALID_VALUE The requested generator mode is invalid.
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid generator handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
Remarks
The new value becomes active after a call to tiepie_hw_generator_start().
See also
tiepie_hw_generator_get_modes
tiepie_hw_generator_get_modes_native
tiepie_hw_generator_get_mode
Since
1.0