VTI Instruments EX1629, User Manual

Page: 189 / 346

www.vtiinstruments.com
EX1629 Command Set 189
vtex1629_get_synch_source
F
UNCTION
P
ROTOTYPE
ViStatus vtex1629_get_synch_source (ViSession vi , ViPInt32 synchMode , ViPInt32 inLine , ViPInt32 outLine );
F
UNCTION
P
ARAMETERS
vi = contains a session handle to the instrument. This handle is obtained by the function and remains valid until the
session is closed.
synchMode = an integer output value that indicates whether the EX1629 is operating as a master or slave. Valid
return values: VTEX1629_SYNC_MODE_MASTER or VTEX1629_SYNC_MODE_SLAVE.
inLine = an integer output value that indicates the trigger bus line configured to listen for sample clock events.
Valid return values: VTEX1629_LXI_LINE_ZERO to VTEX1629_LXI_LINE_SEVEN,
VTEX1629_LXI_LINE_NONE.
outLine = an integer output value that indicates the trigger bus line configured to output sample clock events. Valid
return values: VTEX1629_LXI_LINE_ZERO to VTEX1629_LXI_LINE_SEVEN, VTEX1629_LXI_LINE_NONE.
D
ATA
I
TEM
R
ESET
V
ALUE
Not applicable to this function.
D
ESCRIPTION
This function queries and returns the configured synchronization source.
The
synchMode parameter indicates whether the EX1629 is configured as a master device that outputs a synch
signal for itself and other devices or as a slave device that receives its synch signal from another device. When
operating in standalone mode,
synchMode should be configured as a master.
The
inLine parameter indicates the LXI line that should be used as the synch input. This value is applicable
regardless of whether the device is configured as a master or a slave. When inLine is set to
VTEX1629_LXI_LINE_NONE, the internal synch line is used.
The
outLine parameter indicates the LXI line that should be used as the synch output. This value is only applicable
when the device is configured as a master. When outLine is set to VTEX1629_LXI_LINE_NONE, the synch signal
is output on the internal synch line.
When in master mode, the
inLine and outLine values may be the same or they may be different. One case where
they would be different is if the master is outputting the synch signal on one LXI line and receiving it back in from a
LXI Trigger Bus hub on another line. When in standalone mode,
inLine and outLine will always be the same.
Decimal
Value
Hex
Value
#define Symbol
inLine/outLine
Description
0 0x00 VTEX1629_LXI_LINE_ZERO LXI LINE 0
1 0x01 VTEX1629_LXI_LINE_ONE LXI LINE 1
2 0x02 VTEX1629_LXI_LINE_TWO LXI LINE 2
3 0x03 VTEX1629_LXI_LINE_THREE LXI LINE 3
4 0x04 VTEX1629_LXI_LINE_FOUR LXI LINE 4
5 0x05 VTEX1629_LXI_LINE_FIVE LXI LINE 5
6 0x06 VTEX1629_LXI_LINE_SIX LXI LINE 6
7 0x07 VTEX1629_LXI_LINE_SEVEN LXI LINE 7
8 0x08 VTEX1629_LXI_LINE_NONE None
E
XAMPLE
ViSession instrumentHandle;
ViStatus status;
ViInt32 synchmode, inline, outline;
…
…
status = vtex1629_get_synch_source(instrumentHandle, &synchmode, &inline, &outline);