VTI Instruments EX1629 - Vtex1629_Set_Gain

VTI Instruments Corp.
258 EX1629 Command Set
vtex1629_set_gain
FUNCTION PROTOTYPE
ViStatus vtex1629_set_gain (ViSession vi, ViInt32 _VI_FAR channels[], ViInt32 numberOfChannels, ViReal64
gain);
FUNCTION PARAMETERS
vi = contains a session handle to the instrument. This handle is obtained by the function and remains valid until the
session is closed.
channels = an input integer array containing a list of channel numbers for which the gain will be set. Valid input
values: 0 to 47.
numberOfChannels = the size of the channels list. Valid input values: 1 to 48.
gain = a real input value indicating the desired gain value for the given set of channels. Valid input values: 1.00,
10.0, or 100.0.
DATA ITEM RESET VALUE
gain = 1.0
DESCRIPTION
This function sets the signal conditioning gain for a given list of channels.
Decimal
Value
Hex
Value
#define Symbol
gain Description
1
0x00
VTEX1629_GAIN_ONE
1
10
0x0A
VTEX1629_GAIN_TEN
10
100
0x64
VTEX1629_GAIN_HUNDRED
100
NOTE While defined as a real parameter, gain has only three valid values, corresponding to discrete
hardware gain configurations. The gain cannot be arbitrarily set.
EXAMPLE
ViSession instrumentHandle;
ViStatus status;
ViInt32 channels[] = {0};
ViInt32 numberOfChannels = 1;
…
status = vtex1629_set_gain(instrumentHandle,
channels,
numberOfChannels,
VTEX1629_GAIN_HUNDRED);