Functions
EXPORT int	PwrSnsr_GetBufferedAverageMeasurements (SessionID Vi, const char Channel, int ValBufferSize, float Val[], int ValActualSize)
	Get the average power measurements that were captured during the last call to AcquireMeasurements. More...

EXPORT int	PwrSnsr_AcquireMeasurements (SessionID Vi, double Timeout, int Count, PwrSnsrMeasBuffStopReasonEnum StopReason, int Val)
	Initiates new acquisition from the measurement buffer system (if acquisition is in the stopped state). Blocks until the number of measurements for each enabled channel is equal to count, or a time out has occurred. More...

EXPORT int	PwrSnsr_GetMaxMeasurements (SessionID Vi, const char Channel, int ValBufferSize, float Val[], int ValActualSize)
	Get the maximum power measurements that were captured during the last call to AcquireMeasurements. More...

EXPORT int	PwrSnsr_GetMinMeasurements (SessionID Vi, const char Channel, int ValBufferSize, float Val[], int ValActualSize)
	Get the minimum power measurements that were captured during the last call to AcquireMeasurements. More...

EXPORT int	PwrSnsr_GetDuration (SessionID Vi, float *Duration)
	Get the time duration samples are captured during each timed mode acquisiton. More...

EXPORT int	PwrSnsr_SetDuration (SessionID Vi, float Duration)
	Set the duration samples are captured during each timed mode acquisition. More...

EXPORT int	PwrSnsr_GetSequenceNumbers (SessionID Vi, const char Channel, int ValBufferSize, unsigned int Val[], int ValActualSize)
	Get the sequence number entries that were captured during the last call to AcquireMeasurements. More...

EXPORT int	PwrSnsr_GetStartTimes (SessionID Vi, const char Channel, int ValBufferSize, double Val[], int ValActualSize)
	Get the start time entries in seconds that were captured during the last call to AcquireMeasurements. More...

EXPORT int	PwrSnsr_GetDurations (SessionID Vi, const char Channel, int ValBufferSize, float Val[], int ValActualSize)
	Get the duration entries in seconds that were captured during the last call to AcquireMeasurements. More...

EXPORT int	PwrSnsr_StartAcquisition (SessionID Vi)
	Starts measurement buffer acquisition. This method allows the user to send a command to the power meter to begin buffering measurements without waiting for all measurements to be completed. Alternately, you can call the AcquireReadings method to start buffering measurements and wait for them to be read from the meter. More...

EXPORT int	PwrSnsr_StopAcquisition (SessionID Vi)
	Sends a command to stop the measurement buffer from acquiring readings. More...

EXPORT int	PwrSnsr_ClearBuffer (SessionID Vi)
	Sends a command to the power meter to clear all buffered readings. This method does not clear cached measurements accessible through GetAverageMeasurements, etc. More...

EXPORT int	PwrSnsr_ClearMeasurements (SessionID Vi)
	Clears cached average, min, max, duration, start time, and sequence number measurements. More...

EXPORT int	PwrSnsr_GetMeasurementsAvailable (SessionID Vi, const char Channel, int Val)
	Get the number of measurement entries available that were captured during AcquireMeasurements(). More...

EXPORT int	PwrSnsr_SetPeriod (SessionID Vi, float Period)
	Set the period each timed mode acquisition (measurement buffer) is started. More...

EXPORT int	PwrSnsr_GetPeriod (SessionID Vi, float *Period)
	Get the period each timed mode acquisition (measurement buffer) is started. More...

EXPORT int	PwrSnsr_GetRdgsEnableFlag (SessionID Vi, int *Flag)
	Get the flag indicating which measurement buffer arrays will be read when calling PwrSnsr_AcquireMeasurements. More...

EXPORT int	PwrSnsr_SetRdgsEnableFlag (SessionID Vi, int Flag)
	Set the flag indicating which measurement buffer arrays will be read when calling PwrSnsr_AcquireMeasurements. More...

EXPORT int	PwrSnsr_GetGateMode (SessionID Vi, PwrSnsrMeasBuffGateEnum *GateMode)
	Each Measurement Buffer Entry is controlled by a buffer gate that defines the start and end of the entry time interval. The gate signal may be internally or externally generated in several different ways. More...

EXPORT int	PwrSnsr_SetGateMode (SessionID Vi, PwrSnsrMeasBuffGateEnum GateMode)
	Each Measurement Buffer Entry is controlled by a buffer gate that defines the start and end of the entry time interval. More...

