Functions
EXPORT int	PwrSnsr_GetChannelByIndex (SessionID Vi, int BuffSize, char Channel[], int Index)
	Gets the channel name by zero index. Note: SCPI commands use a one-based index. More...

EXPORT int	PwrSnsr_GetEnabled (SessionID Vi, const char Channel, int Enabled)
	Get the measurement state of the selected channel. When the value is true, the channel performs measurements; when the value is false, the channel is disabled and no measurements are performed. More...

EXPORT int	PwrSnsr_SetEnabled (SessionID Vi, const char *Channel, int Enabled)
	Get the measurement state of the selected channel. When the value is true, the channel performs measurements; when the value is false, the channel is disabled and no measurements are performed. More...

EXPORT int	PwrSnsr_GetSerialNumber (SessionID Vi, const char *Channel, int SerialNumberBufferSize, char SerialNumber[])
	Gets the serial number of the sensor. More...

EXPORT int	PwrSnsr_GetChannelCount (SessionID Vi, int *Count)
	Get number of channels. More...

EXPORT int	PwrSnsr_GetUnits (SessionID Vi, const char Channel, PwrSnsrUnitsEnum Units)
	Get units for the selected channel. More...

EXPORT int	PwrSnsr_SetUnits (SessionID Vi, const char *Channel, PwrSnsrUnitsEnum Units)
	Set units for the selected channel. More...

EXPORT int	PwrSnsr_GetCurrentTemp (SessionID Vi, const char Channel, double CurrentTemp)
	Get current sensor internal temperature in degrees C. More...

EXPORT int	PwrSnsr_GetAverage (SessionID Vi, const char Channel, int Average)
	Get the number of traces averaged together to form the measurement result on the selected channel. More...

EXPORT int	PwrSnsr_SetAverage (SessionID Vi, const char *Channel, int Average)
	Set the number of traces averaged together to form the measurement result on the selected channel. More...

EXPORT int	PwrSnsr_GetBandwidth (SessionID Vi, const char Channel, PwrSnsrBandwidthEnum Bandwidth)
	Get the sensor video bandwidth for the selected sensor. More...

EXPORT int	PwrSnsr_SetBandwidth (SessionID Vi, const char *Channel, PwrSnsrBandwidthEnum Bandwidth)
	Set the sensor video bandwidth for the selected sensor. More...

EXPORT int	PwrSnsr_GetFilterState (SessionID Vi, const char Channel, PwrSnsrFilterStateEnum FilterState)
	Get the current setting of the integration filter on the selected channel. More...

EXPORT int	PwrSnsr_SetFilterState (SessionID Vi, const char *Channel, PwrSnsrFilterStateEnum FilterState)
	Set the current setting of the integration filter on the selected channel. More...

EXPORT int	PwrSnsr_GetFilterTime (SessionID Vi, const char Channel, float FilterTime)
	Get the current length of the integration filter on the selected channel. More...

EXPORT int	PwrSnsr_SetFilterTime (SessionID Vi, const char *Channel, float FilterTime)
	Set the current length of the integration filter on the selected channel. More...

EXPORT int	PwrSnsr_GetIsAvgSensor (SessionID Vi, const char Channel, int IsAvgSensor)
	Retruns true if sensor is average responding (not peak detecting). More...

EXPORT int	PwrSnsr_GetDistal (SessionID Vi, const char Channel, float Distal)
	Get the pulse amplitude percentage, which is used to define the end of a rising edge or beginning of a falling edge transition. More...

EXPORT int	PwrSnsr_SetDistal (SessionID Vi, const char *Channel, float Distal)
	Set the pulse amplitude percentage, which is used to define the end of a rising edge or beginning of a falling edge transition. More...

EXPORT int	PwrSnsr_GetEndGate (SessionID Vi, const char Channel, float EndGate)
	Get the point on a pulse, which is used to define the end of the pulse's active interval. More...

EXPORT int	PwrSnsr_SetEndGate (SessionID Vi, const char *Channel, float EndGate)
	Set the point on a pulse, which is used to define the end of the pulse's active interval. More...

