IviRFSigGen_QueryArbWaveformCapabilities

CVI/LabWindows IVI Class Driver

IviRFSigGen_QueryArbWaveformCapabilities

IviRFSigGenArbGenerator Capability Group

C Function Prototype

ViStatus IviRFSigGen_QueryArbWaveformCapabilities (ViSession vi, ViInt32* maxNumberofWaveforms, ViInt32* waveformQuantum, ViInt32* minWaveformSize, ViInt32* maxWaveformSize);

Purpose

This function returns the arb generator settings that are related to creating arbitrary waveforms. These attributes are the maximum number of waveforms, waveform quantum, minimum waveform size, and maximum waveform size.

Parameters

Name Type Description
vi ViSession The ViSession handle that you obtain from the IviRFSigGen_init or IviRFSigGen_InitWithOptions function. The handle identifies a particular instrument session.

Default Value: None

maxNumberofWaveforms ViInt32 Returns the maximum number of waveforms the instrument can hold in the memory. The number may be dependent on the length of the waveform already in the pool of waveforms saved in the instrument. The driver returns the value of the IVIRFSIGGEN_ATTR_ARB_MAX_NUMBER_WAVEFORMS attribute.

waveformQuantum ViInt32 Returns the waveform quantum where the waveform length is a multiple of this quantum. If the waveform quantum is 1, there is no restriction on the waveform length other than min and max size. The driver returns value of the IVIRFSIGGEN_ATTR_ARB_WAVEFORM_QUANTUM attribute.

minWaveformSize ViInt32 Returns the minimum size of the waveform length in number of samples. The waveform length must be equal or greater than this min size. If the minimum size is 1, there is no restriction on the waveform length other than max size and quantum. The driver returns the value of the IVIRFSIGGEN_ATTR_ARB_WAVEFORM_SIZE_MIN attribute.

maxWaveformSize ViInt32 Returns the maximum waveform length in the number of samples. The waveform length must be equal or less than this maximum size. The driver returns the value of the IVIRFSIGGEN_ATTR_ARB_WAVEFORM_SIZE_MAX attribute.

Return Values