EXPORT int	PwrSnsr_GetStartMode (SessionID Vi, PwrSnsrMeasBuffStartModeEnum *StartMode)
	Get the mode used to start acquisition of buffer entries. More...

EXPORT int	PwrSnsr_SetStartMode (SessionID Vi, PwrSnsrMeasBuffStartModeEnum StartMode)
	Set the mode used to start acquisition of buffer entries. More...

EXPORT int	PwrSnsr_AdvanceReadIndex (SessionID Vi)
	Send a command to the meter to notify it the user is done reading and to advance the read index. More...

EXPORT int	PwrSnsr_QueryAverageMeasurements (SessionID Vi, const char Channel, int ValBufferSize, float Val[], int ValActualSize)
	Query the power meter for all buffered average power measurements. More...

EXPORT int	PwrSnsr_QueryStartTimes (SessionID Vi, const char Channel, int ValBufferSize, float Val[], int ValActualSize)
	Query the power meter for all buffered start times in seconds. More...

EXPORT int	PwrSnsr_QuerySequenceNumbers (SessionID Vi, const char Channel, int ValBufferSize, unsigned int Val[], int ValActualSize)
	Query the power meter for all buffered sequence numbers. More...

EXPORT int	PwrSnsr_QueryDurations (SessionID Vi, const char Channel, int ValBufferSize, float Val[], int ValActualSize)
	Query the power meter for all buffered measurement durations in seconds. More...

EXPORT int	PwrSnsr_QueryMaxMeasurements (SessionID Vi, const char Channel, int ValBufferSize, float Val[], int ValActualSize)
	Query the power meter for all buffered maximum power measurements. More...

EXPORT int	PwrSnsr_QueryMinMeasurements (SessionID Vi, const char Channel, int ValBufferSize, float Val[], int ValActualSize)
	Query the power meter for all buffered minimum power measurements. More...

EXPORT int	PwrSnsr_GetWriteProtection (SessionID Vi, int *WriteProtection)
	Get whether the measurement buffer is set to overwrite members that have not been read by the user. More...

EXPORT int	PwrSnsr_GetTimedOut (SessionID Vi, int *TimedOut)
	Check if the last measurement buffer session timed out. More...

EXPORT int	PwrSnsr_GetSessionCount (SessionID Vi, int *SessionCount)
	Get the count of elements for this measurement buffer session. Set to 0 for the meter to continuously acquire measurements. More...

EXPORT int	PwrSnsr_SetSessionCount (SessionID Vi, int SessionCount)
	Set the count of elements for this measurement buffer session. Set to 0 for the meter to continuously acquire measurements. More...

EXPORT int	PwrSnsr_SetSessionTimeout (SessionID Vi, float Seconds)
	Set the count of elements for this measurement buffer session. Set to 0 for the meter to continuously acquire measurements. More...

EXPORT int	PwrSnsr_GetReturnCount (SessionID Vi, int *ReturnCount)
	Get the return count for each measurement query. More...

EXPORT int	PwrSnsr_SetReturnCount (SessionID Vi, int ReturnCount)
	Set the return count for each measurement query. More...

EXPORT int	PwrSnsr_SetWriteProtection (SessionID Vi, int WriteProtection)
	Set whether to allow the measurement buffer to overwrite entries that have not been read by the user. More...

EXPORT int	PwrSnsr_GetOverRan (SessionID Vi, int *OverRan)
	Get flag indicating whether the power meter's internal buffer filled up before being emptied. More...

EXPORT int	PwrSnsr_GetBufferedMeasurementsAvailable (SessionID Vi, int *MeasurementsAvailable)
	Gets the number of measurements available in the power meter's internal buffer. Note: The number of readings that have been acquired may be more or less. More...

EXPORT int	PwrSnsr_GetMeasBuffEnabled (SessionID Vi, int *MeasBuffEnabled)
	Get whether the measurement buffer has been enabled. More...

EXPORT int	PwrSnsr_SetMeasBuffEnabled (SessionID Vi, int MeasBuffEnabled)
	Enable or disable the measurement buffer. Disabling the measurement buffer enables modulated/CW measurements. Conversely, enabling it disables modulated/CW measurements. More...

EXPORT int	PwrSnsr_ResetContinuousCapture (SessionID Vi)
	Sets a flag indicating to restart continuous capture. This method allows the user to restart continuous acquisition. Has no effect if ContinuousCapture is set to false. More...