EXPORT int	PwrSnsr_GetMesial (SessionID Vi, const char Channel, float Mesial)
	Get the pulse amplitude percentage, which is used to define the midpoint of a rising edge or end of a falling edge transition. More...

EXPORT int	PwrSnsr_SetMesial (SessionID Vi, const char *Channel, float Mesial)
	Set the pulse amplitude percentage, which is used to define the midpoint of a rising edge or end of a falling edge transition. More...

EXPORT int	PwrSnsr_GetProximal (SessionID Vi, const char Channel, float Proximal)
	Get the pulse amplitude percentage, which is used to define the beginning of a rising edge or end of a falling edge transition. More...

EXPORT int	PwrSnsr_SetProximal (SessionID Vi, const char *Channel, float Proximal)
	Set the pulse amplitude percentage, which is used to define the beginning of a rising edge or end of a falling edge transition. More...

EXPORT int	PwrSnsr_GetPulseUnits (SessionID Vi, const char Channel, PwrSnsrPulseUnitsEnum Units)
	Get the units for entering the pulse distal, mesial and proximal levels. More...

EXPORT int	PwrSnsr_SetPulseUnits (SessionID Vi, const char *Channel, PwrSnsrPulseUnitsEnum PwrSnsrPulseUnitsEnum)
	Set the units for entering the pulse distal, mesial and proximal levels. More...

EXPORT int	PwrSnsr_GetStartGate (SessionID Vi, const char Channel, float StartGate)
	Get the point on a pulse, which is used to define the beginning of the pulse's active interval. More...

EXPORT int	PwrSnsr_SetStartGate (SessionID Vi, const char *Channel, float StartGate)
	Set the point on a pulse, which is used to define the beginning of the pulse's active interval. More...

EXPORT int	PwrSnsr_GetCalFactors (SessionID Vi, const char Channel, float MaxFrequency, float MinFrequency, int FrequencyListBufferSize, float FrequencyList[], int FrequencyListActualSize, int CalFactorListBufferSize, float CalFactorList[], int *CalFactorListActualSize, PwrSnsrBandwidthEnum Bandwidth)
	Query information associated with calibration factors. More...

EXPORT int	PwrSnsr_GetCalFactor (SessionID Vi, const char Channel, float CalFactor)
	Get the frequency calibration factor currently in use on the selected channel. More...

EXPORT int	PwrSnsr_SetCalFactor (SessionID Vi, const char *Channel, float CalFactor)
	Set the frequency calibration factor currently in use on the selected channel. More...

EXPORT int	PwrSnsr_GetFrequency (SessionID Vi, const char Channel, float Frequency)
	Get the RF frequency for the current sensor. More...

EXPORT int	PwrSnsr_SetFrequency (SessionID Vi, const char *Channel, float Frequency)
	Set the RF frequency for the current sensor, and apply the appropriate frequency calibration factor from the sensor internal table. More...

EXPORT int	PwrSnsr_GetOffsetdB (SessionID Vi, const char Channel, float OffsetdB)
	Get a measurement offset in dB for the selected sensor. More...

EXPORT int	PwrSnsr_SetOffsetdB (SessionID Vi, const char *Channel, float OffsetdB)
	Set a measurement offset in dB for the selected sensor. More...

EXPORT int	PwrSnsr_GetTempComp (SessionID Vi, const char Channel, int TempComp)
	Get the state of the peak sensor temperature compensation system. More...

EXPORT int	PwrSnsr_SetTempComp (SessionID Vi, const char *Channel, int TempComp)
	Set the state of the peak sensor temperature compensation system. More...

EXPORT int	PwrSnsr_GetModel (SessionID Vi, const char *Channel, int ModelBufferSize, char Model[])
	Gets the model of the meter connected to the specified channel. More...

EXPORT int	PwrSnsr_GetPeakHoldDecay (SessionID Vi, const char Channel, int EnvelopeAverage)
	Get the number of min/max traces averaged together to form the peak hold measurement results on the selected channel. More...

