NI DIGITAL PATTERN DRIVER Clock Generator Functions - ni/grpc-device GitHub Wiki
- niDigital_ClockGenerator_GenerateClock
- niDigital_ClockGenerator_Initiate
- niDigital_ClockGenerator_Abort
Configures clock generator frequency and initiates clock generation on the specified channel(s) or pin(s) and pin group(s).
C Function Prototype: ViStatus niDigital_ClockGenerator_GenerateClock (ViSession vi, ViConstString channelList, ViReal64 frequency, ViBoolean selectDigitalFunction)
| Parameter | Description |
|---|---|
| vi | The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns. |
| channelList |
List of channel names or list of pins. Do not pass a mix of channel names and pin names. An empty string denotes all digital pattern instrument channels. Pin names and pin groups apply to all enabled sites, unless the pin name explicitly specifies the site. You can specify a pin in a specific site using the form siteN/pinName, where N is the site number. This function ignores pins that are not mapped to the digital pattern instrument. Specify channel names using the form PXI1Slot3/0,2-3 or PXI1Slot3/0,PXI1Slot3/2-3, where PXI1Slot3 is the instrument resource name and 0, 2, 3 are channel names. To specify channels from multiple instruments, use the form PXI1Slot3/0,PXI1Slot3/2-3,PXI1Slot4/2-3. The instruments must be in the same chassis. |
| frequency | The frequency of the clock generation, in Hz. |
| selectDigitalFunction | A Boolean that specifies whether to select the digital function for the pins specified prior to starting clock generation. |
Return value: Reports the status of the operation.
Initiates clock generation on the specified channel(s) or pin(s) and pin group(s).
C Function Prototype: ViStatus niDigital_ClockGenerator_Initiate (ViSession vi, ViConstString channelList)
| Parameter | Description |
|---|---|
| vi | The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns. |
| channelList |
List of channel names or list of pins. Do not pass a mix of channel names and pin names. An empty string denotes all digital pattern instrument channels. Pin names and pin groups apply to all enabled sites, unless the pin name explicitly specifies the site. You can specify a pin in a specific site using the form siteN/pinName, where N is the site number. This function ignores pins that are not mapped to the digital pattern instrument. Specify channel names using the form PXI1Slot3/0,2-3 or PXI1Slot3/0,PXI1Slot3/2-3, where PXI1Slot3 is the instrument resource name and 0, 2, 3 are channel names. To specify channels from multiple instruments, use the form PXI1Slot3/0,PXI1Slot3/2-3,PXI1Slot4/2-3. The instruments must be in the same chassis. |
Return value: Reports the status of the operation.
Stops clock generation on the specified channel(s) or pin(s) and pin group(s).
C Function Prototype: ViStatus niDigital_ClockGenerator_Abort (ViSession vi, ViConstString channelList)
| Parameter | Description |
|---|---|
| vi | The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns. |
| channelList |
List of channel names or list of pins. Do not pass a mix of channel names and pin names. An empty string denotes all digital pattern instrument channels. Pin names and pin groups apply to all enabled sites, unless the pin name explicitly specifies the site. You can specify a pin in a specific site using the form siteN/pinName, where N is the site number. This function ignores pins that are not mapped to the digital pattern instrument. Specify channel names using the form PXI1Slot3/0,2-3 or PXI1Slot3/0,PXI1Slot3/2-3, where PXI1Slot3 is the instrument resource name and 0, 2, 3 are channel names. To specify channels from multiple instruments, use the form PXI1Slot3/0,PXI1Slot3/2-3,PXI1Slot4/2-3. The instruments must be in the same chassis. |
Return value: Reports the status of the operation.