EXPORT int	PwrSnsr_GetEndDelay (SessionID Vi, float *EndDelay)
	Get delay time added to the detected end of a burst for analysis. Typically negative. Typically used to exclude the falling edge of a burst. More...

EXPORT int	PwrSnsr_SetEndDelay (SessionID Vi, float EndDelay)
	Set delay time added to the detected end of a burst for analysis. Typically negative. Typically used to exclude the falling edge of a burst. More...

EXPORT int	PwrSnsr_GetStartQual (SessionID Vi, float *StartQual)
	Get the minimum amount of time power remains above the trigger point to be counted as the beginning of a burst. More...

EXPORT int	PwrSnsr_SetStartQual (SessionID Vi, float StartQual)
	Set the minimum amount of time power remains above the trigger point to be counted as the beginning of a burst. More...

EXPORT int	PwrSnsr_GetStartDelay (SessionID Vi, float *StartDelay)
	Get delay time added to the detected beginning of a burst for analysis. Typically used to exclude the rising edge of a burst. More...

EXPORT int	PwrSnsr_SetStartDelay (SessionID Vi, float StartDelay)
	Set delay time added to the detected beginning of a burst for analysis. Typically used to exclude the rising edge of a burst. More...

EXPORT int	PwrSnsr_GetEndQual (SessionID Vi, float *EndQual)
	Get the minimum amount of time power remains below the trigger point to be counted as the end of a burst. More...

EXPORT int	PwrSnsr_SetEndQual (SessionID Vi, float EndQual)
	Set the minimum amount of time power remains below the trigger point to be counted as the end of a burst. More...

EXPORT int	PwrSnsr_SetContinuousCapture (SessionID Vi, int ContinuousCapture)
	Set whether AcquireMeasurements will stop the measurement buffer session or continue capturing measurement buffer entries after being called. More...

EXPORT int	PwrSnsr_GetContinuousCapture (SessionID Vi, int *ContinuousCapture)
	Get whether AcquireMeasurements will stop the measurement buffer session or continue capturing measurement buffer entries after being called. More...

Detailed Description

Measurement Buffer functions

Function Documentation

◆ PwrSnsr_AcquireMeasurements()

EXPORT int PwrSnsr_AcquireMeasurements	(	SessionID	Vi,
		double	Timeout,
		int	Count,
		PwrSnsrMeasBuffStopReasonEnum *	StopReason,
		int *	Val
	)

Initiates new acquisition from the measurement buffer system (if acquisition is in the stopped state). Blocks until the number of measurements for each enabled channel is equal to count, or a time out has occurred.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Timeout	Maximum time in seconds to continue acquiring samples. Negative values will be treated as infinite.
Count	Number of samples to acquire.
StopReason	Reason aqcuisition stopped.
Val	Number of samples acquired.

Returns: Success (0) or error code.

◆ PwrSnsr_AdvanceReadIndex()

EXPORT int PwrSnsr_AdvanceReadIndex ( SessionID Vi )

Send a command to the meter to notify it the user is done reading and to advance the read index.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.

Returns: Success (0) or error code.

◆ PwrSnsr_ClearBuffer()

EXPORT int PwrSnsr_ClearBuffer ( SessionID Vi )

Sends a command to the power meter to clear all buffered readings. This method does not clear cached measurements accessible through GetAverageMeasurements, etc.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.

Returns: Success (0) or error code.

◆ PwrSnsr_ClearMeasurements()

EXPORT int PwrSnsr_ClearMeasurements ( SessionID Vi )

Clears cached average, min, max, duration, start time, and sequence number measurements.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.

Returns: Success (0) or error code.

◆ PwrSnsr_GetBufferedAverageMeasurements()

EXPORT int PwrSnsr_GetBufferedAverageMeasurements	(	SessionID	Vi,
		const char *	Channel,
		int	ValBufferSize,
		float	Val[],
		int *	ValActualSize
	)

Get the average power measurements that were captured during the last call to AcquireMeasurements.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Channel	Channel number. For single instruments, set this to "CH1".
ValBufferSize	Buffer size of Val.
Val	Array of average measurements.
ValActualSize	Actual size of Val.

Returns: Success (0) or error code.

◆ PwrSnsr_GetBufferedMeasurementsAvailable()

EXPORT int PwrSnsr_GetBufferedMeasurementsAvailable	(	SessionID	Vi,
		int *	MeasurementsAvailable
	)