EXPORT int	PwrSnsr_GetPeakHoldTracking (SessionID Vi, const char Channel, int EnvelopeTracking)
	Returns whether peak hold decay automatically tracks trace averaging. If set to true, the peak hold decay and trace averaging values are the same. If set to false, peak hold decay is indepedent. More...

EXPORT int	PwrSnsr_SetPeakHoldTracking (SessionID Vi, const char *Channel, int EnvelopeTracking)
	Sets whether peak hold decay automatically tracks trace averaging. If set to true, the peak hold decay and trace averaging values are the same. If set to false, peak hold decay is indepedent. More...

EXPORT int	PwrSnsr_GetFirmwareVersion (SessionID Vi, const char *Channel, int FirmwareVersionBufferSize, char FirmwareVersion[])
	Returns the firmware version of the power meter associated with this channel. More...

EXPORT int	PwrSnsr_SetPeakHoldDecay (SessionID Vi, const char *Channel, int PeakHoldDecay)
	Set the number of min/max traces averaged together to form the peak hold measurement results on the selected channel. More...

Detailed Description

Channel related functions

Function Documentation

◆ PwrSnsr_GetAverage()

EXPORT int PwrSnsr_GetAverage	(	SessionID	Vi,
		const char *	Channel,
		int *	Average
	)

Get the number of traces averaged together to form the measurement result on the selected channel.

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".
Average

Returns: Success (0) or error code.

◆ PwrSnsr_GetBandwidth()

EXPORT int PwrSnsr_GetBandwidth	(	SessionID	Vi,
		const char *	Channel,
		PwrSnsrBandwidthEnum *	Bandwidth
	)

Get the sensor video bandwidth for the selected sensor.

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".
Bandwidth

Returns: Success (0) or error code.

◆ PwrSnsr_GetCalFactor()

EXPORT int PwrSnsr_GetCalFactor	(	SessionID	Vi,
		const char *	Channel,
		float *	CalFactor
	)

Get the frequency calibration factor currently in use on the selected channel.

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".
CalFactor

Returns: Success (0) or error code.

◆ PwrSnsr_GetCalFactors()

EXPORT int PwrSnsr_GetCalFactors	(	SessionID	Vi,
		const char *	Channel,
		float *	MaxFrequency,
		float *	MinFrequency,
		int	FrequencyListBufferSize,
		float	FrequencyList[],
		int *	FrequencyListActualSize,
		int	CalFactorListBufferSize,
		float	CalFactorList[],
		int *	CalFactorListActualSize,
		PwrSnsrBandwidthEnum	Bandwidth
	)

Query information associated with calibration factors.

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".
MaxFrequency	Maximum RF frequency measureable by this channel.
MinFrequency	Minimum RF frequency measureable by this channel.
FrequencyListBufferSize	Number of elements in FrequencyList.
FrequencyList	List of frequencies correlated to the cal factors.
FrequencyListActualSize	Actual number of elements returned in FrequencyList.
CalFactorListBufferSize	Number of elements in CalFactorList.
CalFactorList	List of cal factors correlated to the frequencies.
CalFactorListActualSize	Actual number of elements returned in CalFactorList.
Bandwidth	Bandwidth of interest. Cal factors for low and high bandwidth are different.

Returns: Success (0) or error code.

◆ PwrSnsr_GetChannelByIndex()

EXPORT int PwrSnsr_GetChannelByIndex	(	SessionID	Vi,
		int	BuffSize,
		char	Channel[],
		int	Index
	)

Gets the channel name by zero index. Note: SCPI commands use a one-based index.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
BuffSize	Buffer size for Channel
Channel	Channel number buffer
Index	the index of the channel

Returns: Success (0) or error code.

◆ PwrSnsr_GetChannelCount()

EXPORT int PwrSnsr_GetChannelCount	(	SessionID	Vi,
		int *	Count
	)

Get number of channels.

Parameters

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

Returns: Success (0) or error code.

◆ PwrSnsr_GetCurrentTemp()

