IviFgen_CreateArbSequence
IviFgenArbSeq Capability Group
C Function Prototype
ViStatus IviFgen_CreateArbSequence (ViSession vi, ViInt32 sequenceLength, ViInt32 waveformHandlesArray[], ViInt32 loopCountsArray[], ViInt32 *sequenceHandle);
Purpose
An arbitrary sequence consists of multiple waveforms. For each waveform, you specify the number of times the function generator produces the waveform before proceeding to the next waveform. The number of times to repeat a specific waveform is called the loop count.
This function creates an arbitrary sequence from an array of waveform handles and an array of corresponding loop counts. The function returns a handle that identifies the sequence. You pass this handle to the IviFgen_ConfigureArbSequence function to specify what arbitrary sequence you want the function generator to produce.
Parameters
| Inputs | Type | Description |
| vi | ViSession | The instrument handle that you obtain from the IviFgen_init or IviFgen_InitWithOptions functions. The handle identifies a particular IVI session. |
| sequenceLength | ViInt32 | Pass the number of waveforms in the new arbitrary sequence you want to create. The value you pass must be between the minimum and maximum sequence lengths the function generator allows. You can obtain the minimum and maximum sequence lengths from the minimumSequenceLength and maximumSequenceLength parameters of the IviFgen_QueryArbSeqCapabilities function. |
| waveformHandles Array |
ViInt32[] | Pass the array of waveform handles from which you want to create a new arbitrary sequence. The array must have at least as many elements as the value you specify in the sequenceLength parameter. Each Waveform Handles array element has a corresponding Loop Counts array element that indicates how many times that waveform is repeated. You obtain waveform handles when you create arbitrary waveforms with the IviFgen_CreateArbWaveform% function. |
| loopCountsArray | ViInt32[] | Pass the array of loop counts you want to use to create a new arbitrary sequence. The array must have at least as many elements as the value you specify in the sequenceLength parameter. Each Loop Counts array element corresponds to a Waveform Handles array element and indicates how many times to repeat that waveform. Each element of the Loop Count array must be less than or equal to the maximum number of loop counts the function generator allows. You can obtain the maximum loop count from the maximumLoopCount parameter of the IviFgen_QueryArbSeqCapabilities function. |
| Outputs | Type | Description |
| sequenceHandle | ViInt32 (passed by reference) |
Returns the handle that identifies the new arbitrary sequence. You pass this handle to the IviFgen_ConfigureArbSequence% function to generate the arbitrary sequence. |