Gets the number of measurements available in the power meter's internal buffer. Note: The number of readings that have been acquired may be more or less.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
MeasurementsAvailable	The number of measurements available in the power meter's internal buffer. Note: The number of readings that have been acquired may be more or less.

Returns: Success (0) or error code.

◆ PwrSnsr_GetContinuousCapture()

EXPORT int PwrSnsr_GetContinuousCapture	(	SessionID	Vi,
		int *	ContinuousCapture
	)

Get whether AcquireMeasurements will stop the measurement buffer session or continue capturing measurement buffer entries after being called.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ContinuousCapture	True if AcquireMeasurements will stop the measurement buffer session or continue capturing measurement buffer entries after being called.

Returns: Success (0) or error code.

◆ PwrSnsr_GetDuration()

EXPORT int PwrSnsr_GetDuration	(	SessionID	Vi,
		float *	Duration
	)

Get the time duration samples are captured during each timed mode acquisiton.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Duration	The duration in seconds samples are captured during each timed mode acquisiton.

Returns: Success (0) or error code.

◆ PwrSnsr_GetDurations()

EXPORT int PwrSnsr_GetDurations	(	SessionID	Vi,
		const char *	Channel,
		int	ValBufferSize,
		float	Val[],
		int *	ValActualSize
	)

Get the duration entries in seconds that were captured during the last call to AcquireMeasurements.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Channel	Channel number. For single instruments, set this to "CH1".
ValBufferSize	Size of the buffer.
Val	Array of measurement durations in seconds.
ValActualSize	Actual size of the returned buffer.

Returns: Success (0) or error code.

◆ PwrSnsr_GetEndDelay()

EXPORT int PwrSnsr_GetEndDelay	(	SessionID	Vi,
		float *	EndDelay
	)

Get delay time added to the detected end of a burst for analysis. Typically negative. Typically used to exclude the falling edge of a burst.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
EndDelay	The delay time added to the detected end of a burst for analysis.

Returns: Success (0) or error code.

◆ PwrSnsr_GetEndQual()

EXPORT int PwrSnsr_GetEndQual	(	SessionID	Vi,
		float *	EndQual
	)

Get the minimum amount of time power remains below the trigger point to be counted as the end of a burst.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
EndQual	The minimum amount of time power remains below the trigger point to be counted as the end of a burst.

Returns: Success (0) or error code.

◆ PwrSnsr_GetGateMode()

EXPORT int PwrSnsr_GetGateMode	(	SessionID	Vi,
		PwrSnsrMeasBuffGateEnum *	GateMode
	)

Each Measurement Buffer Entry is controlled by a buffer gate that defines the start and end of the entry time interval. The gate signal may be internally or externally generated in several different ways.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
GateMode	Buffer gate mode that defines the start and end of the entry time interval.

Returns: Success (0) or error code.

◆ PwrSnsr_GetMaxMeasurements()

EXPORT int PwrSnsr_GetMaxMeasurements	(	SessionID	Vi,
		const char *	Channel,
		int	ValBufferSize,
		float	Val[],
		int *	ValActualSize
	)

Get the maximum power measurements that were captured during the last call to AcquireMeasurements.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Channel	Channel number. For single instruments, set this to "CH1".
ValBufferSize	Size of the buffer.
Val	Array of max measurements.
ValActualSize	Actual size of the returned array in elements.

Returns: Success (0) or error code.

◆ PwrSnsr_GetMeasBuffEnabled()

EXPORT int PwrSnsr_GetMeasBuffEnabled	(	SessionID	Vi,
		int *	MeasBuffEnabled
	)

Get whether the measurement buffer has been enabled.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
MeasBuffEnabled	True if measurement buffer is enabled.

Returns: Success (0) or error code.

◆ PwrSnsr_GetMeasurementsAvailable()

EXPORT int PwrSnsr_GetMeasurementsAvailable	(	SessionID	Vi,
		const char *	Channel,
		int *	Val
	)

Get the number of measurement entries available that were captured during AcquireMeasurements().

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Channel	Channel number. For single instruments, set this to "CH1".
Val	Number of measurement entries available.

Returns: Success (0) or error code.

◆ PwrSnsr_GetMinMeasurements()

EXPORT int PwrSnsr_GetMinMeasurements	(	SessionID	Vi,
		const char *	Channel,
		int	ValBufferSize,
		float	Val[],
		int *	ValActualSize
	)