EXPORT int PwrSnsr_GetCurrentTemp	(	SessionID	Vi,
		const char *	Channel,
		double *	CurrentTemp
	)

Get current sensor internal temperature in degrees C.

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".
CurrentTemp

Returns: Success (0) or error code.

◆ PwrSnsr_GetDistal()

EXPORT int PwrSnsr_GetDistal	(	SessionID	Vi,
		const char *	Channel,
		float *	Distal
	)

Get the pulse amplitude percentage, which is used to define the end of a rising edge or beginning of a falling edge transition.

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".
Distal

Returns: Success (0) or error code.

◆ PwrSnsr_GetEnabled()

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

Get the measurement state of the selected channel. When the value is true, the channel performs measurements; when the value is false, the channel is disabled and no measurements are performed.

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".
Enabled	Boolean. 1 for enabled; 0 for disabled.

Returns: Success (0) or error code.

◆ PwrSnsr_GetEndGate()

EXPORT int PwrSnsr_GetEndGate	(	SessionID	Vi,
		const char *	Channel,
		float *	EndGate
	)

Get the point on a pulse, which is used to define the end of the pulse's active interval.

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".
EndGate

Returns: Success (0) or error code.

◆ PwrSnsr_GetFilterState()

EXPORT int PwrSnsr_GetFilterState	(	SessionID	Vi,
		const char *	Channel,
		PwrSnsrFilterStateEnum *	FilterState
	)

Get the current setting of the integration filter on the selected channel.

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".
FilterState	State of the filter.

Returns: Success (0) or error code.

◆ PwrSnsr_GetFilterTime()

EXPORT int PwrSnsr_GetFilterTime	(	SessionID	Vi,
		const char *	Channel,
		float *	FilterTime
	)

Get the current length of the integration filter on the selected channel.

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".
FilterTime	Filter time in seconds.

Returns: Success (0) or error code.

◆ PwrSnsr_GetFirmwareVersion()

EXPORT int PwrSnsr_GetFirmwareVersion	(	SessionID	Vi,
		const char *	Channel,
		int	FirmwareVersionBufferSize,
		char	FirmwareVersion[]
	)

Returns the firmware version of the power meter associated with this channel.

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".
FirmwareVersionBufferSize	Size of the FirmwareVersion buffer.
FirmwareVersion	Buffer to hold the firmware version.

Returns: Success (0) or error code.

◆ PwrSnsr_GetFrequency()

EXPORT int PwrSnsr_GetFrequency	(	SessionID	Vi,
		const char *	Channel,
		float *	Frequency
	)

Get the RF frequency for the current sensor.

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".
Frequency	RF Frequency in Hz.

Returns: Success (0) or error code.

◆ PwrSnsr_GetIsAvgSensor()

EXPORT int PwrSnsr_GetIsAvgSensor	(	SessionID	Vi,
		const char *	Channel,
		int *	IsAvgSensor
	)

Retruns true if sensor is average responding (not peak detecting).

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".
IsAvgSensor	True if sensor is average responding.

Returns: Success (0) or error code.

◆ PwrSnsr_GetMesial()

EXPORT int PwrSnsr_GetMesial	(	SessionID	Vi,
		const char *	Channel,
		float *	Mesial
	)

Get the pulse amplitude percentage, which is used to define the midpoint of a rising edge or end of a falling edge transition.

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".
Mesial

Returns: Success (0) or error code.

◆ PwrSnsr_GetModel()

EXPORT int PwrSnsr_GetModel	(	SessionID	Vi,
		const char *	Channel,
		int	ModelBufferSize,
		char	Model[]
	)

Gets the model of the meter connected to the specified channel.

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".
ModelBufferSize	Size of the buffer..
Model	Buffer where the model is read into.

Returns: Success (0) or error code.

◆ PwrSnsr_GetOffsetdB()

EXPORT int PwrSnsr_GetOffsetdB	(	SessionID	Vi,
		const char *	Channel,
		float *	OffsetdB
	)

Get a measurement offset in dB for the selected sensor.

