Age1439staterecall, #include age1439.h | Agilent Technologies E1439

Agilent E1439 Programmer's Reference

Functions listed alphabetically

age1439_state_recall

Recalls a module’s previous instrument state.

	age1439_state_recall
	VXIplug&play Syntax
	#include "age1439".h
	ViStatus age1439_state_recall(ViSession id);
	Description
	This function aborts any active measurement and recalls the instrument state previously saved by
	age1439_state_save. This function requires >100 ms to complete.
	Parameters
id	is the VXI instrument session pointer returned by the age1439_init function.
	Return Value
	AGE1439_SUCCESS indicates that a function was successful.
	Values other than AGE1439_SUCCESS indicate an error condition or other important status
	condition. To determine the error message, pass the return value to “age1439_error_message” on
	page 102.
	See Also
	“Commands which halt active measurements” on page 198, “age1439_init” on page 132,
	“age1439_state_save” on page 175

174

Image 184

Agilent Technologies E1439 manual Age1439staterecall, #include age1439.h, ViStatus age1439staterecallViSession id

Contents

Agilent Technologies Part Number E1439-90005 Trademarks Agilent E1439 at a Glance E1438 E1439 What You Get With the Agilent E1439 HardwareSoftware Documentation This Book Other DocumentationPage Contents Contents Replacing Assemblies Contents Installing the Agilent E1439 To inspect the Agilent E1439 To inspect the Agilent E1439 To install the Agilent E1439 To install the Agilent E1439 Logical Address VXI Mainframe To clean fiber optic connectors To clean fiber optic connectors To transport the module To store the moduleTo store the module To transport the module Getting Started with the Agilent E1439 Getting Started and Introduction Getting Started and Introduction System Requirements System RequirementsSystem Requirements Microsoft Windows To install the Windows VXIplug&play drivers To install the Windows VXIplug&play driversUpdating firmware To use the Resource Manager To use the Resource Manager To use the program group Windows To use the program group Windows To use the VXIplug&play Soft Front Panel SFP To use the VXIplug&play Soft Front Panel SFP To use the example programs To use the example programs Info.exe Multchan32.exeInterrupt.exe Getting Started with the Agilent E1439 Using the Agilent E1439 Agilent E1439 overview Agilent E1439 overview Programming the Agilent E1439 Programming the Agilent E1439Windows framework Programming Measurement loop Measurement loop Measurement loop in multi-module systems Delay and phase in triggered measurements Delay and phase in triggered measurements Triggerdelayactual=0 or 0/16=0 output samples Using the Agilent E1439 Magnitude trigger and magdwell time Magnitude trigger and magdwell time Using the Agilent E1439 Frequency and filtering Frequency and filtering Using clock and sync Using clock and sync Sharing Reference and Sync signals in multi-module systems Managing multiple modulesManaging multiple modules Clock distribution Using the Agilent E1439 Systems using front panel distribution Managing multi-module systems Slot0 Controller Managing multi-mainframe systems Slave on Using an external sample clock Splitter External sample clock Synchronous digital filter changes Synchronizing changes in multi-module systemsSynchronous center frequency changes Trigger and phase in multi-module systems External sample synchronization in multi-module systems Now you may take a measurement Issue an age1439measstart Sync the digital local oscillators Transferring data Transferring data Fiber Optic Interface Fiber Optic Interface Fiber Frames Data Frame Normal Data Fiber FrameBOF Sync Without Data Fiber Frame EOE Sync with Data Fiber Frame Fiber Modes Fiber Interface SetupOff Copy Raw Generate Fiber Receiver Append Fiber Receiver Flow Control Copy No Copy2 Agilent E1439 Programmers Reference Introduction Introduction Functions listed by class Functions listed by classComponent Capability Subclass Function Name Component Capability Subclass Function Name Route Configure Route Configure LOW Level Age1439interruptrestore on Functions listed by functional group Functions listed by functional group Initializing and closing Debugging Agilent E1439 Programmers Reference Identification Trigger Synchronization controlling multiple modules Functions listed alphabetically Functions listed alphabetically Age1439driverdebuglevelget on page 97 −gets the debug level Agilent E1439 Programmers Reference Agilent E1439 Programmers Reference Agilent E1439 Programmers Reference Age1439adcclock Age1439adcdivider AdcDivider AdcDividerPtrAge1439adcdividerget Description Age1439attribget Description Board Age1439calgetDatestampPtr Age1439clockfs Age1439clockfsgetViStatus age1439clockfsViSession id, ViReal64 fs ViStatus age1439clockfsgetViSession id, ViPReal64 fsPtr Age1439clockrecover ClockSetup Age1439clocksetupAge1439clocksetupget Phase locked to external reference Simple clock setups for stand-alone modulesInternal reference Front panel master-slave setups, one master per mainframe Front master, internal reference Front slave, phase locked to master AGE1439FRNTREARMSTREXTREF Rear master, phase locked to external reference Rear panel master-slave setups, one master per mainframeRear master, internal reference Front sync, external sample clock, wired-OR sync AGE1439REARSLAVEXTREF Multiple mainframe setups Send sync to slave ClockSetupPtr Functions listed alphabetically Receive sync from masterExample Effect on Active Measurement ViStatus age1439closeViSession id Age1439closeAGE1439SUCCESS indicates that a function was successful Age1439combosetup PhaseBlocksize Interpolate Age1439datamemsizeget Age1439datascaleget Age1439datasetup DataDelay DataDelayPtrData type BlocksizePtr Resolution ResolutionPtrDataTypePtr Mode Port Xfers Sequence FilterBW Age1439dataxfersize Xfersize XfersizePtr Age1439driverdebuglevel DebugLevel DebugLevelPtr Age1439epochsetup EpochGenerate HeaderEnable HeaderEnablePtrEpochSizePtr HeaderValue Option/fiberMode Off Append 101 Age1439errormessage ErrorMessage Age1439errorquery ErrorCode ErrorMessage Age1439extsamplesync SyncEnable SyncEnablePtrAge1439extsamplesyncget 105 ViStatus age1439fiberclearViSession id Description Age1439fiberclearParameter Age1439fibererrorclear ViStatus age1439fibererrorclearViSession id Age1439fibererrorget Definition Numeric Description Value 109 Age1439fiberLEDget LedRegPtr Age1439fiberrcvsignalsget Pio1 Pio2 Dir Nrdy Age1439fibersetup BofEnable BofEnablePtr crcEnable CrcEnablePtr fiberMode FibermodePtr FlowControlModeTransferRate TransferRatePtr Age1439fibersignalget FiberSignalPtr Age1439fiberverify VerifyPath Sec Age1439fiberxmtBOF ViStatus age1439fiberxmtBOFViSession id Age1439fiberxmtsignals Age1439fiberxmtsignalsget Decimate Age1439filtersetupDecimatePtr Be set SigBwPtrInvalid parameter combinations 25 dB 15 dB ViStatus age1439filtersyncViSession id Description Age1439filtersyncComment 124 Age1439frequencycenterraw Comments 126 Age1439frequencycenterrawcompute Age1439frequencysetup Age1439frequencycenter sets the center frequencyCenterFreq CenterFreqPtr Sync CmplxDCPtrSyncPtr 130 FpClock FpClockPtr Age1439frontpanelclockinputAge1439frontpanelclockinputget Age1439init IdQuery 133 Age1439inputautozero ViStatus age1439inputautozeroViSession id Description Age1439inputoffset Age1439inputoffsetsave ViStatus age1439inputoffsetsaveViSession id Age1439inputrangeauto Variable Range Index Age1439inputrangeconvertFull Scale Voltage Vp Full Scale DBm 140 Age1439inputsetup AntiAlias CouplingPtr Range Signal SignalPtrSignalPath SignalPathPtr 144 Age1439interruptrestore ViStatus age1439interruptrestoreViSession id Age1439interruptsetup Mask 147 Age1439lbusmode Pipeline LbusModePtr Age1439lbusreset ViStatus age1439lbusresetViSession id, ViInt16 lbusResetLbusReset LbusResetPtr Age1439meascontrol Idle Sync This function performs the following sequence 153 Age1439measinit ViStatus age1439measinitViSession id Description Age1439measstart Age1439measstatusget DefinitionReadValid BlockReady Age1439optionsget Options Age1439productidget ProductId Age1439read Checks for AGE1439STATUSREADBLOCK and AGE1439STATUS Data SampleCountOverloadPtr Read or age1439read64 function is this 161 Age1439readraw WordCount Call age1439measstart Call age1439readraw 164 RefClock RefClockPtr Age1439referenceclockAge1439referenceclockget RefPrescaler RefPrescalerPtr Age1439referenceprescalerAge1439referenceprescalerget Age1439reset ViStatus age1439resetViSession id Description Age1439resethard ViStatus age1439resethardViSession id Age1439revisionquery DriverRev InstrRev Error Age1439selftestTestMessage TestResult Message 171 SerialNum Age1439serialnumberAge1439serialnumberget SmbClock SmbClockPtr Age1439smbclockoutputAge1439smbclockoutputget Age1439staterecall Age1439staterecall#include age1439.h ViStatus age1439staterecallViSession id Age1439statesave Age1439statesaveViStatus age1439statesaveViSession id Description Age1439statusget Status Bit Definition Status Bit Definition Description AGE1439STATUSREADVALID SyncClock SyncClockPtr Age1439syncclockAge1439syncclockget SyncDirection SyncDirectionPtr Age1439syncdirectionAge1439syncdirectionget SyncOutput SyncOutputPtr Age1439syncoutputAge1439syncoutputget Age1439triggerdelayactualget ActualDelayPtr Age1439triggerphaseactualget ActualPhasePtr Age1439triggersetup Post trigger Bit realPre-trigger Frequencysetup function GenTrigPtrMagDwell MagDwellPtr TrigTypePtr VcxoState VcxoStatePtr Age1439vcxoAge1439vcxoget VxiClock VxiClockPtr Age1439vxiclockoutputAge1439vxiclockoutputget Age1439wait Equivalent numeric values for variables Equivalent numeric values for variablesVariable Name Numeric Value 191 192 193 194 195 196 197 Commands which halt active measurements Commands which halt active measurementsAge1439selftest age1439staterecall Error messages Error messagesParameter Description 200 Default values Default values Function VXIplug&play Syntax Quick Reference VXIplug&play Syntax Quick Reference Sage DacPtr 206 Module Description Front Panel Description Front Panel Description VXI backplane connections VXI backplane connections Trigger Lines Block diagram and description Block diagram and description Input DAC AC DC Clock Generation Anti-alias Filter Zoom and Decimation Filtering Sampling ADCMemory Controller and Sdram Memory Data Output Fiber Optic Interface Trigger Detection Control Registers 218 Replacing Assemblies Replaceable parts Replaceable partsOrdering Information Code Numbers Mfr. No Mfr. Name Location Installing to avoid damage Assemblies Part Number Replaceable parts Ref Des Agilent Part Qty DescriptionNumber To remove the top cover To remove the M1, M2 assemblies 226 Agilent Technologies Sales Office Fiber frame that acts as a synchronizing eventFiber frame that contains the last 4 data bytes in an epoch Front panel data port 228 Index Index Raw data, scaling 231 VME VXI 234 Need Assistance? About this edition