Get the minimum power measurements that were captured during the last call to AcquireMeasurements.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Channel	Channel number. For single instruments, set this to "CH1".
ValBufferSize	Size of the buffer.
Val	Array of min measurements.
ValActualSize	Actual size of the returned array in elements.

Returns: Success (0) or error code.

◆ PwrSnsr_GetOverRan()

EXPORT int PwrSnsr_GetOverRan	(	SessionID	Vi,
		int *	OverRan
	)

Get flag indicating whether the power meter's internal buffer filled up before being emptied.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
OverRan	True if the power meter's internal buffer filled up before being emptied.

Returns: Success (0) or error code.

◆ PwrSnsr_GetPeriod()

EXPORT int PwrSnsr_GetPeriod	(	SessionID	Vi,
		float *	Period
	)

Get the period each timed mode acquisition (measurement buffer) is started.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Period	The period in seconds each timed mode acquisition is started.

Returns: Success (0) or error code.

◆ PwrSnsr_GetRdgsEnableFlag()

EXPORT int PwrSnsr_GetRdgsEnableFlag	(	SessionID	Vi,
		int *	Flag
	)

Get the flag indicating which measurement buffer arrays will be read when calling PwrSnsr_AcquireMeasurements.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Flag	Bit masked value indicating which measurement arrays will be queried (see PwrSnsrRdgsEnableFlag).

Returns: Success (0) or error code.

◆ PwrSnsr_GetReturnCount()

EXPORT int PwrSnsr_GetReturnCount	(	SessionID	Vi,
		int *	ReturnCount
	)

Get the return count for each measurement query.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ReturnCount	The return count for each measurement query.

Returns: Success (0) or error code.

◆ PwrSnsr_GetSequenceNumbers()

EXPORT int PwrSnsr_GetSequenceNumbers	(	SessionID	Vi,
		const char *	Channel,
		int	ValBufferSize,
		unsigned int	Val[],
		int *	ValActualSize
	)

Get the sequence number entries that were captured during the last call to AcquireMeasurements.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Channel	Channel number. For single instruments, set this to "CH1".
ValBufferSize	Size of the buffer.
Val	Array of sequence numbers.
ValActualSize	Actual size of the returned array in elements.

Returns: Success (0) or error code.

◆ PwrSnsr_GetSessionCount()

EXPORT int PwrSnsr_GetSessionCount	(	SessionID	Vi,
		int *	SessionCount
	)

Get the count of elements for this measurement buffer session. Set to 0 for the meter to continuously acquire measurements.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
SessionCount	Get the count of elements for this measurement buffer session. Set to 0 for the meter to continuously acquire measurements.

Returns: Success (0) or error code.

◆ PwrSnsr_GetStartDelay()

EXPORT int PwrSnsr_GetStartDelay	(	SessionID	Vi,
		float *	StartDelay
	)

Get delay time added to the detected beginning of a burst for analysis. Typically used to exclude the rising edge of a burst.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
StartDelay	Delay time in seconds added to the detected beginning of a burst for analysis.

Returns: Success (0) or error code.

◆ PwrSnsr_GetStartMode()

EXPORT int PwrSnsr_GetStartMode	(	SessionID	Vi,
		PwrSnsrMeasBuffStartModeEnum *	StartMode
	)

Get the mode used to start acquisition of buffer entries.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
StartMode	Mode used to start acquisition of buffer entries.

Returns: Success (0) or error code.

◆ PwrSnsr_GetStartQual()

EXPORT int PwrSnsr_GetStartQual	(	SessionID	Vi,
		float *	StartQual
	)

Get the minimum amount of time power remains above the trigger point to be counted as the beginning of a burst.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
StartQual	The minimum amount of time power remains above the trigger point to be counted as the beginning of a burst.

Returns: Success (0) or error code.

◆ PwrSnsr_GetStartTimes()

EXPORT int PwrSnsr_GetStartTimes	(	SessionID	Vi,
		const char *	Channel,
		int	ValBufferSize,
		double	Val[],
		int *	ValActualSize
	)

Get the start time entries in seconds that were captured during the last call to AcquireMeasurements.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Channel	Channel number. For single instruments, set this to "CH1".
ValBufferSize	Size of the buffer.
Val	Array of start times.
ValActualSize	Actual size of the returned array in elements.

Returns: Success (0) or error code.

◆ PwrSnsr_GetTimedOut()

EXPORT int PwrSnsr_GetTimedOut	(	SessionID	Vi,
		int *	TimedOut
	)

