Agilent Technologies E1439, User Manual

Page: 108 / 246

98
Agilent E1439 Programmer's Reference
Functions listed alphabetically
age1439_epoch_setup
Sets the parameters relevant to the transmission of data epochs over the fiber interface. This
description also includes information on the following functions that set up or query the fiber
epoch parameters individually:
age1439_epoch_generate controls whether data epochs are generated or not.
age1439_epoch_generate_get gets the epoch generation status.
age1439_epoch_header sets the value of the first 32 bits of the epoch header.
age1439_epoch_header_get returns the header value.
age1439_epoch_header_enable controls whether epoch headers are generated or not.
age1439_epoch_header_enable_get gets the header status.
age1439_epoch_size sets the size of the data epoch in bytes.
age1439_epoch_size_get gets the size of the data epoch
VXI plug&play Syntax
#include "age1439".h
ViStatus age1439_epoch_setup(Visession id , ViInt16 epochGenerate , ViInt32 epochSize ,
ViInt16 headerEnable , ViInt32 initialValue , ViInt32 incrementCount );
ViStatus age1439_epoch_generate(Visession id , ViInt16 epochGenterate );
ViStatus age1439_epoch_generate_get(Visession id , ViPInt16 epochGenteratePtr );
ViStatus age1439_epoch_header(Visession id , ViInt32 headerValue ,
ViInt32 incrementCount );
ViStatus age1439_epoch_header_get(Visession id , ViPInt32 headerValuePtr ,
ViPInt32 incrementCountPtr );
ViStatus age1439_epoch_header_enable(Visession id , ViInt16 headerEnable );
ViStatus age1439_epoch_header_enable_get(Visession id , ViPInt16 headerEnablePtr );
ViStatus age1439_epoch_size(Visession id , ViInt32 epochSize );
ViStatus age1439_epoch_size_get(Visession id , ViPInt32 epochSizePtr );
Parameters
id is the VXI instrument session pointer returned by the age1439_init function.
epochGenerate controls whether or not data epochs are generated.
AGE1439_EPOCH_GEN_ON enables data epoch generation.
AGE1439_EPOCH_GEN_OFF disables sending end of epoch and epoch headers and disables
generating data epochs.
When epochGenerate is off, EOE (End of Epoch) events and epoch headers are not sent however,
data still is. Generally, epochGenerate should be on and should only be disabled for purposes of
compatibility. This setting is ignored when the fiberMode is AGE1439_FIBER_COPY .
epochGeneratePtr points to the current value of epochGenerate
epochSize sets the size of data epochs in bytes.
AGE1439_EPOCH_SIZE_MIN selects the minimum data epoch size.
AGE1439_EPOCH_SIZE_DEF sets the data epoch size to the default.
AGE1439_EPOCH_SIZE_MAX selects the maximum data epoch size.