GxAoArbSetGroupClockRole

Sets the role that the board will assume in the waveform generating domain.

Applies

GX1632e

Syntax

GxAoArbSetGroupClockRole (nHandle, nRole, nSource, pnStatus)

Parameters

Name
Type
Description
nHandle
SHORT
Handle to a GX1632e board.
nRole
SHORT
Specifies the role to assume:
0.      GXAO_CLOCK_ROLE_LEADER
1.    GXAO_CLOCK_ROLE_FOLLOWER
nLeaderSource
SHORT
 
Specifies the signal line that the board is currently outputting on.  This parameter is not used for boards in the follower role.  Valid options are:
2.      GXAO_CLOCKSOURCE_PXI0
3.      GXAO_CLOCKSOURCE_PXI1
4.      GXAO_CLOCKSOURCE_PXI2
5.      GXAO_CLOCKSOURCE_PXI3
6.      GXAO_CLOCKSOURCE_PXI4
7.      GXAO_CLOCKSOURCE_PXI5
8.      GXAO_CLOCKSOURCE_PXI6
9.      GXAO_CLOCKSOURCE_PXI7
10.   GXAO_CLOCKSOURCE_STAR_TRIGGER
11.  GXAO_CLOCKSOURCE_STAR_A
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

This function is used to synchronize signals between multiple GX1632e boards.  To do this, the domain must have one leader sharing its clock with one or more followers who are synchronized to that card.

Example

The following example sets one board as leader and another board as follower.  The PXI trigger line 2 is used to synchronize the domain as the leader uses an internal source:

 

SHORT nStatus;

GxAoArbSetGroupClockRole(nHandleLeader, GXAO_CLOCK_ROLE_LEADER, GXAO_CLOCKSOURCE_PXI2, &nStatus);

GxAoArbSetGroupClockEx(nHandleLeader, GXAO_GROUPA, GXAO_CLOCKSOURCE_INTERNAL, &nStatus);

GxAoArbSetGroupClockRole(nHandleFollower, GXAO_CLOCK_ROLE_FOLLOWER, 0, &nStatus);

GxAoArbSetGroupClockEx(nHandleFollower, GXAO_GROUPA, GXAO_CLOCKSOURCE_PXI2, &nStatus);

 

See Also

GxAoArbSetGroupClockEx, GxAoArbGetGroupClockRole, GxAoGetErrorString