Functions for controlling the offset of a generator. More...
Collaboration diagram for Offset:
Functions | |
| TIEPIE_HW_API tiepie_hw_bool | tiepie_hw_generator_has_offset (tiepie_hw_handle handle) |
| Check whether the current signal type of a specified generator supports controlling the signal offset. More... | |
| TIEPIE_HW_API double | tiepie_hw_generator_get_offset_min (tiepie_hw_handle handle) |
| Get the minimum offset for the current signal type, of a specified generator. More... | |
| TIEPIE_HW_API double | tiepie_hw_generator_get_offset_max (tiepie_hw_handle handle) |
| Get the maximum offset for the current signal type, of a specified generator. More... | |
| TIEPIE_HW_API double | tiepie_hw_generator_get_offset (tiepie_hw_handle handle) |
| Get the current signal offset of a specified generator. More... | |
| TIEPIE_HW_API double | tiepie_hw_generator_set_offset (tiepie_hw_handle handle, double value) |
| Set the signal offset of a specified generator. More... | |
Detailed Description
Functions for controlling the offset of a generator.
The offset of a generator can be set between a minimum and a maximum value. Use tiepie_hw_generator_get_offset_min() and tiepie_hw_generator_get_offset_max() to get the offset limits.
Amplitude and Offset combined cannot exceed the minimum and maximum output value of the generator. Setting a larger offset will clip the offset to a valid value.
When the generator ouput is switched on but signal generation is stopped, the generator output will be at the currently set offset level.
By default the offset is set to: 0 V.
Function Documentation
◆ tiepie_hw_generator_has_offset()
| TIEPIE_HW_API tiepie_hw_bool tiepie_hw_generator_has_offset | ( | tiepie_hw_handle | handle | ) |
Check whether the current signal type of a specified generator supports controlling the signal offset.
- Parameters
-
[in] handle A device handle identifying the generator.
- Returns
- TIEPIE_HW_BOOL_TRUE if supported, TIEPIE_HW_BOOL_FALSE if not.
- 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_offset_min
- tiepie_hw_generator_get_offset_max
- tiepie_hw_generator_get_offset
- tiepie_hw_generator_set_offset
- Since
- 1.0
◆ tiepie_hw_generator_get_offset_min()
| TIEPIE_HW_API double tiepie_hw_generator_get_offset_min | ( | tiepie_hw_handle | handle | ) |
Get the minimum offset for the current signal type, of a specified generator.
- Parameters
-
[in] handle A device handle identifying the generator.
- Returns
- The minimum signal offset in Volt.
- Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The requested signal type does not support signal offset. 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_offset_max
- tiepie_hw_generator_get_offset
- tiepie_hw_generator_set_offset
- Since
- 1.0
◆ tiepie_hw_generator_get_offset_max()
| TIEPIE_HW_API double tiepie_hw_generator_get_offset_max | ( | tiepie_hw_handle | handle | ) |
Get the maximum offset for the current signal type, of a specified generator.
- Parameters
-
[in] handle A device handle identifying the generator.
- Returns
- The maximum signal offset in Volt.
- Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The requested signal type does not support signal offset. 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_offset_min
- tiepie_hw_generator_get_offset
- tiepie_hw_generator_set_offset
- Since
- 1.0
◆ tiepie_hw_generator_get_offset()
| TIEPIE_HW_API double tiepie_hw_generator_get_offset | ( | tiepie_hw_handle | handle | ) |
Get the current signal offset of a specified generator.
- Parameters
-
[in] handle A device handle identifying the generator.
- Returns
- The currently set signal offset in Volt.
- Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The requested signal type does not support signal offset. 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_offset_min
- tiepie_hw_generator_get_offset_max
- tiepie_hw_generator_set_offset
- Since
- 1.0
◆ tiepie_hw_generator_set_offset()
| TIEPIE_HW_API double tiepie_hw_generator_set_offset | ( | tiepie_hw_handle | handle, |
| double | value | ||
| ) |
Set the signal offset of a specified generator.
- Parameters
-
[in] handle A device handle identifying the generator. [in] value The requested signal offset in Volt.
- Returns
- The actually set signal offset in Volt.
- Status values
TIEPIE_HW_STATUS_VALUE_CLIPPED The requested offset is outside the valid range and clipped to the closest limit. TIEPIE_HW_STATUS_VALUE_MODIFIED The requested offset is within the valid range but not available. The closest valid value is set. TIEPIE_HW_STATUS_NOT_SUPPORTED The current signal type does not support signal offset. TIEPIE_HW_STATUS_NOT_CONTROLLABLE 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_offset_min
- tiepie_hw_generator_get_offset_max
- tiepie_hw_generator_get_offset
- Since
- 1.0
