libtiepie-hw  1.2.5

Functions that provide information of a generator. More...

Collaboration diagram for Info:

Functions

TIEPIE_HW_API uint32_t tiepie_hw_generator_get_connector_type (tiepie_hw_handle handle)
 Get the output connector type for a specified generator. More...
 
TIEPIE_HW_API tiepie_hw_bool tiepie_hw_generator_is_differential (tiepie_hw_handle handle)
 Check whether the output of a specified generator is differential. More...
 
TIEPIE_HW_API double tiepie_hw_generator_get_impedance (tiepie_hw_handle handle)
 Get the output impedance of a specified generator. More...
 
TIEPIE_HW_API uint8_t tiepie_hw_generator_get_resolution (tiepie_hw_handle handle)
 Get the DAC resolution of a specified generator. More...
 
TIEPIE_HW_API double tiepie_hw_generator_get_output_value_min (tiepie_hw_handle handle)
 Get the minimum output value of a specified generator. More...
 
TIEPIE_HW_API double tiepie_hw_generator_get_output_value_max (tiepie_hw_handle handle)
 Get the maximum output value of a specified generator. More...
 

Detailed Description

Functions that provide information of a generator.

Function Documentation

◆ tiepie_hw_generator_get_connector_type()

TIEPIE_HW_API uint32_t tiepie_hw_generator_get_connector_type ( tiepie_hw_handle  handle)

Get the output connector type for a specified generator.

Parameters
[in]handleA device handle identifying the generator.
Returns
The output connector type, TIEPIE_HW_CONNECTORTYPE_UNKNOWN when unsuccessful.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The generator does not support getting the connector 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
Since
1.0

◆ tiepie_hw_generator_is_differential()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_generator_is_differential ( tiepie_hw_handle  handle)

Check whether the output of a specified generator is differential.

Parameters
[in]handleA device handle identifying the generator.
Returns
TIEPIE_HW_BOOL_TRUE when the output is differential, TIEPIE_HW_BOOL_FALSE otherwise.
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
Since
1.0

◆ tiepie_hw_generator_get_impedance()

TIEPIE_HW_API double tiepie_hw_generator_get_impedance ( tiepie_hw_handle  handle)

Get the output impedance of a specified generator.

Parameters
[in]handleA device handle identifying the generator.
Returns
The output impedance in Ohm.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The generator does not support getting the output impedance.
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
Since
1.0

◆ tiepie_hw_generator_get_resolution()

TIEPIE_HW_API uint8_t tiepie_hw_generator_get_resolution ( tiepie_hw_handle  handle)

Get the DAC resolution of a specified generator.

Parameters
[in]handleA device handle identifying the generator.
Returns
The resolution in bits.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The generator does not support getting the resolution.
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
Since
1.0

◆ tiepie_hw_generator_get_output_value_min()

TIEPIE_HW_API double tiepie_hw_generator_get_output_value_min ( tiepie_hw_handle  handle)

Get the minimum output value of a specified generator.

Parameters
[in]handleA device handle identifying the generator.
Returns
The minimum output value in Volt.
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_output_value_max
Since
1.0

◆ tiepie_hw_generator_get_output_value_max()

TIEPIE_HW_API double tiepie_hw_generator_get_output_value_max ( tiepie_hw_handle  handle)

Get the maximum output value of a specified generator.

Parameters
[in]handleA device handle identifying the generator.
Returns
The maximum output value in Volt.
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_output_value_min
Since
1.0