libtiepie-hw  1.1.4

The Time property determines how long a specific condition must last for the channel trigger to respond. More...

Collaboration diagram for Time:

Functions

TIEPIE_HW_API uint32_t tiepie_hw_oscilloscope_channel_trigger_get_time_count (tiepie_hw_handle handle, uint16_t ch)
 Get the number of trigger times for the current trigger kind and trigger condition. More...
 
TIEPIE_HW_API double tiepie_hw_oscilloscope_channel_trigger_get_time (tiepie_hw_handle handle, uint16_t ch, uint32_t index)
 Get the current trigger time value for a specified channel and trigger type. More...
 
TIEPIE_HW_API double tiepie_hw_oscilloscope_channel_trigger_set_time (tiepie_hw_handle handle, uint16_t ch, uint32_t index, double value)
 Set the required trigger time value for a specified channel and trigger type. More...
 

Detailed Description

The Time property determines how long a specific condition must last for the channel trigger to respond.

The number of time properties depends on the currently selected trigger kind and currently selected trigger condition. Use tiepie_hw_oscilloscope_channel_trigger_get_time_count() to determine the number of trigger time properties for the currently set trigger kind and condition.

The trigger time can be affected by changing the sample rate.

The trigger time is set as a value in seconds. By default time[0] is set to 1 ms.

Function Documentation

◆ tiepie_hw_oscilloscope_channel_trigger_get_time_count()

TIEPIE_HW_API uint32_t tiepie_hw_oscilloscope_channel_trigger_get_time_count ( tiepie_hw_handle  handle,
uint16_t  ch 
)

Get the number of trigger times for the current trigger kind and trigger condition.

Parameters
[in]handleA device handle identifying the oscilloscope.
[in]chThe channel number identifying the channel, 0 to tiepie_hw_oscilloscope_get_channel_count() - 1.
Returns
The number of available trigger times for the current trigger kind and condition.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The indicated channel does not support trigger with the current settings.
TIEPIE_HW_STATUS_INVALID_CHANNEL
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid oscilloscope handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_oscilloscope_channel_trigger_get_kind
tiepie_hw_oscilloscope_channel_trigger_get_condition
tiepie_hw_oscilloscope_channel_trigger_get_time
tiepie_hw_oscilloscope_channel_trigger_set_time
Since
1.0

◆ tiepie_hw_oscilloscope_channel_trigger_get_time()

TIEPIE_HW_API double tiepie_hw_oscilloscope_channel_trigger_get_time ( tiepie_hw_handle  handle,
uint16_t  ch,
uint32_t  index 
)

Get the current trigger time value for a specified channel and trigger type.

Parameters
[in]handleA device handle identifying the oscilloscope.
[in]chThe channel number identifying the channel, 0 to tiepie_hw_oscilloscope_get_channel_count() - 1.
[in]indexThe trigger time index, 0 to Scp_chTr_get_time_count() - 1.
Returns
The currently set trigger time value, in seconds.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The indicated channel does not support trigger (time) with the current settings.
TIEPIE_HW_STATUS_INVALID_INDEX The trigger time index is invalid.
TIEPIE_HW_STATUS_INVALID_CHANNEL
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid oscilloscope handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_oscilloscope_channel_trigger_get_time_count
tiepie_hw_oscilloscope_channel_trigger_set_time
Since
1.0

◆ tiepie_hw_oscilloscope_channel_trigger_set_time()

TIEPIE_HW_API double tiepie_hw_oscilloscope_channel_trigger_set_time ( tiepie_hw_handle  handle,
uint16_t  ch,
uint32_t  index,
double  value 
)

Set the required trigger time value for a specified channel and trigger type.

Parameters
[in]handleA device handle identifying the oscilloscope.
[in]chThe channel number identifying the channel, 0 to tiepie_hw_oscilloscope_get_channel_count() - 1.
[in]indexThe trigger time index, 0 to Scp_chTr_get_time_count() - 1.
[in]valueThe required trigger time value, in seconds.
Returns
The actually set trigger time value, in seconds.
Status values
TIEPIE_HW_STATUS_VALUE_MODIFIED The requested trigger time is within the valid range, but not available. The closest valid value is set.
TIEPIE_HW_STATUS_INVALID_VALUE The requested trigger time is invalid.
TIEPIE_HW_STATUS_INVALID_INDEX The trigger time index is invalid.
TIEPIE_HW_STATUS_NOT_SUPPORTED The indicated channel does not support trigger (time) with the current settings.
TIEPIE_HW_STATUS_INVALID_CHANNEL
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid oscilloscope handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_oscilloscope_channel_trigger_get_time_count
tiepie_hw_oscilloscope_channel_trigger_get_time
Since
1.0