RTP Series API Programming Reference  1.2.1
Acquisition

Functions

EXPORT int PwrSnsr_Abort (SessionID Vi)
 Terminates any measurement in progress and resets the state of the trigger system. Note that Abort will leave the measurement in a stopped condition with all current measurements cleared. More...
 
EXPORT int PwrSnsr_FetchExtendedWaveform (SessionID Vi, const char *Channel, int WaveformArrayBufferSize, float WaveformArray[], int *WaveformArrayActualSize, int Count)
 When capture priority is enabled, returns up to 100000 points of trace data based on the current timebase starting at the current trigger delay point. More...
 
EXPORT int PwrSnsr_Clear (SessionID Vi)
 Clear all data buffers. Clears averaging filters to empty. More...
 
EXPORT int PwrSnsr_InitiateAquisition (SessionID Vi)
 Starts a single measurement cycle when INITiate:CONTinuous is set to OFF. More...
 
EXPORT int PwrSnsr_Status (SessionID Vi, PwrSnsrAcquisitionStatusEnum *Val)
 Returns whether an acquisition is in progress, complete, or if the status is unknown. More...
 
EXPORT int PwrSnsr_SetInitiateContinuous (SessionID Vi, int InitiateContinuous)
 Set the data acquisition mode for single or free-run measurements. More...
 
EXPORT int PwrSnsr_GetInitiateContinuous (SessionID Vi, int *InitiateContinuous)
 Get the data acquisition mode for single or free-run measurements. More...
 
EXPORT int PwrSnsr_EnableCapturePriority (SessionID Vi, const char *Channel, int Enabled)
 Sets the 55 series power meter to a buffered capture mode and disables real time processing. More...
 

Detailed Description

Acquisition related functions

Function Documentation

◆ PwrSnsr_Abort()

EXPORT int PwrSnsr_Abort ( SessionID  Vi)

Terminates any measurement in progress and resets the state of the trigger system. Note that Abort will leave the measurement in a stopped condition with all current measurements cleared.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Returns
Success (0) or error code.

◆ PwrSnsr_Clear()

EXPORT int PwrSnsr_Clear ( SessionID  Vi)

Clear all data buffers. Clears averaging filters to empty.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Returns
Success (0) or error code.

◆ PwrSnsr_EnableCapturePriority()

EXPORT int PwrSnsr_EnableCapturePriority ( SessionID  Vi,
const char *  Channel,
int  Enabled 
)

Sets the 55 series power meter to a buffered capture mode and disables real time processing.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
EnabledIf set to 1, enables buffered mode. If set to zero, disables capture priority(default).
Returns
Success (0) or error code.

◆ PwrSnsr_FetchExtendedWaveform()

EXPORT int PwrSnsr_FetchExtendedWaveform ( SessionID  Vi,
const char *  Channel,
int  WaveformArrayBufferSize,
float  WaveformArray[],
int *  WaveformArrayActualSize,
int  Count 
)

When capture priority is enabled, returns up to 100000 points of trace data based on the current timebase starting at the current trigger delay point.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
WaveformArrayBufferSizeNumber of elements in the WaveformArray buffer
WaveformArrayWaveform buffer.
WaveformArrayActualSizeNumber of elements updated with data.
CountNumber of points to capture.
Returns
Success (0) or error code.

◆ PwrSnsr_GetInitiateContinuous()

EXPORT int PwrSnsr_GetInitiateContinuous ( SessionID  Vi,
int *  InitiateContinuous 
)

Get the data acquisition mode for single or free-run measurements.

If INITiate:CONTinuous is set to ON, the instrument immediately begins taking measurements (Modulated, CW and Statistical Modes), or arms its trigger and takes a measurement each time a trigger occurs (Pulse Mode). If set to OFF, the measurement will begin (or be armed) as soon as the INITiate command is issued, and will stop once the measurement criteria (averaging, filtering or sample count) has been satisfied. Note that INITiate:IMMediate and READ commands are invalid when INITiate:CONTinuous is set to ON; however, by convention this situation does not result in a SCPI error.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
InitiateContinuousBoolean. 0 for off or 1 for on.
Returns
Success (0) or error code.

◆ PwrSnsr_InitiateAquisition()

EXPORT int PwrSnsr_InitiateAquisition ( SessionID  Vi)

Starts a single measurement cycle when INITiate:CONTinuous is set to OFF.

In Modulated Mode, the measurement will complete once the power has been integrated for the full FILTer time. In Pulse Mode, enough trace sweeps must be triggered to satisfy the AVERaging setting. In Statistical Mode, acquisition stops once the terminal condition(s) are met. In each case, no reading will be returned until the measurement is complete. This command is not valid when INITiate:CONTinuous is ON, however, by convention this situation does not result in a SCPI error

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Returns
Success (0) or error code.

◆ PwrSnsr_SetInitiateContinuous()

EXPORT int PwrSnsr_SetInitiateContinuous ( SessionID  Vi,
int  InitiateContinuous 
)

Set the data acquisition mode for single or free-run measurements.

If INITiate:CONTinuous is set to ON, the instrument immediately begins taking measurements (Modulated, CW and Statistical Modes), or arms its trigger and takes a measurement each time a trigger occurs (Pulse Mode). If set to OFF, the measurement will begin (or be armed) as soon as the INITiate command is issued, and will stop once the measurement criteria (averaging, filtering or sample count) has been satisfied. Note that INITiate:IMMediate and READ commands are invalid when INITiate:CONTinuous is set to ON; however, by convention this situation does not result in a SCPI error.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
InitiateContinuousBoolean. 0 for off or 1 for on.
Returns
Success (0) or error code.

◆ PwrSnsr_Status()

EXPORT int PwrSnsr_Status ( SessionID  Vi,
PwrSnsrAcquisitionStatusEnum Val 
)

Returns whether an acquisition is in progress, complete, or if the status is unknown.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ValStatus out parameter.
Returns
Success (0) or error code.