This setting is used to compensate for external couplers, attenuators or amplifiers in the RF signal path ahead of the power sensor.

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".
OffsetdB

Returns: Success (0) or error code.

◆ PwrSnsr_GetPeakHoldDecay()

EXPORT int PwrSnsr_GetPeakHoldDecay	(	SessionID	Vi,
		const char *	Channel,
		int *	EnvelopeAverage
	)

Get the number of min/max traces averaged together to form the peak hold measurement results on the selected channel.

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".
EnvelopeAverage	Out parameter value.

Returns: Success (0) or error code.

◆ PwrSnsr_GetPeakHoldTracking()

EXPORT int PwrSnsr_GetPeakHoldTracking	(	SessionID	Vi,
		const char *	Channel,
		int *	EnvelopeTracking
	)

Returns whether peak hold decay automatically tracks trace averaging. If set to true, the peak hold decay and trace averaging values are the same. If set to false, peak hold decay is indepedent.

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".
EnvelopeTracking	Out boolean parameter value.

Returns: Success (0) or error code.

◆ PwrSnsr_GetProximal()

EXPORT int PwrSnsr_GetProximal	(	SessionID	Vi,
		const char *	Channel,
		float *	Proximal
	)

Get the pulse amplitude percentage, which is used to define the beginning of a rising edge or end of a falling edge transition.

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".
Proximal

Returns: Success (0) or error code.

◆ PwrSnsr_GetPulseUnits()

EXPORT int PwrSnsr_GetPulseUnits	(	SessionID	Vi,
		const char *	Channel,
		PwrSnsrPulseUnitsEnum *	Units
	)

Get the units for entering the pulse distal, mesial and proximal levels.

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".
Units	PwrSnsrPulseUnitsEnum Pulse calculation units (watts or volts).

Returns: Success (0) or error code.

◆ PwrSnsr_GetSerialNumber()

EXPORT int PwrSnsr_GetSerialNumber	(	SessionID	Vi,
		const char *	Channel,
		int	SerialNumberBufferSize,
		char	SerialNumber[]
	)

Gets the serial number of the sensor.

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".
SerialNumberBufferSize	Size in bytes of Serial number.
SerialNumber	Out parameter. ASCII string serial number.

Returns: Success (0) or error code.

◆ PwrSnsr_GetStartGate()

EXPORT int PwrSnsr_GetStartGate	(	SessionID	Vi,
		const char *	Channel,
		float *	StartGate
	)

Get the point on a pulse, which is used to define the beginning of the pulse's active interval.

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".
StartGate

Returns: Success (0) or error code.

◆ PwrSnsr_GetTempComp()

EXPORT int PwrSnsr_GetTempComp	(	SessionID	Vi,
		const char *	Channel,
		int *	TempComp
	)

Get the state of the peak sensor temperature compensation system.

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".
TempComp	Boolean. 1 for on; 0 for off.

Returns: Success (0) or error code.

◆ PwrSnsr_GetUnits()

EXPORT int PwrSnsr_GetUnits	(	SessionID	Vi,
		const char *	Channel,
		PwrSnsrUnitsEnum *	Units
	)

Get units for the selected channel.

Voltage is calculated with reference to the sensor input impedance. Note that for ratiometric results, logarithmic units will always return dBr (dB relative) while linear units return percent.

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".
Units

Returns: Success (0) or error code.

◆ PwrSnsr_SetAverage()

EXPORT int PwrSnsr_SetAverage	(	SessionID	Vi,
		const char *	Channel,
		int	Average
	)

Set the number of traces averaged together to form the measurement result on the selected channel.

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".
Average

Returns: Success (0) or error code.

◆ PwrSnsr_SetBandwidth()

EXPORT int PwrSnsr_SetBandwidth	(	SessionID	Vi,
		const char *	Channel,
		PwrSnsrBandwidthEnum	Bandwidth
	)

Set the sensor video bandwidth for the selected sensor.

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".
Bandwidth

Returns: Success (0) or error code.

◆ PwrSnsr_SetCalFactor()

