Agilent Technologies VXI E1439 - Manual (Page 172)

162
Agilent E1439 Programmer's Reference
Functions listed alphabetically
age1439_read_raw
Reads raw, unscaled data from the VME backplane register.
VXIplug&play Syntax
#include "age1439".h
ViStatus age1439_read_raw(ViSession id, ViInt16 data[], ViInt32 wordCount, ViPInt16
overloadPtr);
Description
age1439_read_raw returns a block of raw, unscaled integer data from the FIFO.
This function can only read data from the VME backplane register. The data port of the
Agilent E1439 must be set to AGE1439_VME by the age1439_data_port function for this
function to be effective.
This function performs the following sequence:
1. Checks for AGE1439_STATUS_READ_BLOCK and AGE1439_STATUS_
OVERLOAD.
2. If there is an overload then the overload count maintained by the API is incremented.
3. If a block of data is NOT ready:
A. the function immediately returns the current measurement state and
B. the value of the overload argument is set to AGE1439_OFF.
4. If a block of date IS ready:
A. data is read from the module,
B. the function returns any errors that were encountered when reading the data,
C. the value of the overload argument is set to AGE1439_ON, and
D. the overload count maintained by the API is set to zero.
Parameters
id is the VXI instrument session pointer returned by the age1439_init function.
data is a pointer to the array into which the raw data record is to be placed. Be sure to allocate
sufficient storage space to hold the full data record as determined by the wordCount parameter.
wordCount wordCount is the total number of data values to read into the data array from the Agilent E1439
output FIFO. The maximum wordCount depends on the blocksize, data type, and data resolution
parameter settings.