Check if the last measurement buffer session timed out.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
TimedOut	True if the last measurement buffer session timed out.

Returns: Success (0) or error code.

◆ PwrSnsr_GetWriteProtection()

EXPORT int PwrSnsr_GetWriteProtection	(	SessionID	Vi,
		int *	WriteProtection
	)

Get whether the measurement buffer is set to overwrite members that have not been read by the user.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
WriteProtection	Returns trueif the measurement buffer is allowed to overwrite members that have not been read by the user.

Returns: Success (0) or error code.

◆ PwrSnsr_QueryAverageMeasurements()

EXPORT int PwrSnsr_QueryAverageMeasurements	(	SessionID	Vi,
		const char *	Channel,
		int	ValBufferSize,
		float	Val[],
		int *	ValActualSize
	)

Query the power meter for all buffered average power measurements.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Channel	Channel number. For single instruments, set this to "CH1".
ValBufferSize	Size of the buffer in elements.
Val	Array of average power measurements.
ValActualSize	Actual size of the returned array in elements.

Returns: Success (0) or error code.

◆ PwrSnsr_QueryDurations()

EXPORT int PwrSnsr_QueryDurations	(	SessionID	Vi,
		const char *	Channel,
		int	ValBufferSize,
		float	Val[],
		int *	ValActualSize
	)

Query the power meter for all buffered measurement durations in seconds.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Channel	Channel number. For single instruments, set this to "CH1".
ValBufferSize	Size of the buffer.
Val	Array of buffered measurement durations.
ValActualSize	Actual size of the returned array in elements.

Returns: Success (0) or error code.

◆ PwrSnsr_QueryMaxMeasurements()

EXPORT int PwrSnsr_QueryMaxMeasurements	(	SessionID	Vi,
		const char *	Channel,
		int	ValBufferSize,
		float	Val[],
		int *	ValActualSize
	)

Query the power meter for all buffered maximum power measurements.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Channel	Channel number. For single instruments, set this to "CH1".
ValBufferSize	Size of the buffer.
Val	Array of max measurements.
ValActualSize	Actual size of the returned array in elements.

Returns: Success (0) or error code.

◆ PwrSnsr_QueryMinMeasurements()

EXPORT int PwrSnsr_QueryMinMeasurements	(	SessionID	Vi,
		const char *	Channel,
		int	ValBufferSize,
		float	Val[],
		int *	ValActualSize
	)

Query the power meter for all buffered minimum power measurements.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Channel	Channel number. For single instruments, set this to "CH1".
ValBufferSize	Size of the buffer.
Val	Array of min measurements.
ValActualSize	Actual size of the returned array in elements.

Returns: Success (0) or error code.

◆ PwrSnsr_QuerySequenceNumbers()

EXPORT int PwrSnsr_QuerySequenceNumbers	(	SessionID	Vi,
		const char *	Channel,
		int	ValBufferSize,
		unsigned int	Val[],
		int *	ValActualSize
	)

Query the power meter for all buffered sequence numbers.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Channel	Channel number. For single instruments, set this to "CH1".
ValBufferSize	Size of the buffer.
Val	Array of sequence numbers.
ValActualSize	Actual size of the returned array in elements.

Returns: Success (0) or error code.

◆ PwrSnsr_QueryStartTimes()

EXPORT int PwrSnsr_QueryStartTimes	(	SessionID	Vi,
		const char *	Channel,
		int	ValBufferSize,
		float	Val[],
		int *	ValActualSize
	)

Query the power meter for all buffered start times in seconds.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Channel	Channel number. For single instruments, set this to "CH1".
ValBufferSize	Size of the buffer.
Val	Array of start times in seconds.
ValActualSize	Actual size of the returned array in elements.

Returns: Success (0) or error code.

◆ PwrSnsr_ResetContinuousCapture()

EXPORT int PwrSnsr_ResetContinuousCapture ( SessionID Vi )

Sets a flag indicating to restart continuous capture. This method allows the user to restart continuous acquisition. Has no effect if ContinuousCapture is set to false.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.

Returns: Success (0) or error code.

◆ PwrSnsr_SetContinuousCapture()

EXPORT int PwrSnsr_SetContinuousCapture	(	SessionID	Vi,
		int	ContinuousCapture
	)

Set whether AcquireMeasurements will stop the measurement buffer session or continue capturing measurement buffer entries after being called.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ContinuousCapture	True to set whether AcquireMeasurements will stop the measurement buffer session or continue capturing measurement buffer entries after being called.