EXPORT int PwrSnsr_SetCalFactor	(	SessionID	Vi,
		const char *	Channel,
		float	CalFactor
	)

Set the frequency calibration factor currently in use on the selected channel.

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".
CalFactor

Returns: Success (0) or error code.

◆ PwrSnsr_SetDistal()

EXPORT int PwrSnsr_SetDistal	(	SessionID	Vi,
		const char *	Channel,
		float	Distal
	)

Set the pulse amplitude percentage, which is used to define the end of a rising edge or beginning of a falling edge transition.

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".
Distal

Returns: Success (0) or error code.

◆ PwrSnsr_SetEnabled()

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

Get the measurement state of the selected channel. When the value is true, the channel performs measurements; when the value is false, the channel is disabled and no measurements are performed.

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".
Enabled	Boolean. 1 for enable; 0 for disable.

Returns: Success (0) or error code.

◆ PwrSnsr_SetEndGate()

EXPORT int PwrSnsr_SetEndGate	(	SessionID	Vi,
		const char *	Channel,
		float	EndGate
	)

Set the point on a pulse, which is used to define the end of the pulse's active interval.

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".
EndGate

Returns: Success (0) or error code.

◆ PwrSnsr_SetFilterState()

EXPORT int PwrSnsr_SetFilterState	(	SessionID	Vi,
		const char *	Channel,
		PwrSnsrFilterStateEnum	FilterState
	)

Set the current setting of the integration filter on the selected channel.

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".
FilterState	State of the filter.

Returns: Success (0) or error code.

◆ PwrSnsr_SetFilterTime()

EXPORT int PwrSnsr_SetFilterTime	(	SessionID	Vi,
		const char *	Channel,
		float	FilterTime
	)

Set the current length of the integration filter on the selected channel.

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".
FilterTime	Filter time in seconds.

Returns: Success (0) or error code.

◆ PwrSnsr_SetFrequency()

EXPORT int PwrSnsr_SetFrequency	(	SessionID	Vi,
		const char *	Channel,
		float	Frequency
	)

Set the RF frequency for the current sensor, and apply the appropriate frequency calibration factor from the sensor internal table.

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".
Frequency	RF Frequency in Hz.

Returns: Success (0) or error code.

◆ PwrSnsr_SetMesial()

EXPORT int PwrSnsr_SetMesial	(	SessionID	Vi,
		const char *	Channel,
		float	Mesial
	)

Set the pulse amplitude percentage, which is used to define the midpoint of a rising edge or end of a falling edge transition.

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".
Mesial

Returns: Success (0) or error code.

◆ PwrSnsr_SetOffsetdB()

EXPORT int PwrSnsr_SetOffsetdB	(	SessionID	Vi,
		const char *	Channel,
		float	OffsetdB
	)

Set a measurement offset in dB for the selected sensor.

This setting is used to compensate for external couplers, attenuators or amplifiers in the RF signal path ahead of the power sensor.

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".
OffsetdB

Returns: Success (0) or error code.

◆ PwrSnsr_SetPeakHoldDecay()

EXPORT int PwrSnsr_SetPeakHoldDecay	(	SessionID	Vi,
		const char *	Channel,
		int	PeakHoldDecay
	)

Set the number of min/max traces averaged together to form the peak hold measurement results on the selected channel.

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".
PeakHoldDecay	Peak hold decay value.

Returns: Success (0) or error code.

◆ PwrSnsr_SetPeakHoldTracking()

EXPORT int PwrSnsr_SetPeakHoldTracking	(	SessionID	Vi,
		const char *	Channel,
		int	EnvelopeTracking
	)

Sets whether peak hold decay automatically tracks trace averaging. If set to true, the peak hold decay and trace averaging values are the same. If set to false, peak hold decay is indepedent.

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".
EnvelopeTracking	Boolean value. True to set peak hold tracking on.

Returns: Success (0) or error code.

◆ PwrSnsr_SetProximal()

EXPORT int PwrSnsr_SetProximal	(	SessionID	Vi,
		const char *	Channel,
		float	Proximal
	)

