NI DIGITAL PATTERN DRIVER Low Level Action Functions - ni/grpc-device GitHub Wiki
- niDigital_Commit
- niDigital_Initiate
- niDigital_IsDone
- niDigital_WaitUntilDone
- niDigital_Abort
- niDigital_AbortKeepAlive
Applies all previously configured pin levels, termination modes, clocks, triggers, and pattern timing to a digital pattern instrument. If you do not call the niDigital_Commit function, then the niDigital_Initiate function or the niDigital_BurstPattern function will implicitly call this function for you. Calling this function moves the session from the Uncommitted state to the Committed state.
C Function Prototype: ViStatus niDigital_Commit (ViSession vi)
Parameter | Description |
---|---|
vi | The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns. |
Return value: Reports the status of the operation.
Starts bursting the pattern. If you do not call the niDigital_Commit function, this function implicitly calls the niDigital_Commit function for you.
C Function Prototype: ViStatus niDigital_Initiate (ViSession vi)
Parameter | Description |
---|---|
vi | The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns. |
Return value: Reports the status of the operation.
Checks the hardware to determine if the pattern burst has completed or if any errors have occurred.
C Function Prototype: ViStatus niDigital_IsDone (ViSession vi, ViBoolean* done)
Parameter | Description |
---|---|
vi | The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns. |
Output | |
done | A Boolean that indicates whether the pattern burst completed. |
Return value: Reports the status of the operation.
Waits until the pattern burst has completed or the timeout has expired.
C Function Prototype: ViStatus niDigital_WaitUntilDone (ViSession vi, ViReal64 timeout)
Parameter | Description |
---|---|
vi | The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns. |
timeout | Maximum time (in seconds) allowed for this function to complete. If this function does not complete within this time interval, this function returns an error. |
Return value: Reports the status of the operation.
Stops bursting the pattern.
C Function Prototype: ViStatus niDigital_Abort (ViSession vi)
Parameter | Description |
---|---|
vi | The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns. |
Return value: Reports the status of the operation.
Stops the keep alive pattern if it is currently running.
If a pattern burst is in progress, the function aborts the pattern burst. If you start a new pattern burst while a keep alive pattern is running, the keep alive pattern runs to the last keep alive vector, and the new pattern burst starts on the next cycle.
C Function Prototype: ViStatus niDigital_AbortKeepAlive (ViSession vi)
Parameter | Description |
---|---|
vi | The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns. |
Return value: Reports the status of the operation.