Agilent Technologies E1439 manual Age1439fibersetup, BofEnable

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_fiber_setup

Sets the fiber interface parameters. This description also includes information on the following functions which set up or query the fiber parameters individually:

age1439_fiber_BOF controls whether or not automatically generated BOF events are transmitted.

age1439_fiber_BOF_get returns the current status of bofEnable.

age1439_fiber_crc sets up the fiber interface to transmit and receive cycle redundancy checking to the same value.

age1439_fiber_crc_get gets the current status of crcEnable.

age1439_fiber_flow_control enables or disables transmitter flow control signals. age1439_fiber_flow_control_get returns the value of flowControlMode. age1439_fiber_mode is used to select the fiber mode. age1439_fiber_mode_get returns the current value of fiberMode. age1439_fiber_transfer_rate selects the transfer rate for fiber optical data. age1439_fiber_transfer_rate_get returns the current value of transferRate.

VXIplug&play Syntax

#include "age1439".h

ViStatus age1439_fiber_setup(Visession id, ViInt16 mode, ViInt16 bofEnable, ViInt16

flowControlEnable, ViInt16 crcEnable, ViInt16 transferRate);

	ViStatus age1439_fiber_BOF(Visession id, ViInt16 bofEnable);
	ViStatus age1439_fiber_BOF_get(Visession id, ViPInt16 bofEnablePtr);
	ViStatus age1439_fiber_crc(Visession id, ViInt16 crcEnable);
	ViStatus age1439_fiber_crc_get(Visession id, ViPInt16 crcEnablePtr);
	ViStatus age1439_fiber_flow_control(Visession id, ViInt16 flowControlMode);
	ViStatus age1439_fiber_flow_control_get(Visession id, ViInt16 flowControlModePtr);
	ViStatus age1439_fiber_mode(Visession id, ViInt16 fiberMode);
	ViStatus age1439_fiber_mode_get(Visession id, ViPInt16 fiberModePtr);
	ViStatus age1439_fiber_transfer_rate(Visession id, ViInt16 transferRate);
	ViStatus age1439_fiber_transfer_rate_get(Visession id, ViPInt16 transferRatePtr);
	Parameter
id	is the VXI instrument session pointer returned by the age1439_init function.
bofEnable	configures the automatic generation of BOF events. Generally, this is only used by modules in an
	optical append chain.
	AGE1439_BOF_ON is used in an optical append chain. When used in this manner, all but the last
	module in the append chain should have BOF events enabled. The first module in the append
	chain should also have fiberMode set to AGE1439_FIBER_MODE_GENERATE. This will cause
	it to generate a BOF event after every EOE event, in other words, at the end of every data epoch it
	sends. All subsequent modules in an append chain should have fiberMode set to AGE1439_
	FIBER_MODE_APPEND. In this case, the module re-transmits received data epochs without
	modification. The reception of a BOF event alerts the module to the opportunity to insert a data
	epoch of its own, if available, between the reception of EOE and BOF events. AGE1439_BOF_
	ON is only available when epochGenerate is ON and fiberMode is either generate or append,
	otherwise this setting is silently accepted and ignored.

112