Set the pulse amplitude percentage, which is used to define the beginning of a rising edge or end of a falling edge transition.

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".
Proximal

Returns: Success (0) or error code.

◆ PwrSnsr_SetPulseUnits()

EXPORT int PwrSnsr_SetPulseUnits	(	SessionID	Vi,
		const char *	Channel,
		PwrSnsrPulseUnitsEnum	PwrSnsrPulseUnitsEnum
	)

Set the units for entering the pulse distal, mesial and proximal levels.

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".
PwrSnsrPulseUnitsEnum	Pulse calculation units (watts or volts).

Returns: Success (0) or error code.

◆ PwrSnsr_SetStartGate()

EXPORT int PwrSnsr_SetStartGate	(	SessionID	Vi,
		const char *	Channel,
		float	StartGate
	)

Set the point on a pulse, which is used to define the beginning of the pulse's active interval.

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".
StartGate

Returns: Success (0) or error code.

◆ PwrSnsr_SetTempComp()

EXPORT int PwrSnsr_SetTempComp	(	SessionID	Vi,
		const char *	Channel,
		int	TempComp
	)

Set the state of the peak sensor temperature compensation system.

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".
TempComp	Boolean. 1 for on; 0 for off.

Returns: Success (0) or error code.

◆ PwrSnsr_SetUnits()

EXPORT int PwrSnsr_SetUnits	(	SessionID	Vi,
		const char *	Channel,
		PwrSnsrUnitsEnum	Units
	)

Set units for the selected channel.

Voltage is calculated with reference to the sensor input impedance. Note that for ratiometric results, logarithmic units will always return dBr (dB relative) while linear units return percent.

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".
Units

Returns: Success (0) or error code.

Functions

Detailed Description

Function Documentation

◆ PwrSnsr_GetAverage()

◆ PwrSnsr_GetBandwidth()

◆ PwrSnsr_GetCalFactor()

◆ PwrSnsr_GetCalFactors()

◆ PwrSnsr_GetChannelByIndex()

◆ PwrSnsr_GetChannelCount()

◆ PwrSnsr_GetCurrentTemp()

◆ PwrSnsr_GetDistal()

◆ PwrSnsr_GetEnabled()

◆ PwrSnsr_GetEndGate()

◆ PwrSnsr_GetFilterState()

◆ PwrSnsr_GetFilterTime()

◆ PwrSnsr_GetFirmwareVersion()

◆ PwrSnsr_GetFrequency()

◆ PwrSnsr_GetIsAvgSensor()

◆ PwrSnsr_GetMesial()

◆ PwrSnsr_GetModel()

◆ PwrSnsr_GetOffsetdB()

◆ PwrSnsr_GetPeakHoldDecay()

◆ PwrSnsr_GetPeakHoldTracking()

◆ PwrSnsr_GetProximal()

◆ PwrSnsr_GetPulseUnits()

◆ PwrSnsr_GetSerialNumber()

◆ PwrSnsr_GetStartGate()

◆ PwrSnsr_GetTempComp()

◆ PwrSnsr_GetUnits()

◆ PwrSnsr_SetAverage()

◆ PwrSnsr_SetBandwidth()

◆ PwrSnsr_SetCalFactor()

◆ PwrSnsr_SetDistal()

◆ PwrSnsr_SetEnabled()

◆ PwrSnsr_SetEndGate()

◆ PwrSnsr_SetFilterState()

◆ PwrSnsr_SetFilterTime()

◆ PwrSnsr_SetFrequency()

◆ PwrSnsr_SetMesial()

◆ PwrSnsr_SetOffsetdB()

◆ PwrSnsr_SetPeakHoldDecay()

◆ PwrSnsr_SetPeakHoldTracking()

◆ PwrSnsr_SetProximal()

◆ PwrSnsr_SetPulseUnits()

◆ PwrSnsr_SetStartGate()

◆ PwrSnsr_SetTempComp()

◆ PwrSnsr_SetUnits()