Returns: Success (0) or error code.

◆ PwrSnsr_SetDuration()

EXPORT int PwrSnsr_SetDuration	(	SessionID	Vi,
		float	Duration
	)

Set the duration samples are captured during each timed mode acquisition.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Duration	The duration samples are captured during each timed mode acquisition in seconds.

Returns: Success (0) or error code.

◆ PwrSnsr_SetEndDelay()

EXPORT int PwrSnsr_SetEndDelay	(	SessionID	Vi,
		float	EndDelay
	)

Set delay time added to the detected end of a burst for analysis. Typically negative. Typically used to exclude the falling edge of a burst.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
EndDelay	Delay time added to the detected end of a burst for analysis.

Returns: Success (0) or error code.

◆ PwrSnsr_SetEndQual()

EXPORT int PwrSnsr_SetEndQual	(	SessionID	Vi,
		float	EndQual
	)

Set the minimum amount of time power remains below the trigger point to be counted as the end of a burst.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
EndQual	The minimum amount of time power remains below the trigger point to be counted as the end of a burst.

Returns: Success (0) or error code.

◆ PwrSnsr_SetGateMode()

EXPORT int PwrSnsr_SetGateMode	(	SessionID	Vi,
		PwrSnsrMeasBuffGateEnum	GateMode
	)

Each Measurement Buffer Entry is controlled by a buffer gate that defines the start and end of the entry time interval.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
GateMode	Buffer gate mode that defines the start and end of the entry time interval.

Returns: Success (0) or error code.

◆ PwrSnsr_SetMeasBuffEnabled()

EXPORT int PwrSnsr_SetMeasBuffEnabled	(	SessionID	Vi,
		int	MeasBuffEnabled
	)

Enable or disable the measurement buffer. Disabling the measurement buffer enables modulated/CW measurements. Conversely, enabling it disables modulated/CW measurements.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
MeasBuffEnabled	True to enable measurement buffer, false to disable.

Returns: Success (0) or error code.

◆ PwrSnsr_SetPeriod()

EXPORT int PwrSnsr_SetPeriod	(	SessionID	Vi,
		float	Period
	)

Set the period each timed mode acquisition (measurement buffer) is started.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Period	The period in seconds each timed mode acquisition is started.

Returns: Success (0) or error code.

◆ PwrSnsr_SetRdgsEnableFlag()

EXPORT int PwrSnsr_SetRdgsEnableFlag	(	SessionID	Vi,
		int	Flag
	)

Set the flag indicating which measurement buffer arrays will be read when calling PwrSnsr_AcquireMeasurements.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Flag	Bit masked value indicating which measurement arrays will be queried (see PwrSnsrRdgsEnableFlag).

Returns: Success (0) or error code.

◆ PwrSnsr_SetReturnCount()

EXPORT int PwrSnsr_SetReturnCount	(	SessionID	Vi,
		int	ReturnCount
	)

Set the return count for each measurement query.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ReturnCount	The return count for each measurement query.

Returns: Success (0) or error code.

◆ PwrSnsr_SetSessionCount()

EXPORT int PwrSnsr_SetSessionCount	(	SessionID	Vi,
		int	SessionCount
	)

Set the count of elements for this measurement buffer session. Set to 0 for the meter to continuously acquire measurements.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
SessionCount	Set the count of elements for this measurement buffer session. Set to 0 for the meter to continuously acquire measurements.

Returns: Success (0) or error code.

◆ PwrSnsr_SetSessionTimeout()

EXPORT int PwrSnsr_SetSessionTimeout	(	SessionID	Vi,
		float	Seconds
	)

Set the count of elements for this measurement buffer session. Set to 0 for the meter to continuously acquire measurements.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Seconds	Set the time out value. Values less than or equal to 0 will be treated as infinite. Valid range : 0.001 to 1000

Returns: Success (0) or error code.

◆ PwrSnsr_SetStartDelay()

EXPORT int PwrSnsr_SetStartDelay	(	SessionID	Vi,
		float	StartDelay
	)

Set delay time added to the detected beginning of a burst for analysis. Typically used to exclude the rising edge of a burst.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
StartDelay	Delay time in seconds added to the detected beginning of a burst for analysis.

Returns: Success (0) or error code.

◆ PwrSnsr_SetStartMode()

EXPORT int PwrSnsr_SetStartMode	(	SessionID	Vi,
		PwrSnsrMeasBuffStartModeEnum	StartMode
	)

