NI TClk Advanced Functions - ni/grpc-device GitHub Wiki
- niTClk_IsDone
- niTClk_SetupForSyncPulseSenderSynchronize
- niTClk_SynchronizeToSyncPulseSender
- niTClk_FinishSyncPulseSenderSynchronize
ViStatus niTClk_IsDone (ViUInt32 sessionCount, ViSession sessions [], ViBoolean *done);
Reports the progress of the acquisitions and/or generations, corresponding to the sessions.
Input | ||
---|---|---|
Name | Type | Description |
sessionCount | ViUInt32 | Specifies the number of elements in the sessions array. |
sessions | ViSession [] | Specifies the array of session references that are being synchronized. Obtain session references from the instrument driver by using the Get Session Reference function, where is the name of the instrument driver. Example: niScope_GetSessionReference. |
Output | ||
done | ViBoolean* | Indicates whether the operation is done. The operation is done when each session has completed without any errors, or when any one of the sessions reports an error. |
The status code returned by the function.
- A value of 0 indicates success.
- A negative value indicates an error.
- A value greater than 0 indicates a warning.
Use niTClk_GetExtendedErrorInfo to get detailed information about individual errors and warnings.
ViStatus _VI_FUNC niTClk_SetupForSyncPulseSenderSynchronize (ViUInt32 sessionCount, ViSession sessions[], ViReal64 minTime);
Configures the TClks on all the devices and prepares the Sync Pulse Sender for synchronization.
Input |
---|
Name | Type | Description |
---|---|---|
sessionCount | ViUInt32 | Specifies the number of elements in the sessions array. |
sessions | ViSession [] | Specifies the array of session references that are being synchronized. Obtain session references from the instrument driver by using the Get Session Reference function, where is the name of the instrument driver. Example: niScope_GetSessionReference. |
minTime | ViReal64 | Specifies the minimum TClk period, in seconds. Valid values are 0.0 to 0.050 s (50 ms), inclusive. The minimum period for a single chassis/PC is 200 ns. If the specified value is less than 200 ns, NI-TClk automatically coerces the minimum TClk period to 200 ns. For multichassis synchronization, adjust this value to account for the propagation delays through the various devices and cables. |
The status code returned by the function.
- A value of 0 indicates success.
- A negative value indicates an error.
- A value greater than 0 indicates a warning.
Use niTClk_GetExtendedErrorInfo to get detailed information about individual errors and warnings.
ViStatus _VI_FUNC niTClk_SynchronizeToSyncPulseSender (ViUInt32 sessionCount, ViSession sessions[], ViReal64 minTime);
Synchronizes the other devices to the Sync Pulse Sender.
Input |
---|
Name | Type | Description |
---|---|---|
sessionCount | ViUInt32 | Specifies the number of elements in the sessions array. |
sessions[] | ViSession | Specifies an array of session references that are being synchronized. Obtain session references from the instrument driver by using the Get Session Reference function, where is the name of the instrument driver. Example: niScope_GetSessionReference. |
minTime | ViReal64 | Specifies the minimum TClk period, in seconds. Valid values are 0.0 to 0.050 s (50 ms), inclusive. The minimum period for a single chassis/PC is 200 ns. If the specified value is less than 200 ns, NI-TClk automatically coerces the minimum TClk period to 200 ns. For multichassis synchronization, adjust this value to account for the propagation delays through the various devices and cables. |
The status code returned by the function.
- A value of 0 indicates success.
- A negative value indicates an error.
- A value greater than 0 indicates a warning.
Use niTClk_GetExtendedErrorInfo to get detailed information about individual errors and warnings.
ViStatus _VI_FUNC niTClk_FinishSyncPulseSenderSynchronize (ViUInt32 sessionCount, ViSession sessions[], ViReal64 minTime);
Finishes synchronizing the Sync Pulse Sender.
Input |
---|
Name | Type | Description |
---|---|---|
sessionCount | ViUInt32 | Specifies the number of elements in the sessions array. |
sessions | ViSession [] | Specifies the array of session references that are being synchronized. Obtain session references from the instrument driver by using the Get Session Reference function, where is the name of the instrument driver. Example: niScope_GetSessionReference. |
minTime | ViReal64 | Specifies the minimum TClk period, in seconds. Valid values are 0.0 to 0.050 s (50 ms), inclusive. The minimum period for a single chassis/PC is 200 ns. If the specified value is less than 200 ns, NI-TClk automatically coerces the minimum TClk period to 200 ns. For multichassis synchronization, adjust this value to account for the propagation delays through the various devices and cables. |
The status code returned by the function.
- A value of 0 indicates success.
- A negative value indicates an error.
- A value greater than 0 indicates a warning.
Use niTClk_GetExtendedErrorInfo to get detailed information about individual errors and warnings.