AWG_Group_API -

get_sn


get_sn

Description

Retrieves the Series Number from the physical device.

Syntax

C++
UInt16 get_sn(UInt16 deviceIndexNum)

Arguments

deviceIndexNum index number of the AWG device

Return Value

seriesNumber Series Number of AWG device

Example

int seriesNumber;
seriesNumber = awg_group.get_sn(0);

Notes

This method is part of the AWG_Group_API class. The Series Number is a unique positive number that identifies each AWG board. You should always use this method to get the Series Number in order to initialize the AWG board.

If this method returns with "0" it means that there was no AWG board found. If you try to initialize an AWG_API object (using the ini method) with argument "0", your program will fail. You should have a conditional test to test whether the get_sn function returns with "0" and if it does, to stop further execution and to display an error message.

The argument passed to the get_sn function, 0 in the above example, is the index of the AWG module. If you have only one module connected, its index is 0. If you have multiple AWG modules connected, their indicies will count incrementally, starting from 0.

For example, if you connected two AWG modules with series numbers 3 and 11, their indicies will be 0 and 1 (not necessarily in that order), and you should use this method twice, once with each index, to get both serial numbers so that you can later initialize them both.