GxAoArbGetGroupClockRole

Purpose

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

Applies

GX1632e

Syntax

GxAoArbGetGroupClockRole (nHandle, pnRole, pnLeaderSource, pnStatus)

Parameters

Name
Type
Description
nHandle
SHORT
Handle to a GX1632e board.
pnRole
PSHORT
Gets the role that this board is currently assuming:
0.      GXAO_CLOCK_ROLE_LEADER
1.    GXAO_CLOCK_ROLE_FOLLOWER
pnLeaderSource
PSHORT
Returns the signal line that the board is currently outputting on.  If the role is currently follower, this value is irrelevant:
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

Default clock role and source is GXAO_CLOCK_ROLE_FOLLOWER and GXAO_CLOCKSOURCE_INTERNAL.  In this mode, the board acts independently of other boards within the chassis.

Example

The following example returns the boards clock role and output source, if appropriate:

 

SHORT  nStatus, nRole, nLeaderSource;

 

GxAoArbGetGroupClockRole (nHandle, &nRole, &nLeaderSource, &nStatus);

 

See Also

GxAoArbSetGroupClockRole, GxAoGetErrorString