Functions for controlling the signal edge times of a generator. More...
Collaboration diagram for Pulse edge time:
Functions | |
| TIEPIE_HW_API tiepie_hw_bool | tiepie_hw_generator_has_edge_time (tiepie_hw_handle handle) |
| Check whether the current signal type of a specified generator supports controlling the edge times. More... | |
| TIEPIE_HW_API double | tiepie_hw_generator_get_leading_edge_time_min (tiepie_hw_handle handle) |
| Get the minimum leading edge time with the current pulse width and signal frequency, of a specified generator. More... | |
| TIEPIE_HW_API double | tiepie_hw_generator_get_leading_edge_time_max (tiepie_hw_handle handle) |
| Get the maximum leading edge time with the current pulse width and signal frequency, of a specified generator. More... | |
| TIEPIE_HW_API double | tiepie_hw_generator_get_leading_edge_time (tiepie_hw_handle handle) |
| Get the current leading edge time with the current pulse width and signal frequency, of a specified generator. More... | |
| TIEPIE_HW_API double | tiepie_hw_generator_set_leading_edge_time (tiepie_hw_handle handle, double leading_edge_time) |
| Set the leading edge time, of a specified generator. More... | |
| TIEPIE_HW_API double | tiepie_hw_generator_get_trailing_edge_time_min (tiepie_hw_handle handle) |
| Get the minimum trailing edge time with the current pulse width and signal frequency, of a specified generator. More... | |
| TIEPIE_HW_API double | tiepie_hw_generator_get_trailing_edge_time_max (tiepie_hw_handle handle) |
| Get the maximum trailing edge time with the current pulse width and signal frequency, of a specified generator. More... | |
| TIEPIE_HW_API double | tiepie_hw_generator_get_trailing_edge_time (tiepie_hw_handle handle) |
| Get the current trailing edge time with the current pulse width and signal frequency, of a specified generator. More... | |
| TIEPIE_HW_API double | tiepie_hw_generator_set_trailing_edge_time (tiepie_hw_handle handle, double value) |
| Set the trailing edge time, of a specified generator. More... | |
Detailed Description
Functions for controlling the signal edge times of a generator.
A pulse signal has a leading edge and a trailing edge. The duration of these edges can be set individually between a minimum and a maximum value.
For a positive pulse, the leading edge time is defined as the time it takes for the signal to go from 10% of the pulse height to 90% of the pulse height. And the trailing edge time is defined as the time it takes for the signal to go from 90% of the pulse height to 10% of the pulse height.
For a negative pulse, the leading edge time is defined as the time it takes for the signal to go from 90% of the pulse height to 10% of the pulse height. And the trailing edge time is defined as the time it takes for the signal to go from 10% of the pulse height to 90% of the pulse height.
Controlling the edge times is not available on all instruments and only available for signal type Pulse. Use tiepie_hw_generator_has_edge_time() to check whether your instrument and the current signal type of a specified generator support controlling the edge times. Use tiepie_hw_generator_get_leading_edge_time_min(), tiepie_hw_generator_get_leading_edge_time_max(), tiepie_hw_generator_get_trailing_edge_time_min() and tiepie_hw_generator_get_trailing_edge_time_max() to get the edge time limits. The minimum and maximum edge times depend on the currently set pulse width and signal frequency (period).
The edge times are defined in seconds.
The leading edge time and trailing edge time can be affected by changing the signal frequency or pulse width.
By default the edge times are set to: 8 ns.
Function Documentation
◆ tiepie_hw_generator_has_edge_time()
| TIEPIE_HW_API tiepie_hw_bool tiepie_hw_generator_has_edge_time | ( | tiepie_hw_handle | handle | ) |
Check whether the current signal type of a specified generator supports controlling the edge times.
- 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_leading_edge_time_min
- tiepie_hw_generator_get_leading_edge_time_max
- tiepie_hw_generator_get_leading_edge_time
- tiepie_hw_generator_set_leading_edge_time
- tiepie_hw_generator_get_trailing_edge_time_min
- tiepie_hw_generator_get_trailing_edge_time_max
- tiepie_hw_generator_get_trailing_edge_time
- tiepie_hw_generator_set_trailing_edge_time
- Since
- 1.0
◆ tiepie_hw_generator_get_leading_edge_time_min()
| TIEPIE_HW_API double tiepie_hw_generator_get_leading_edge_time_min | ( | tiepie_hw_handle | handle | ) |
Get the minimum leading edge time with the current pulse width and signal frequency, of a specified generator.
- Parameters
-
[in] handle A device handle identifying the generator.
- Returns
- The minimum leading edge time in seconds.
- Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The generator does not support edge times for the current signal type. 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_has_edge_time
- tiepie_hw_generator_get_leading_edge_time_max
- tiepie_hw_generator_get_leading_edge_time
- tiepie_hw_generator_set_leading_edge_time
- tiepie_hw_generator_get_trailing_edge_time_min
- tiepie_hw_generator_get_trailing_edge_time_max
- tiepie_hw_generator_get_trailing_edge_time
- tiepie_hw_generator_set_trailing_edge_time
- Since
- 1.0
◆ tiepie_hw_generator_get_leading_edge_time_max()
| TIEPIE_HW_API double tiepie_hw_generator_get_leading_edge_time_max | ( | tiepie_hw_handle | handle | ) |
Get the maximum leading edge time with the current pulse width and signal frequency, of a specified generator.
- Parameters
-
[in] handle A device handle identifying the generator.
- Returns
- The maximum leading edge time in seconds.
- Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The generator does not support edge times for the current signal type. 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_has_edge_time
- tiepie_hw_generator_get_leading_edge_time_min
- tiepie_hw_generator_get_leading_edge_time
- tiepie_hw_generator_set_leading_edge_time
- tiepie_hw_generator_get_trailing_edge_time_min
- tiepie_hw_generator_get_trailing_edge_time_max
- tiepie_hw_generator_get_trailing_edge_time
- tiepie_hw_generator_set_trailing_edge_time
- Since
- 1.0
◆ tiepie_hw_generator_get_leading_edge_time()
| TIEPIE_HW_API double tiepie_hw_generator_get_leading_edge_time | ( | tiepie_hw_handle | handle | ) |
Get the current leading edge time with the current pulse width and signal frequency, of a specified generator.
- Parameters
-
[in] handle A device handle identifying the generator.
- Returns
- The currently set leading edge time in seconds.
- Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The generator does not support edge times for the current signal type. 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_has_edge_time
- tiepie_hw_generator_get_leading_edge_time_min
- tiepie_hw_generator_get_leading_edge_time_max
- tiepie_hw_generator_set_leading_edge_time
- tiepie_hw_generator_get_trailing_edge_time_min
- tiepie_hw_generator_get_trailing_edge_time_max
- tiepie_hw_generator_get_trailing_edge_time
- tiepie_hw_generator_set_trailing_edge_time
- Since
- 1.0
◆ tiepie_hw_generator_set_leading_edge_time()
| TIEPIE_HW_API double tiepie_hw_generator_set_leading_edge_time | ( | tiepie_hw_handle | handle, |
| double | leading_edge_time | ||
| ) |
Set the leading edge time, of a specified generator.
- Parameters
-
[in] handle A device handle identifying the generator. [in] leading_edge_time The requested leading edge time in seconds.
- Returns
- The actually set leading edge time in seconds.
- Remarks
- When the generator is active, changing the leading edge time will shortly interrupt the output signal.
- Status values
TIEPIE_HW_STATUS_VALUE_CLIPPED The requested edge time is outside the valid range and clipped to the closest limit. TIEPIE_HW_STATUS_VALUE_MODIFIED The requested edge time is within the valid range but not available. The closest valid value is set. TIEPIE_HW_STATUS_NOT_SUPPORTED The generator does not support edge times for the current signal type. 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_has_edge_time
- tiepie_hw_generator_get_leading_edge_time_min
- tiepie_hw_generator_get_leading_edge_time_max
- tiepie_hw_generator_get_leading_edge_time
- tiepie_hw_generator_get_trailing_edge_time_min
- tiepie_hw_generator_get_trailing_edge_time_max
- tiepie_hw_generator_get_trailing_edge_time
- tiepie_hw_generator_set_trailing_edge_time
- Since
- 1.0
◆ tiepie_hw_generator_get_trailing_edge_time_min()
| TIEPIE_HW_API double tiepie_hw_generator_get_trailing_edge_time_min | ( | tiepie_hw_handle | handle | ) |
Get the minimum trailing edge time with the current pulse width and signal frequency, of a specified generator.
- Parameters
-
[in] handle A device handle identifying the generator.
- Returns
- The minimum trailing edge time in seconds.
- Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The generator does not support edge times for the current signal type. 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_has_edge_time
- tiepie_hw_generator_get_leading_edge_time_min
- tiepie_hw_generator_get_leading_edge_time_max
- tiepie_hw_generator_get_leading_edge_time
- tiepie_hw_generator_set_leading_edge_time
- tiepie_hw_generator_get_trailing_edge_time_max
- tiepie_hw_generator_get_trailing_edge_time
- tiepie_hw_generator_set_trailing_edge_time
- Since
- 1.0
◆ tiepie_hw_generator_get_trailing_edge_time_max()
| TIEPIE_HW_API double tiepie_hw_generator_get_trailing_edge_time_max | ( | tiepie_hw_handle | handle | ) |
Get the maximum trailing edge time with the current pulse width and signal frequency, of a specified generator.
- Parameters
-
[in] handle A device handle identifying the generator.
- Returns
- The maximum trailing edge time in seconds.
- Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The generator does not support edge times for the current signal type. 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_has_edge_time
- tiepie_hw_generator_get_leading_edge_time_min
- tiepie_hw_generator_get_leading_edge_time_max
- tiepie_hw_generator_get_leading_edge_time
- tiepie_hw_generator_set_leading_edge_time
- tiepie_hw_generator_get_trailing_edge_time_min
- tiepie_hw_generator_get_trailing_edge_time
- tiepie_hw_generator_set_trailing_edge_time
- Since
- 1.0
◆ tiepie_hw_generator_get_trailing_edge_time()
| TIEPIE_HW_API double tiepie_hw_generator_get_trailing_edge_time | ( | tiepie_hw_handle | handle | ) |
Get the current trailing edge time with the current pulse width and signal frequency, of a specified generator.
- Parameters
-
[in] handle A device handle identifying the generator.
- Returns
- The currently set trailing edge time in seconds.
- Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The generator does not support edge times for the current signal type. 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_has_edge_time
- tiepie_hw_generator_get_leading_edge_time_min
- tiepie_hw_generator_get_leading_edge_time_max
- tiepie_hw_generator_get_leading_edge_time
- tiepie_hw_generator_set_leading_edge_time
- tiepie_hw_generator_get_trailing_edge_time_min
- tiepie_hw_generator_get_trailing_edge_time_max
- tiepie_hw_generator_set_trailing_edge_time
- Since
- 1.0
◆ tiepie_hw_generator_set_trailing_edge_time()
| TIEPIE_HW_API double tiepie_hw_generator_set_trailing_edge_time | ( | tiepie_hw_handle | handle, |
| double | value | ||
| ) |
Set the trailing edge time, of a specified generator.
- Parameters
-
[in] handle A device handle identifying the generator. [in] value The requested trailing edge time in seconds.
- Returns
- The actually set trailing edge time in seconds.
- Remarks
- When the generator is active, changing the trailing edge time will shortly interrupt the output signal.
- Status values
TIEPIE_HW_STATUS_VALUE_CLIPPED The requested edge time is outside the valid range and clipped to the closest limit. TIEPIE_HW_STATUS_VALUE_MODIFIED The requested edge time is within the valid range but not available. The closest valid value is set. TIEPIE_HW_STATUS_NOT_SUPPORTED The generator does not support edge times for the current signal type. 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_has_edge_time
- tiepie_hw_generator_get_leading_edge_time_min
- tiepie_hw_generator_get_leading_edge_time_max
- tiepie_hw_generator_get_leading_edge_time
- tiepie_hw_generator_set_leading_edge_time
- tiepie_hw_generator_get_trailing_edge_time_min
- tiepie_hw_generator_get_trailing_edge_time_max
- tiepie_hw_generator_get_trailing_edge_time
- Since
- 1.0