Set the mode used to start acquisition of buffer entries.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
StartMode	Mode used to start acquisition of buffer entries.

Returns: Success (0) or error code.

◆ PwrSnsr_SetStartQual()

EXPORT int PwrSnsr_SetStartQual	(	SessionID	Vi,
		float	StartQual
	)

Set the minimum amount of time power remains above the trigger point to be counted as the beginning of a burst.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
StartQual	The minimum amount of time power remains above the trigger point to be counted as the beginning of a burst.

Returns: Success (0) or error code.

◆ PwrSnsr_SetWriteProtection()

EXPORT int PwrSnsr_SetWriteProtection	(	SessionID	Vi,
		int	WriteProtection
	)

Set whether to allow the measurement buffer to overwrite entries that have not been read by the user.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
WriteProtection	Set false to allow the measurement buffer to overwrite entries that have not been read by the user.

Returns: Success (0) or error code.

◆ PwrSnsr_StartAcquisition()

EXPORT int PwrSnsr_StartAcquisition ( SessionID Vi )

Starts measurement buffer acquisition. This method allows the user to send a command to the power meter to begin buffering measurements without waiting for all measurements to be completed. Alternately, you can call the AcquireReadings method to start buffering measurements and wait for them to be read from the meter.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.

Returns: Success (0) or error code.

◆ PwrSnsr_StopAcquisition()

EXPORT int PwrSnsr_StopAcquisition ( SessionID Vi )

Sends a command to stop the measurement buffer from acquiring readings.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.

Returns: Success (0) or error code.

Functions

Detailed Description

Function Documentation

◆ PwrSnsr_AcquireMeasurements()

◆ PwrSnsr_AdvanceReadIndex()

◆ PwrSnsr_ClearBuffer()

◆ PwrSnsr_ClearMeasurements()

◆ PwrSnsr_GetBufferedAverageMeasurements()

◆ PwrSnsr_GetBufferedMeasurementsAvailable()

◆ PwrSnsr_GetContinuousCapture()

◆ PwrSnsr_GetDuration()

◆ PwrSnsr_GetDurations()

◆ PwrSnsr_GetEndDelay()

◆ PwrSnsr_GetEndQual()

◆ PwrSnsr_GetGateMode()

◆ PwrSnsr_GetMaxMeasurements()

◆ PwrSnsr_GetMeasBuffEnabled()

◆ PwrSnsr_GetMeasurementsAvailable()

◆ PwrSnsr_GetMinMeasurements()

◆ PwrSnsr_GetOverRan()

◆ PwrSnsr_GetPeriod()

◆ PwrSnsr_GetRdgsEnableFlag()

◆ PwrSnsr_GetReturnCount()

◆ PwrSnsr_GetSequenceNumbers()

◆ PwrSnsr_GetSessionCount()

◆ PwrSnsr_GetStartDelay()

◆ PwrSnsr_GetStartMode()

◆ PwrSnsr_GetStartQual()

◆ PwrSnsr_GetStartTimes()

◆ PwrSnsr_GetTimedOut()

◆ PwrSnsr_GetWriteProtection()

◆ PwrSnsr_QueryAverageMeasurements()

◆ PwrSnsr_QueryDurations()

◆ PwrSnsr_QueryMaxMeasurements()

◆ PwrSnsr_QueryMinMeasurements()

◆ PwrSnsr_QuerySequenceNumbers()

◆ PwrSnsr_QueryStartTimes()

◆ PwrSnsr_ResetContinuousCapture()

◆ PwrSnsr_SetContinuousCapture()

◆ PwrSnsr_SetDuration()

◆ PwrSnsr_SetEndDelay()

◆ PwrSnsr_SetEndQual()

◆ PwrSnsr_SetGateMode()

◆ PwrSnsr_SetMeasBuffEnabled()

◆ PwrSnsr_SetPeriod()

◆ PwrSnsr_SetRdgsEnableFlag()

◆ PwrSnsr_SetReturnCount()

◆ PwrSnsr_SetSessionCount()

◆ PwrSnsr_SetSessionTimeout()

◆ PwrSnsr_SetStartDelay()

◆ PwrSnsr_SetStartMode()

◆ PwrSnsr_SetStartQual()

◆ PwrSnsr_SetWriteProtection()

◆ PwrSnsr_StartAcquisition()

◆ PwrSnsr_StopAcquisition()