LibTiePie  0.4.5
Library for interfacing TiePie engineering instruments
 All Files Functions Typedefs Macros Modules Pages

Description

Functions for starting and stopping the generator.

Functions

bool8_t GenIsControllable (TpDeviceHandle_t hDevice)
 Check whether the generator can be controlled. More...
 
bool8_t GenGetOutputOn (TpDeviceHandle_t hDevice)
 Check whether generator output is on. More...
 
bool8_t GenSetOutputOn (TpDeviceHandle_t hDevice, bool8_t bOutputOn)
 Enable or disable generator output. More...
 
void GenStart (TpDeviceHandle_t hDevice)
 Start generator. More...
 
void GenStop (TpDeviceHandle_t hDevice)
 Stop generator. More...
 

Function Documentation

bool8_t GenIsControllable ( TpDeviceHandle_t  hDevice)

Check whether the generator can be controlled.

In certain conditions like when performing a streaming measurement with the oscilloscope, the generator cannot be controlled.

Parameters
hDeviceA device handle.
Returns
BOOL8_TRUE if controllable, BOOL8_FALSE otherwise.
See also
Event Controllable changed.
Since
0.4.0
bool8_t GenGetOutputOn ( TpDeviceHandle_t  hDevice)

Check whether generator output is on.

Parameters
hDeviceA device handle.
Returns
BOOL8_TRUE if output is on, BOOL8_FALSE if output is off.
Since
0.4.0
bool8_t GenSetOutputOn ( TpDeviceHandle_t  hDevice,
bool8_t  bOutputOn 
)

Enable or disable generator output.

Parameters
hDeviceA device handle.
bOutputOnBOOL8_TRUE to enable the output, BOOL8_FALSE to disable the output.
Returns
BOOL8_TRUE if output is on, BOOL8_FALSE if output is off.
Since
0.4.0
void GenStart ( TpDeviceHandle_t  hDevice)

Start generator.

Parameters
hDeviceA device handle.
Since
0.4.0
void GenStop ( TpDeviceHandle_t  hDevice)

Stop generator.

Parameters
hDeviceA device handle.
Since
0.4.0