Power Sensor Library
Data Structures | Macros | Typedefs | Enumerations | Functions
PwrSnsrLib.h File Reference

Go to the source code of this file.

Data Structures

struct  PulseInfo
 Data structure containing pulse information. More...
 

Macros

#define SUCCESS   (0L)
 
#define CURRENT_TIMEOUT   (-2)
 
#define EXPORT
 
#define ERROR_BASE   (0xBFFA0000L)
 

Typedefs

typedef int SessionID
 
typedef enum PwrSnsrAcquisitionStatusEnum PwrSnsrAcquisitionStatusEnum
 
typedef enum PwrSnsrTriggerModeEnum PwrSnsrTriggerModeEnum
 
typedef enum PwrSnsrTriggerSlopeEnum PwrSnsrTriggerSlopeEnum
 
typedef enum PwrSnsrTriggerPositionEnum PwrSnsrTriggerPositionEnum
 
typedef enum PwrSnsrTriggerSourceEnum PwrSnsrTriggerSourceEnum
 
typedef enum PwrSnsrUnitsEnum PwrSnsrUnitsEnum
 
typedef enum PwrSnsrMarkerNumberEnum PwrSnsrMarkerNumberEnum
 
typedef enum PwrSnsrBandwidthEnum PwrSnsrBandwidthEnum
 
typedef enum PwrSnsrFilterStateEnum PwrSnsrFilterStateEnum
 
typedef enum PwrSnsrPulseUnitsEnum PwrSnsrPulseUnitsEnum
 
typedef enum PwrSnsrCondCodeEnum PwrSnsrCondCodeEnum
 
typedef enum PwrSnsrTriggerStatusEnum PwrSnsrTriggerStatusEnum
 
typedef enum PwrSnsrTermActionEnum PwrSnsrTermActionEnum
 
typedef enum PwrSnsrHoldoffModeEnum PwrSnsrHoldoffModeEnum
 
typedef enum PwrSnsrStatGatingEnum PwrSnsrStatGatingEnum
 
typedef enum PwrSnsrTrigOutModeEnum PwrSnsrTrigOutModeEnum
 
typedef enum PwrSnsrMeasBuffGateEnum PwrSnsrMeasBuffGateEnum
 
typedef enum PwrSnsrMeasBuffStartModeEnum PwrSnsrMeasBuffStartModeEnum
 
typedef enum PwrSnsrMeasBuffStopReasonEnum PwrSnsrMeasBuffStopReasonEnum
 
typedef enum PwrSnsrRdgsEnableFlag PwrSnsrRdgsEnableFlag
 
typedef enum PwrSnsrErrorCodesEnum PwrSnsrErrorCodesEnum
 
typedef struct PulseInfo PulseInfo
 Data structure containing pulse information. More...
 

Enumerations

enum  PwrSnsrAcquisitionStatusEnum { PwrSnsrAcqComplete = 1, PwrSnsrAcqInProgress = 0, PwrSnsrAcqStatusUnknown = -1 }
 
enum  PwrSnsrTriggerModeEnum { PwrSnsrTriggerModeNormal = 1, PwrSnsrTriggerModeAuto = 2, PwrSnsrTriggerModeAutoLevel = 3, PwrSnsrTriggerModeFreerun = 4 }
 
enum  PwrSnsrTriggerSlopeEnum { PwrSnsrTriggerSlopePositive = 1, PwrSnsrTriggerSlopeNegative = 0 }
 
enum  PwrSnsrTriggerPositionEnum { PwrSnsrTriggerPositionLeft = 0, PwrSnsrTriggerPositionMiddle = 1, PwrSnsrTriggerPositionRight = 2 }
 
enum  PwrSnsrTriggerSourceEnum {
  PwrSnsrTriggerSourceChannel1 = 0, PwrSnsrTriggerSourceExternal = 2, PwrSnsrTriggerSourceChannel2 = 1, PwrSnsrTriggerSourceChannel3 = 3,
  PwrSnsrTriggerSourceChannel4 = 4, PwrSnsrTriggerSourceChannel5 = 5, PwrSnsrTriggerSourceChannel6 = 6, PwrSnsrTriggerSourceChannel7 = 7,
  PwrSnsrTriggerSourceChannel8 = 8, PwrSnsrTriggerSourceChannel9 = 9, PwrSnsrTriggerSourceChannel10 = 10, PwrSnsrTriggerSourceChannel11 = 11,
  PwrSnsrTriggerSourceChannel12 = 12, PwrSnsrTriggerSourceChannel13 = 13, PwrSnsrTriggerSourceChannel14 = 14, PwrSnsrTriggerSourceChannel15 = 15,
  PwrSnsrTriggerSourceChannel16 = 16, PwrSnsrTriggerSourceIndependent = 17
}
 
enum  PwrSnsrUnitsEnum {
  PwrSnsrUnitsdBm = 0, PwrSnsrUnitswatts = 1, PwrSnsrUnitsvolts = 2, PwrSnsrUnitsDBV = 3,
  PwrSnsrUnitsDBMV = 4, PwrSnsrUnitsDBUV = 5
}
 
enum  PwrSnsrMarkerNumberEnum { PwrSnsrMarkerNumberMarker1 = 1, PwrSnsrMarkerNumberMarker2 = 2 }
 
enum  PwrSnsrBandwidthEnum { PwrSnsrBandwidthHigh = 0, PwrSnsrBandwidthLow = 1 }
 
enum  PwrSnsrFilterStateEnum { PwrSnsrFilterStateOff = 0, PwrSnsrFilterStateOn = 1, PwrSnsrFilterStateAuto = 2 }
 
enum  PwrSnsrPulseUnitsEnum { PwrSnsrPulseUnitsWatts = 0, PwrSnsrPulseUnitsVolts = 1 }
 
enum  PwrSnsrCondCodeEnum {
  PwrSnsrCondCodeMeasurementStopped = -1, PwrSnsrCondCodeError = 0, PwrSnsrCondCodeUnderrange = 2, PwrSnsrCondCodeOverrange = 3,
  PwrSnsrCondCodeNormal = 1
}
 
enum  PwrSnsrTriggerStatusEnum {
  PwrSnsrTriggerStatusStopped = 0, PwrSnsrTriggerStatusPretrig = 1, PwrSnsrTriggerStatusWaiting = 2, PwrSnsrTriggerStatusAcquiringNew = 3,
  PwrSnsrTriggerStatusAutoTrig = 4, PwrSnsrTriggerStatusFreerun = 5, PwrSnsrTriggerStatusTriggered = 6, PwrSnsrTriggerStatusRunning = 7
}
 
enum  PwrSnsrTermActionEnum { PwrSnsrTermActionStop = 0, PwrSnsrTermActionRestart = 1, PwrSnsrTermActionDecimate = 2 }
 
enum  PwrSnsrHoldoffModeEnum { PwrSnsrHoldoffModeNormal = 1, PwrSnsrHoldoffModeGap = 2 }
 
enum  PwrSnsrStatGatingEnum { PwrSnsrStatGatingFreeRun = 0, PwrSnsrStatGatingMarkers = 1 }
 
enum  PwrSnsrTrigOutModeEnum {
  PwrSnsrTrigOutModeMioOff = 0, PwrSnsrTrigOutModeMioPullUp = 1, PwrSnsrTrigOutModeMioTtl0 = 2, PwrSnsrTrigOutModeMioTbRef = 3,
  PwrSnsrTrigOutModeMioSweepHigh = 4, PwrSnsrTrigOutModeMioSweepLow = 5, PwrSnsrTrigOutModeMioTrigHigh = 6, PwrSnsrTrigOutModeMioTrigLow = 7,
  PwrSnsrTrigOutModeMioMaster = 8, PwrSnsrTrigOutModeMioSlave = 9
}
 
enum  PwrSnsrMeasBuffGateEnum {
  PwrSnsrMeasBuffGateBurst = 0, PwrSnsrMeasBuffGateMarker = 1, PwrSnsrMeasBuffGateExtGate = 2, PwrSnsrMeasBuffGatePeriodic = 3,
  PwrSnsrMeasBuffGateExtTrig = 4
}
 
enum  PwrSnsrMeasBuffStartModeEnum { PwrSnsrMeasBuffStartModeImmediate = 1, PwrSnsrMeasBuffStartModeExternalEnable = 2, PwrSnsrMeasBuffStartModeExternalStart = 3 }
 
enum  PwrSnsrMeasBuffStopReasonEnum { PwrSnsrMeasBuffStopReasonCountReached = 1, PwrSnsrMeasBuffStopReasonTimedOut = 2, PwrSnsrMeasBuffStopReasonBufferOverran = 3, PwrSnsrMeasBuffStopReasonNone = 0 }
 
enum  PwrSnsrRdgsEnableFlag {
  PwrSnsrSequenceEnable = 1, PwrSnsrStartTimeEnable = 2, PwrSnsrDurationEnable = 4, PwrSnsrMinEnable = 8,
  PwrSnsrAvgEnable = 16, PwrSnsrMaxEnable = 32
}
 
enum  PwrSnsrErrorCodesEnum {
  PWR_SNSR_IO_GENERAL = -2147204588, PWR_SNSR_IO_TIMEOUT = -2147204587, PWR_SNSR_MODEL_NOT_SUPPORTED = -2147204586, PWR_SNSR_INV_PARAMETER = -1073807240,
  PWR_SNSR_ERROR_INVALID_SESSION_HANDLE = -1074130544, PWR_SNSR_ERROR_STATUS_NOT_AVAILABLE = -1074134947, PWR_SNSR_ERROR_RESET_FAILED = -1074134945, PWR_SNSR_ERROR_RESOURCE_UNKNOWN = -1074134944,
  PWR_SNSR_ERROR_ALREADY_INITIALIZED = -1074134943, PWR_SNSR_ERROR_OUT_OF_MEMORY = -1074134954, PWR_SNSR_ERROR_OPERATION_PENDING = -1074134953, PWR_SNSR_ERROR_NULL_POINTER = -1074134952,
  PWR_SNSR_ERROR_UNEXPECTED_RESPONSE = -1074134951, PWR_SNSR_ERROR_NOT_INITIALIZED = -1074135011, PWR_SNSR_LIBUSB_ERROR_IO = -1, PWR_SNSR_LIBUSB_ERROR_INVALID_PARAM = -2,
  PWR_SNSR_LIBUSB_ERROR_ACCESS = -3, PWR_SNSR_LIBUSB_ERROR_NO_DEVICE = -4, PWR_SNSR_LIBUSB_ERROR_NOT_FOUND = -5, PWR_SNSR_LIBUSB_ERROR_BUSY = -6,
  PWR_SNSR_LIBUSB_ERROR_TIMEOUT = -7, PWR_SNSR_LIBUSB_ERROR_OVERFLOW = -8, PWR_SNSR_LIBUSB_ERROR_PIPE = -9, PWR_SNSR_LIBUSB_ERROR_INTERRUPTED = -10,
  PWR_SNSR_LIBUSB_ERROR_NO_MEM = -11, PWR_SNSR_LIBUSB_ERROR_NOT_SUPPORTED = -12, PWR_SNSR_LIBUSB_ERROR_OTHER = -99
}
 

Functions

EXPORT int PwrSnsr_SendSCPICommand (SessionID Vi, const char *Command)
 Send a SCPI command to the instrument. More...
 
EXPORT int PwrSnsr_ReadSCPI (SessionID Vi, int ValueBufferSize, long *ValueActualSize, char Value[], int Timeout)
 Read a SCPI string response from the instrument. More...
 
EXPORT int PwrSnsr_SendSCPIToNamedParser (SessionID Vi, const char *name, const char *Command)
 Send a SCPI command to the instrument using a named SCPI parser. More...
 
EXPORT int PwrSnsr_ReadSCPIFromNamedParser (SessionID Vi, const char *name, int ValueBufferSize, long *ValueActualSize, char Value[], int Timeout)
 Read a SCPI string response from the instrument. More...
 
EXPORT int PwrSnsr_FindResources (const char *Delimiter, int ValBufferSize, char Val[])
 Returns a delimited string of available resources. These strings can be used in the initialize function to open a session to an instrument. More...
 
EXPORT int PwrSnsr_GetMinimumSupportedFirmware (int *Version)
 Gets the minimum supported firmware as an integer. Format is YYYYMMDD. More...
 
EXPORT int PwrSnsr_SendSCPIBytes (SessionID Vi, int CommandBufferSize, char Command[])
 Send a SCPI command as a byte array. More...
 
EXPORT int PwrSnsr_ReadSCPIBytes (SessionID Vi, int ValueBufferSize, char Value[], long *ValueActualSize, int Timeout)
 Read a SCPI byte array response from the instrument. More...
 
EXPORT int PwrSnsr_SetTimeOut (SessionID Vi, long Milliseconds)
 Sets the time out in milliseconds for I/O. More...
 
EXPORT int PwrSnsr_GetTimeOut (SessionID Vi, long *Val)
 Returns the time out value for I/O in milliseconds. More...
 
EXPORT int PwrSnsr_init (char *ResourceName, SessionID *Vi)
 Initialize a communication session with a supported USB power sensor. More...
 
EXPORT int PwrSnsr_close (SessionID Vi)
 Closes the I/O session to the instrument. Driver methods and properties that access the instrument are not accessible after Close is called. More...
 
EXPORT int PwrSnsr_GetError (SessionID Vi, int *ErrorCode, int ErrorDescriptionBufferSize, char ErrorDescription[])
 This function retrieves and then clears the error information for the session. Normally, the error information describes the first error that occurred since the user last called the Get Error or Clear Error function. More...
 
EXPORT int PwrSnsr_ClearError (SessionID Vi)
 This function clears the error code and error description for the given session. More...
 
EXPORT int PwrSnsr_reset (SessionID Vi)
 
EXPORT int PwrSnsr_self_test (SessionID Vi, int *TestResult)
 Performs an instrument self test, waits for the instrument to complete the test, and queries the instrument for the results. If the instrument passes the test, TestResult is 0. More...
 
EXPORT int PwrSnsr_MeasurePower (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return average power using a default instrument configuration in Modulated Mode and dBm units. Instrument remains stopped in Modulated Mode after a measurement. More...
 
EXPORT int PwrSnsr_FetchCWPower (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Returns the most recently acquired CW power. More...
 
EXPORT int PwrSnsr_MeasureVoltage (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return average voltage using a default instrument configuration in Modulated Mode and volts units. Instrument remains stopped in Modulated Mode after a measurement. More...
 
EXPORT int PwrSnsr_ReadWaveformMinMax (SessionID Vi, const char *Channel, int MinWaveformBufferSize, float MinWaveform[], int *MinWaveformActualSize, int MaxWaveformBufferSize, float MaxWaveform[], int *MaxWaveformActualSize, int WaveformArrayBufferSize, float WaveformArray[], int *WaveformArrayActualSize)
 Initiates an acquisition on all enabled channels, waits (up to MaxTime) for the acquisition to complete, and returns the min/max waveforms for this channel. Call FetchMinMaxWaveform to obtain the min/max waveforms for other channels. More...
 
EXPORT int PwrSnsr_ReadWaveform (SessionID Vi, const char *Channel, int WaveformArrayBufferSize, float WaveformArray[], int *WaveformArrayActualSize)
 Initiates an acquisition on all enabled channels, waits (up to MaxTime) for the acquisition to complete, and returns the waveform for this channel. Call FetchWaveform to obtain the waveforms for other channels. More...
 
EXPORT int PwrSnsr_FetchWaveformMinMax (SessionID Vi, const char *Channel, int MinWaveformBufferSize, float MinWaveform[], int *MinWaveformActualSize, int MaxWaveformBufferSize, float MaxWaveform[], int *MaxWaveformActualSize, int WaveformArrayBufferSize, float WaveformArray[], int *WaveformArrayActualSize)
 Returns the previously acquired minimum and maximum waveforms for this specified channel. The acquisition must be made prior to calling this method. Call this method separately for each channel. More...
 
EXPORT int PwrSnsr_FetchWaveform (SessionID Vi, const char *Channel, int WaveformArrayBufferSize, float WaveformArray[], int *WaveformArrayActualSize)
 Returns a previously acquired waveform for this channel. The acquisition must be made prior to calling this method. Call this method separately for each channel. More...
 
EXPORT int PwrSnsr_FetchPowerArray (SessionID Vi, const char *Channel, float *PulsePeak, PwrSnsrCondCodeEnum *PulsePeakValid, float *PulseCycleAvg, PwrSnsrCondCodeEnum *PulseCycleAvgValid, float *PulseOnAvg, PwrSnsrCondCodeEnum *PulseOnValid, float *IEEETop, PwrSnsrCondCodeEnum *IEEETopValid, float *IEEEBottom, PwrSnsrCondCodeEnum *IEEEBottomValid, float *Overshoot, PwrSnsrCondCodeEnum *OvershootValid, float *Droop, PwrSnsrCondCodeEnum *DroopValid)
 Returns an array of the current automatic amplitude measurements performed on
a periodic pulse waveform. More...
 
EXPORT int PwrSnsr_FetchTimeArray (SessionID Vi, const char *Channel, float *Frequency, PwrSnsrCondCodeEnum *FrequencyValid, float *Period, PwrSnsrCondCodeEnum *PeriodValid, float *Width, PwrSnsrCondCodeEnum *WidthValid, float *Offtime, PwrSnsrCondCodeEnum *OfftimeValid, float *DutyCycle, PwrSnsrCondCodeEnum *DutyCycleValid, float *Risetime, PwrSnsrCondCodeEnum *RisetimeValid, float *Falltime, PwrSnsrCondCodeEnum *FalltimeValid, float *EdgeDelay, PwrSnsrCondCodeEnum *EdgeDelayValid, float *Skew, PwrSnsrCondCodeEnum *SkewValid)
 Returns an array of the current automatic timing measurements performed on a periodic pulse waveform. More...
 
EXPORT int PwrSnsr_FetchCWArray (SessionID Vi, const char *Channel, float *PeakAverage, PwrSnsrCondCodeEnum *PeakAverageValid, float *PeakMax, PwrSnsrCondCodeEnum *PeakMaxValid, float *PeakMin, PwrSnsrCondCodeEnum *PeakMinValid, float *PeakToAvgRatio, PwrSnsrCondCodeEnum *PeakToAvgRatioValid)
 Returns the current average, maximum, minimum powers or voltages and the
peak-to-average ratio of the specified channel. Units are the same as the
channel units. Note the peak-to-average ratio and marker ratio are returned
in dB for logarithmic channel units, and percent for all other channel units. More...
 
EXPORT int PwrSnsr_FetchRiseTime (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *IsValid, float *Val)
 Returns the interval between the first signal crossing of the proximal line to the first signal crossing of the distal line. More...
 
EXPORT int PwrSnsr_FetchWidth (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *IsValid, float *Val)
 Returns the pulse width, i.e. the interval between the first and second signal crossings of the mesial line. More...
 
EXPORT int PwrSnsr_FetchPulsePeak (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *IsValid, float *Val)
 Returns the peak amplitude during the pulse. More...
 
EXPORT int PwrSnsr_FetchPulseOnAverage (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *IsValid, float *Val)
 Average power of the ON portion of the pulse. More...
 
EXPORT int PwrSnsr_FetchPulseCycleAvg (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *IsValid, float *Val)
 Returns the average power of the entire pulse. More...
 
EXPORT int PwrSnsr_FetchPRF (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *IsValid, float *Val)
 Returns the number of cycles of a repetitive signal that take place in one second (Pulse Repetition Frequency). More...
 
EXPORT int PwrSnsr_FetchPeriod (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *IsValid, float *Val)
 Returns the interval between two successive pulses. (Reciprocal of the Pulse RepetitionFrequency) More...
 
EXPORT int PwrSnsr_FetchOvershoot (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *IsValid, float *Val)
 Returns the difference between the distortion following a major transition and the IEEE top line in dB or percent, depending on the channel units. More...
 
EXPORT int PwrSnsr_FetchOfftime (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *IsValid, float *Val)
 Returns the time a repetitive pulse is off. (Equal to the pulse period minus the pulsewidth). More...
 
EXPORT int PwrSnsr_FetchIEEETop (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *IsValid, float *Val)
 Returns the IEEE-defined top line, i.e. the portion of a pulse waveform which represents the second nominal state of a pulse. More...
 
EXPORT int PwrSnsr_FetchIEEEBottom (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *IsValid, float *Val)
 Returns the IEEE-define base line, i.e. The two portions of a pulse waveform which represent the first nominal state from which a pulse departs and to which it ultimately returns. More...
 
EXPORT int PwrSnsr_FetchFallTime (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *IsValid, float *Val)
 Returns the interval between the last signal crossing of the distal line to the last signalcrossing of the proximal line. More...
 
EXPORT int PwrSnsr_FetchEdgeDelay (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *IsValid, float *Val)
 Returns time offset from the trigger reference to the first mesial transition level of either slope on the waveform. More...
 
EXPORT int PwrSnsr_FetchDutyCycle (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *IsValid, float *Val)
 Returns the ratio of the pulse on-time to off-time. More...
 
EXPORT int PwrSnsr_GetTrigDelay (SessionID Vi, float *Delay)
 Return the trigger delay time in seconds with respect to the trigger for the trigger display location in the LEFT position. More...
 
EXPORT int PwrSnsr_SetTrigDelay (SessionID Vi, float Delay)
 Sets the trigger delay time in seconds with respect to the trigger for the trigger display location in the LEFT position. More...
 
EXPORT int PwrSnsr_GetTrigHoldoff (SessionID Vi, float *Holdoff)
 Return the trigger holdoff time in seconds. More...
 
EXPORT int PwrSnsr_SetTrigHoldoff (SessionID Vi, float Holdoff)
 Sets the trigger holdoff time in seconds. More...
 
EXPORT int PwrSnsr_GetTrigHoldoffMode (SessionID Vi, PwrSnsrHoldoffModeEnum *HoldoffMode)
 Returns the holdoff mode to normal or gap holdoff. More...
 
EXPORT int PwrSnsr_SetTrigHoldoffMode (SessionID Vi, PwrSnsrHoldoffModeEnum HoldoffMode)
 Sets the holdoff mode to normal or gap holdoff. More...
 
EXPORT int PwrSnsr_GetTrigLevel (SessionID Vi, float *Level)
 Return the trigger level for synchronizing data acquisition with a pulsed input signal. More...
 
EXPORT int PwrSnsr_SetTrigLevel (SessionID Vi, float Level)
 Set the trigger level for synchronizing data acquisition with a pulsed input signal. More...
 
EXPORT int PwrSnsr_GetTrigMode (SessionID Vi, PwrSnsrTriggerModeEnum *Mode)
 Return the trigger mode for synchronizing data acquisition with pulsed signals. More...
 
EXPORT int PwrSnsr_SetTrigMode (SessionID Vi, PwrSnsrTriggerModeEnum Mode)
 Set the trigger mode for synchronizing data acquisition with pulsed signals. More...
 
EXPORT int PwrSnsr_GetTrigPosition (SessionID Vi, PwrSnsrTriggerPositionEnum *Position)
 Return the position of the trigger event on displayed sweep. More...
 
EXPORT int PwrSnsr_SetTrigPosition (SessionID Vi, PwrSnsrTriggerPositionEnum Position)
 Set the position of the trigger event on displayed sweep. More...
 
EXPORT int PwrSnsr_GetTrigSource (SessionID Vi, PwrSnsrTriggerSourceEnum *Source)
 Set the signal the power meter monitors for a trigger. It can be channel external input, or independent. More...
 
EXPORT int PwrSnsr_SetTrigSource (SessionID Vi, PwrSnsrTriggerSourceEnum Source)
 Get the signal the power meter monitors for a trigger. It can be channel external input, or independent. More...
 
EXPORT int PwrSnsr_GetTrigStatus (SessionID Vi, PwrSnsrTriggerStatusEnum *Status)
 The status of the triggering system. Update rate is controlled by FetchLatency setting. More...
 
EXPORT int PwrSnsr_SetFetchLatency (SessionID Vi, int Latency)
 Set the period the library waits to update fetch measurements in ms. More...
 
EXPORT int PwrSnsr_GetFetchLatency (SessionID Vi, int *Latency)
 Get the period the library waits to update fetch measurements in ms. More...
 
EXPORT int PwrSnsr_GetTrigVernier (SessionID Vi, float *Vernier)
 Return the fine position of the trigger event on the power sweep. More...
 
EXPORT int PwrSnsr_SetTrigVernier (SessionID Vi, float Vernier)
 Set the fine position of the trigger event on the power sweep. More...
 
EXPORT int PwrSnsr_GetTrigSlope (SessionID Vi, PwrSnsrTriggerSlopeEnum *Slope)
 Return the trigger slope or polarity. More...
 
EXPORT int PwrSnsr_SetTrigSlope (SessionID Vi, PwrSnsrTriggerSlopeEnum Slope)
 Sets the trigger slope or polarity. 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...
 
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_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_GetTimebase (SessionID Vi, float *Timebase)
 Get the Pulse Mode timebase in seconds/division. (10 divisions = 1 trace) Value = 5e-9 to 10e-3 (or max timebase) sec in a 1-2-5 sequence,. More...
 
EXPORT int PwrSnsr_SetTimebase (SessionID Vi, float Timebase)
 Set the Pulse Mode timebase in seconds/division. (10 divisions = 1 trace) Value = 5e-9 to 10e-3 sec (or max timebase) in a 1-2-5 sequence,. More...
 
EXPORT int PwrSnsr_SetTimespan (SessionID Vi, float Timespan)
 Set the horizontal time span of the trace in pulse mode. Time span = 10* Time/Division. Value = 5e-8 to 100e-3 sec in a 1-2-5 sequence. More...
 
EXPORT int PwrSnsr_GetTimespan (SessionID Vi, float *Timespan)
 Get the horizontal time span of the trace in pulse mode. Time span = 10* Time/Division. Value = 5e-8 to 100e-3 sec in a 1-2-5 sequence. More...
 
EXPORT int PwrSnsr_GetMaxTimebase (SessionID Vi, float *MaxTimebase)
 Gets the maximum timebase setting available. More...
 
EXPORT int PwrSnsr_FetchArrayMarkerPower (SessionID Vi, const char *Channel, float *AvgPower, PwrSnsrCondCodeEnum *AvgPowerCondCode, float *MaxPower, PwrSnsrCondCodeEnum *MaxPowerCondCode, float *MinPower, PwrSnsrCondCodeEnum *MinPowerCondCode, float *PkToAvgRatio, PwrSnsrCondCodeEnum *PkToAvgRatioCondCode, float *Marker1Power, PwrSnsrCondCodeEnum *Marker1PowerCondCode, float *Marker2Power, PwrSnsrCondCodeEnum *Marker2PowerCondCode, float *MarkerRatio, PwrSnsrCondCodeEnum *MarkerRatioCondCode)
 Returns an array of the current marker measurements for the specified channel. More...
 
EXPORT int PwrSnsr_FetchMarkerAverage (SessionID Vi, const char *Channel, int Marker, PwrSnsrCondCodeEnum *IsValid, float *Val)
 Forthe specified marker, return the average power or voltage at the marker. The units are the same as the specified channel. More...
 
EXPORT int PwrSnsr_FetchMarkerMax (SessionID Vi, const char *Channel, int Marker, PwrSnsrCondCodeEnum *IsValid, float *Val)
 Forthe specified marker, return the maximum power or voltage at the marker. The units are the same as the specified channel. More...
 
EXPORT int PwrSnsr_FetchMarkerMin (SessionID Vi, const char *Channel, int Marker, PwrSnsrCondCodeEnum *IsValid, float *Val)
 Forthe specified marker, return the minimum power or voltage at the marker. The units are the same as the specified channel. More...
 
EXPORT int PwrSnsr_ReadArrayMarkerPower (SessionID Vi, const char *Channel, float *AvgPower, PwrSnsrCondCodeEnum *AvgPowerCondCode, float *MaxPower, PwrSnsrCondCodeEnum *MaxPowerCondCode, float *MinPower, PwrSnsrCondCodeEnum *MinPowerCondCode, float *PkToAvgRatio, PwrSnsrCondCodeEnum *PkToAvgRatioCondCode, float *Marker1Power, PwrSnsrCondCodeEnum *Marker1PowerCondCode, float *Marker2Power, PwrSnsrCondCodeEnum *Marker2PowerCondCode, float *MarkerRatio, PwrSnsrCondCodeEnum *MarkerRatioCondCode)
 Returns an array of the current marker measurements for the specified channel. More...
 
EXPORT int PwrSnsr_ReadMarkerAverage (SessionID Vi, const char *Channel, int Marker, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Forthe specified marker, return the average power or voltage at the marker. The units are the same as the specified channel. More...
 
EXPORT int PwrSnsr_ReadMarkerMax (SessionID Vi, const char *Channel, int Marker, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Forthe specified marker, return the maximum power or voltage at the marker. The units are the same as the specified channel. More...
 
EXPORT int PwrSnsr_ReadMarkerMin (SessionID Vi, const char *Channel, int Marker, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Forthe specified marker, return the minimum power or voltage at the marker. The units are the same as the specified channel. More...
 
EXPORT int PwrSnsr_FetchIntervalAvg (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the average power or voltage in the time interval between marker 1 and marker 2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_FetchIntervalFilteredMin (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the minmum power or voltage in the time interval between marker 1 and marker 2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_FetchIntervalFilteredMax (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the maximum filtered power or voltage in the time interval between marker 1 and marker 2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_FetchIntervalMax (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the maximum instantaneous power or voltage in the time interval between marker1 and marker 2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_FetchIntervalMin (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the minimum instantaneous power or voltage in the time interval between marker1 and marker 2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_FetchIntervalPkToAvg (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the peak-to-average ratio of the power or voltage between marker 1 and marker 2. The units are dB for logarithmic channel units or percent for linear channel units. More...
 
EXPORT int PwrSnsr_ReadIntervalAvg (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the average power or voltage in the time interval between marker 1 and marker 2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_ReadIntervalFilteredMin (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the minmum power or voltage in the time interval between marker 1 and marker 2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_ReadIntervalFilteredMax (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the maximum filtered power or voltage in the time interval between marker 1 and marker 2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_ReadIntervalMax (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the maximum instantaneous power or voltage in the time interval between marker1 and marker 2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_ReadIntervalMin (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the minimum instantaneous power or voltage in the time interval between marker1 and marker 2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_ReadIntervalPkToAvg (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the peak-to-average ratio of the power or voltage between marker 1 and marker 2. The units are dB for logarithmic channel units or percent for linear channel units. More...
 
EXPORT int PwrSnsr_FetchIntervalMaxAvg (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return maximum of the average power trace between MK1 and MK2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_FetchIntervalMinAvg (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return minimum of the average power trace between MK1 and MK2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_ReadIntervalMaxAvg (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return maximum of the average power trace between MK1 and MK2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_ReadIntervalMinAvg (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return minimum of the average power trace between MK1 and MK2. The units will be the same as the specified channel. More...
 
EXPORT int PwrSnsr_FetchMarkerDelta (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the difference between MK1 and MK2. The units will be the same as marker units. More...
 
EXPORT int PwrSnsr_FetchMarkerRatio (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the ratio of MK1 to MK2. The units will be dB for logarithmic units or percent for linear units. More...
 
EXPORT int PwrSnsr_FetchMarkerRDelta (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *condCode, float *Val)
 Return the difference between MK2 and MK1. The units will be the same as marker units. More...
 
EXPORT int PwrSnsr_FetchMarkerRRatio (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the ratio of MK2 to MK1. The units will be dB for logarithmic units or percent for linear units. More...
 
EXPORT int PwrSnsr_ReadMarkerDelta (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the difference between MK1 and MK2. The units will be the same as marker units. More...
 
EXPORT int PwrSnsr_ReadMarkerRatio (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the ratio of MK1 to MK2. The units will be dB for logarithmic units or percent for linear units. More...
 
EXPORT int PwrSnsr_ReadMarkerRDelta (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the difference between MK2 and MK1. The units will be the same as marker units. More...
 
EXPORT int PwrSnsr_ReadMarkerRRatio (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Return the ratio of MK2 to MK1. The units will be dB for logarithmic units or percent for linear units. More...
 
EXPORT int PwrSnsr_ReadCWPower (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *IsValid, float *Val)
 
EXPORT int PwrSnsr_ReadCWArray (SessionID Vi, const char *Channel, float *PeakAverage, PwrSnsrCondCodeEnum *PeakAverageValid, float *PeakMax, PwrSnsrCondCodeEnum *PeakMaxValid, float *PeakMin, PwrSnsrCondCodeEnum *PeakMinValid, float *PeakToAvgRatio, PwrSnsrCondCodeEnum *PeakToAvgRatioValid)
 Returns the current average, maximum, minimum powers or voltages and the peak-to-average ratio of the specified channel. Units are the same as the channel's units. Note the peak-to-average ratio and marker ratio are returned in dB for logarithmic channel units, and percent for all other channel units. More...
 
EXPORT int PwrSnsr_ReadPowerArray (SessionID Vi, const char *Channel, float *PulsePeak, PwrSnsrCondCodeEnum *PulsePeakValid, float *PulseCycleAvg, PwrSnsrCondCodeEnum *PulseCycleAvgValid, float *PulseOnAvg, PwrSnsrCondCodeEnum *PulseOnValid, float *IEEETop, PwrSnsrCondCodeEnum *IEEETopValid, float *IEEEBottom, PwrSnsrCondCodeEnum *IEEEBottomValid, float *Overshoot, PwrSnsrCondCodeEnum *OvershootValid, float *Droop, PwrSnsrCondCodeEnum *DroopValid)
 Returns an array of the current automatic amplitude measurements performed on a periodic pulse waveform.
More...
 
EXPORT int PwrSnsr_ReadTimeArray (SessionID Vi, const char *Channel, float *Frequency, PwrSnsrCondCodeEnum *FrequencyValid, float *Period, PwrSnsrCondCodeEnum *PeriodValid, float *Width, PwrSnsrCondCodeEnum *WidthValid, float *Offtime, PwrSnsrCondCodeEnum *OfftimeValid, float *DutyCycle, PwrSnsrCondCodeEnum *DutyCycleValid, float *Risetime, PwrSnsrCondCodeEnum *RisetimeValid, float *Falltime, PwrSnsrCondCodeEnum *FalltimeValid, float *EdgeDelay, PwrSnsrCondCodeEnum *EdgeDelayValid, float *Skew, PwrSnsrCondCodeEnum *SkewValid)
 Returns an array of the current automatic timing measurements performed on a periodic pulse waveform. More...
 
EXPORT int PwrSnsr_ReadDutyCycle (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Returns the ratio of the pulse on-time to off-time. More...
 
EXPORT int PwrSnsr_ReadEdgeDelay (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Returns time offset from the trigger reference to the first mesial transition level of either slope on the waveform. More...
 
EXPORT int PwrSnsr_ReadFallTime (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Returns the interval between the last signal crossing of the distal line to the last signal crossing of the proximal line. More...
 
EXPORT int PwrSnsr_ReadIEEEBottom (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Returns the IEEE-define base line, i.e. The two portions of a pulse waveform which represent the first nominal state from which a pulse departs and to which it ultimately returns. More...
 
EXPORT int PwrSnsr_ReadIEEETop (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Returns the IEEE-defined top line, i.e. the portion of a pulse waveform which represents the second nominal state of a pulse. More...
 
EXPORT int PwrSnsr_ReadOfftime (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Returns the time a repetitive pulse is off. (Equal to the pulse period minus the pulse width). More...
 
EXPORT int PwrSnsr_ReadOvershoot (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Returns the difference between the distortion following a major transition and the IEEE top line in dB or percent, depending on the channel units. More...
 
EXPORT int PwrSnsr_ReadPeriod (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Returns the interval between two successive pulses. More...
 
EXPORT int PwrSnsr_ReadPRF (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Returns the number of cycles of a repetitive signal that take place in one second (Pulse Repetition Frequency). More...
 
EXPORT int PwrSnsr_ReadPulseCycleAvg (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Returns the average power of the entire pulse. More...
 
EXPORT int PwrSnsr_ReadPulseOnAverage (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Average power of the ON portion of the pulse. More...
 
EXPORT int PwrSnsr_ReadPulsePeak (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Returns the peak amplitude during the pulse. More...
 
EXPORT int PwrSnsr_ReadRiseTime (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Returns the interval between the first signal crossing of the proximal line to the first signal crossing of the distal line. More...
 
EXPORT int PwrSnsr_ReadWidth (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Returns the pulse width, i.e. the interval between the first and second signal crossings of the mesial line. More...
 
EXPORT int PwrSnsr_GetHorizontalOffset (SessionID Vi, const char *Channel, double *HorizontalOffset)
 Get the statistical mode horizontal scale offset in dB. The offset value will appear at the leftmost edge of the scale with units dBr (decibels relative). More...
 
EXPORT int PwrSnsr_SetHorizontalOffset (SessionID Vi, const char *Channel, double HorizontalOffset)
 Set the statistical mode horizontal scale offset in dB. The offset value will appear at the leftmost edge of the scale with units dBr (decibels relative). More...
 
EXPORT int PwrSnsr_GetHorizontalScale (SessionID Vi, const char *Channel, double *HorizontalScale)
 Get the statistical mode horizontal scale in dB/Div. More...
 
EXPORT int PwrSnsr_SetHorizontalScale (SessionID Vi, const char *Channel, double HorizontalScale)
 Set the statistical mode horizontal scale in dB/Div. More...
 
int EXPORT PwrSnsr_GetVerticalCenter (SessionID Vi, const char *Channel, float *VerticalCenter)
 Gets vertical center based on current units: <arg> = (range varies by units) More...
 
int EXPORT PwrSnsr_SetVerticalCenter (SessionID Vi, const char *Channel, float VerticalCenter)
 Sets vertical center based on current units: <arg> = (range varies by units) More...
 
int EXPORT PwrSnsr_GetVerticalScale (SessionID Vi, const char *Channel, float *VerticalScale)
 Gets vertical scale based on current units: <arg> = (range varies by units) More...
 
int EXPORT PwrSnsr_SetVerticalScale (SessionID Vi, const char *Channel, float VerticalScale)
 Sets vertical scale based on current units: <arg> = (range varies by units) More...
 
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_FetchCCDFTrace (SessionID Vi, const char *Channel, int TraceBufferSize, float Trace[], int *TraceActualSize)
 Returns the points in the CCDF trace. More...
 
EXPORT int PwrSnsr_StatModeReset (SessionID Vi, const char *Channel)
 Resets statistical capturing mode by clearing the buffers and restarting the aquisition timer. More...
 
EXPORT int PwrSnsr_FetchStatMeasurementArray (SessionID Vi, const char *Channel, double *Pavg, PwrSnsrCondCodeEnum *PavgCond, double *Ppeak, PwrSnsrCondCodeEnum *PpeakCond, double *Pmin, PwrSnsrCondCodeEnum *PminCond, double *PkToAvgRatio, PwrSnsrCondCodeEnum *PkToAvgRatioCond, double *CursorPwr, PwrSnsrCondCodeEnum *CursorPwrCond, double *CursorPct, PwrSnsrCondCodeEnum *CursorPctCond, double *SampleCount, PwrSnsrCondCodeEnum *SampleCountCond, double *SecondsRun, PwrSnsrCondCodeEnum *SecondsRunCond)
 Returns an array of the current automatic statistical measurements performed on a sample population. More...
 
EXPORT int PwrSnsr_FetchCCDFPower (SessionID Vi, const char *Channel, double Percent, PwrSnsrCondCodeEnum *CondCode, double *Val)
 Return relative power (in dB) for a given percent on the CCDF plot. More...
 
EXPORT int PwrSnsr_FetchCCDFPercent (SessionID Vi, const char *Channel, double Power, PwrSnsrCondCodeEnum *CondCode, double *Val)
 Return relative power (in dB) for a given percent on the CCDF plot. More...
 
EXPORT int PwrSnsr_GetCapture (SessionID Vi, const char *Channel, int *Capture)
 Get whether statistical capture is enabled. More...
 
EXPORT int PwrSnsr_SetCapture (SessionID Vi, const char *Channel, int Capture)
 Set whether statistical capture is enabled. More...
 
EXPORT int PwrSnsr_GetGating (SessionID Vi, const char *Channel, PwrSnsrStatGatingEnum *Gating)
 Get whether statistical capture is enabled. More...
 
EXPORT int PwrSnsr_SetGating (SessionID Vi, const char *Channel, PwrSnsrStatGatingEnum Gating)
 Set whether the statical capture is gated by markers or free-running. More...
 
EXPORT int PwrSnsr_GetTermAction (SessionID Vi, const char *Channel, PwrSnsrTermActionEnum *TermAction)
 Get the termination action for statistical capturing. More...
 
EXPORT int PwrSnsr_SetTermAction (SessionID Vi, const char *Channel, PwrSnsrTermActionEnum TermAction)
 Set the termination action for statistical capturing. More...
 
EXPORT int PwrSnsr_GetTermCount (SessionID Vi, const char *Channel, double *TermCount)
 Get the termination count for statistical capturing. After the sample count has been reached, the action determined by TermAction is taken. More...
 
EXPORT int PwrSnsr_SetTermCount (SessionID Vi, const char *Channel, double TermCount)
 Set the termination count for statistical capturing. After the sample count has been reached, the action determined by TermAction is taken. More...
 
EXPORT int PwrSnsr_GetTermTime (SessionID Vi, const char *Channel, int *TermTime)
 Get the termination time in seconds for statistical capturing. After the time has elapsed, the action determined by TermAction is taken. More...
 
EXPORT int PwrSnsr_SetTermTime (SessionID Vi, const char *Channel, int TermTime)
 Set the termination time in seconds (1 - 3600) for statistical capturing. After the time has elapsed, the action determined by TermAction is taken. More...
 
EXPORT int PwrSnsr_GetCCDFTraceCount (SessionID Vi, const char *Channel, int *TraceCount)
 Get the number of points in the CCDF trace plot. More...
 
EXPORT int PwrSnsr_SetCCDFTraceCount (SessionID Vi, const char *Channel, int TraceCount)
 Set the number of points (1 - 16384) in the CCDF trace plot. More...
 
EXPORT int PwrSnsr_FetchCursorPercent (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, double *Val)
 Returns the percent CCDF at the cursor. More...
 
EXPORT int PwrSnsr_FetchCursorPower (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, double *Val)
 Returns the power CCDF in dB at the cursor. More...
 
EXPORT int PwrSnsr_GetPercentPosition (SessionID Vi, const char *Channel, double *PercentPosition)
 Get the cursor percent on the CCDF plot. More...
 
EXPORT int PwrSnsr_SetPercentPosition (SessionID Vi, const char *Channel, double PercentPosition)
 Set the cursor percent on the CCDF plot. More...
 
EXPORT int PwrSnsr_SetPowerPosition (SessionID Vi, const char *Channel, double PowerPosition)
 Set the cursor power in dB on the CCDF plot. More...
 
EXPORT int PwrSnsr_GetPowerPosition (SessionID Vi, const char *Channel, double *PowerPosition)
 Get the cursor power in dB on the CCDF plot. More...
 
EXPORT int PwrSnsr_GetAcqStatusArray (SessionID Vi, const char *Channel, int *SweepLength, double *SampleRate, double *SweepRate, double *SweepTime, double *StartTime, int *StatusWord)
 Returns data about the status of the acquisition system. More...
 
EXPORT int PwrSnsr_GetDiagStatusArray (SessionID Vi, const char *Channel, float *DetectorTemp, float *CpuTemp, float *MioVoltage, float *VccInt10, float *VccAux18, float *Vcc50, float *Vcc25, float *Vcc33)
 Returns diagnostic data. More...
 
EXPORT int PwrSnsr_GetMarkerTimePosition (SessionID Vi, int MarkerNumber, float *TimePosition)
 Get the time (x-axis-position) of the selected marker relative to the trigger. More...
 
EXPORT int PwrSnsr_SetMarkerTimePosition (SessionID Vi, int MarkerNumber, float TimePosition)
 Set the time (x-axis-position) of the selected marker relative to the trigger. More...
 
EXPORT int PwrSnsr_GetMarkerPixelPosition (SessionID Vi, int MarkerNumber, int *PixelPosition)
 Get the horizontal pixel position (X-axis-position) of the selected vertical marker. There are 501 pixel positions numbered from 0 to 500 inclusive. More...
 
EXPORT int PwrSnsr_SetMarkerPixelPosition (SessionID Vi, int MarkerNumber, int PixelPosition)
 Set the horizontal pixel position (X-axis-position) of the selected vertical marker. There are 501 pixel positions numbered from 0 to 500 inclusive. More...
 
EXPORT int PwrSnsr_GetManufactureDate (SessionID Vi, const char *Channel, int ManufactureDateBufferSize, char ManufactureDate[])
 Date the sensor was manufactured in the following format YYYYmmDD. More...
 
EXPORT int PwrSnsr_GetImpedance (SessionID Vi, const char *Channel, float *Impedance)
 Input impedance of the sensor. More...
 
EXPORT int PwrSnsr_GetPeakPowerMax (SessionID Vi, const char *Channel, float *PeakPowerMax)
 Maximum power level the sensor can measure. More...
 
EXPORT int PwrSnsr_GetPeakPowerMin (SessionID Vi, const char *Channel, float *PeakPowerMin)
 Minimum power level the sensor can measure. More...
 
EXPORT int PwrSnsr_GetAttenuation (SessionID Vi, const char *Channel, float *Attenuation)
 Attenuation in dB for the sensor. More...
 
EXPORT int PwrSnsr_GetFactoryCalDate (SessionID Vi, const char *Channel, int FactoryCalDateBufferSize, char FactoryCalDate[])
 The date (YYYYmmDD) the last time the sensor was calibrated at the factory. More...
 
EXPORT int PwrSnsr_GetMinimumTrig (SessionID Vi, const char *Channel, float *MinimumTrig)
 Minimum internal trigger level in dBm. More...
 
EXPORT int PwrSnsr_GetMinFreqHighBandwidth (SessionID Vi, const char *Channel, float *MinFreqHighBandwidth)
 Minimum frequency of RF the sensor can measure in high bandwidth. More...
 
EXPORT int PwrSnsr_GetMaxFreqHighBandwidth (SessionID Vi, const char *Channel, float *MaxFreqHighBandwidth)
 Maximum frequency carrier the sensor can measure in high bandwidth. More...
 
EXPORT int PwrSnsr_GetMinFreqLowBandwidth (SessionID Vi, const char *Channel, float *MinFreqLowBandwidth)
 Minimum frequency carrier the sensor can measure in low bandwidth. More...
 
EXPORT int PwrSnsr_GetMaxFreqLowBandwidth (SessionID Vi, const char *Channel, float *MaxFreqLowBandwidth)
 Maximum frequency carrier the sensor can measure in low bandwidth. More...
 
EXPORT int PwrSnsr_GetFpgaVersion (SessionID Vi, const char *Channel, int ValBufferSize, char Val[])
 Get the sensor FPGA version. More...
 
EXPORT int PwrSnsr_GetExternalSkew (SessionID Vi, const char *Channel, float *External)
 Gets the skew in seconds for the external trigger. More...
 
EXPORT int PwrSnsr_SetExternalSkew (SessionID Vi, const char *Channel, float External)
 Sets the skew in seconds for the external trigger. More...
 
EXPORT int PwrSnsr_GetSlaveSkew (SessionID Vi, const char *Channel, float *SlaveSkew)
 Gets the skew in seconds for the slave trigger. More...
 
EXPORT int PwrSnsr_SetSlaveSkew (SessionID Vi, const char *Channel, float SlaveSkew)
 Sets the skew in seconds for the slave trigger. More...
 
EXPORT int PwrSnsr_GetInternalSkew (SessionID Vi, const char *Channel, float *InternalSkew)
 Gets the skew in seconds for the internal trigger. More...
 
EXPORT int PwrSnsr_SetInternalSkew (SessionID Vi, const char *Channel, float InternalSkew)
 Sets the skew in seconds for the internal trigger. More...
 
EXPORT int PwrSnsr_Zero (SessionID Vi, const char *Channel)
 Performs a zero offset null adjustment. More...
 
EXPORT int PwrSnsr_ZeroQuery (SessionID Vi, const char *Channel, int *Val)
 Performs a zero offset null adjustment and returns true if successful. More...
 
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_GetTimePerPoint (SessionID Vi, const char *Channel, float *TimePerPoint)
 Get time spacing for each waveform point in seconds. More...
 
EXPORT int PwrSnsr_GetSweepTime (SessionID Vi, const char *Channel, float *SweepTime)
 Get sweep time for the trace in seconds. More...
 
EXPORT int PwrSnsr_GetChanTraceCount (SessionID Vi, const char *Channel, int *TraceCount)
 Get the number of points in the CCDF trace plot. More...
 
EXPORT int PwrSnsr_GetTraceStartTime (SessionID Vi, const char *Channel, float *TraceStartTime)
 Get time offset (start time) of the trace in seconds. May be negative, indicating pre-trigger information. More...
 
EXPORT int PwrSnsr_FetchDistal (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Returns the actual detected power of the distal level in the current channel units. More...
 
EXPORT int PwrSnsr_FetchMesial (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Returns the actual detected power of the mesial level in the current channel units. More...
 
EXPORT int PwrSnsr_FetchProximal (SessionID Vi, const char *Channel, PwrSnsrCondCodeEnum *CondCode, float *Val)
 Returns the actual detected power of the proximal level in the current channel units. More...
 
EXPORT int PwrSnsr_FetchAllMultiPulse (SessionID Vi, const char *Channel, int PulseInfosSize, PulseInfo PulseInfos[], int *PulseInfosActualSize)
 Return all previously acquired multiple pulse measurements. The elements in the PulseInfos array correspond to pulses on the current trace from left to right (ascending time order). More...
 
EXPORT int PwrSnsr_SetTrigOutMode (SessionID Vi, const char *Channel, int Mode)
 Sets the trigger out/mult io mode. Setting trigger mode overrides this command. More...
 
EXPORT int PwrSnsr_SaveToMemoryChannel (SessionID Vi, const char *memChan, const char *ChannelName)
 Saves the given channel to a memory channel. If the memory channel does not exist, a new one is created. More...
 
EXPORT int PwrSnsr_GetMemChanArchive (SessionID Vi, const char *memChan, int ValBufferSize, char Val[])
 Returns an XML document containing settings and readings obtained using the SaveToMemoryChannel method. More...
 
EXPORT int PwrSnsr_LoadMemChanFromArchive (SessionID Vi, const char *memChan, const char *ArchiveContent)
 Loads the named memory channel using the given archive. If the memory channel does not exist, one is created. More...
 
EXPORT int PwrSnsr_SaveUserCal (SessionID Vi, const char *Channel)
 Instructs power meter to save the value of fixed cal, zero, and skew values. More...
 
EXPORT int PwrSnsr_ClearUserCal (SessionID Vi, const char *Channel)
 Resets the value of fixed cal, zero, and skew to factory defaults. 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_GetIsAvailable (SessionID Vi, const char *Channel, int *IsAvailable)
 Returns true if modulated/CW measurement system is available. Will always return false if measurement buffer is enabled. More...
 
EXPORT int PwrSnsr_GetIsRunning (SessionID Vi, const char *Channel, int *IsRunning)
 Returns true if modulated/CW measuremnts are actively running. More...
 
EXPORT int PwrSnsr_GetReadingPeriod (SessionID Vi, const char *Channel, float *ReadingPeriod)
 Returns the period (rate) in seconds per new filtered reading. More...
 
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, long long 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, long long 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_Write (SessionID Vi, const char *Channel, int DataBufferSize, unsigned char Data[])
 Write a byte array to the meter. More...
 
EXPORT int PwrSnsr_ReadByteArray (SessionID Vi, const char *Channel, int Count, int ValBufferSize, unsigned char Val[], int *ValActualSize)
 Reads byte array from the meter. More...
 
EXPORT int PwrSnsr_ReadControl (SessionID Vi, const char *Channel, int Count, int ValBufferSize, unsigned char Val[], int *ValActualSize)
 Reads a control transfer on the USB. 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...
 
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...
 
EXPORT int PwrSnsr_GetDongleSerialNumber (long *val)
 Get the hardware license serial number. More...
 
EXPORT int PwrSnsr_GetExpirationDate (int *Date)
 Get the hardware license expiration date. More...
 
EXPORT int PwrSnsr_GetNumberOfCals (long *val)
 Get the number of calibrations left on the license. More...
 
EXPORT int PwrSnsr_IsLicenseDongleConnected (int *val)
 Get whether the hardware license dongle is connected. More...
 

Detailed Description

File containing all user-callable functions.

Typedef Documentation

◆ PulseInfo

typedef struct PulseInfo PulseInfo

Data structure containing pulse information.

◆ PwrSnsrAcquisitionStatusEnum

◆ PwrSnsrBandwidthEnum

Video bandwidth enumeration.

◆ PwrSnsrCondCodeEnum

Condition code indicating validity of the measurement.

◆ PwrSnsrErrorCodesEnum

Error codes

◆ PwrSnsrFilterStateEnum

Filter state enum.

◆ PwrSnsrHoldoffModeEnum

Trigger holdoff mode.

◆ PwrSnsrMarkerNumberEnum

Marker number enumeration.

◆ PwrSnsrMeasBuffGateEnum

Measurement buffer gate modes.

◆ PwrSnsrMeasBuffStartModeEnum

Measurement buffer start modes.

◆ PwrSnsrMeasBuffStopReasonEnum

Measurement buffer stop reason.

◆ PwrSnsrPulseUnitsEnum

Enum for pulse calculation units.

◆ PwrSnsrRdgsEnableFlag

Select the action to take when either the statistical terminalcount is reached or the terminal time has elapsed.

◆ PwrSnsrStatGatingEnum

Gating value for statistical capture.

◆ PwrSnsrTermActionEnum

Select the action to take when either the statistical terminalcount is reached or the terminal time has elapsed.

◆ PwrSnsrTriggerModeEnum

Trigger mode for synchronizing data acquisition with pulsed signals.

◆ PwrSnsrTriggerPositionEnum

Set or return the position of the trigger event on displayed sweep.

◆ PwrSnsrTriggerSlopeEnum

Values for edge trigger slope

◆ PwrSnsrTriggerSourceEnum

Trigger source used for synchronizing data acquisition.

◆ PwrSnsrTriggerStatusEnum

Trigger status of the acquisition system.

◆ PwrSnsrTrigOutModeEnum

Multi IO trigger out modes.

◆ PwrSnsrUnitsEnum

Units returned by channel measurements.

Enumeration Type Documentation

◆ PwrSnsrAcquisitionStatusEnum

Enumerator
PwrSnsrAcqComplete 

The meter has completed the acquisition..

PwrSnsrAcqInProgress 

The meter is still acquiring data.

PwrSnsrAcqStatusUnknown 

The meter cannot determine the status of the acquisition.

◆ PwrSnsrBandwidthEnum

Video bandwidth enumeration.

Enumerator
PwrSnsrBandwidthHigh 

High bandwidth.

PwrSnsrBandwidthLow 

Low bandwidth.

◆ PwrSnsrCondCodeEnum

Condition code indicating validity of the measurement.

Enumerator
PwrSnsrCondCodeMeasurementStopped 

Measurement is STOPPED. Value returned is not updated.

PwrSnsrCondCodeError 

Error return. Measurement is not valid.

PwrSnsrCondCodeUnderrange 

An Over-range condition exists.

PwrSnsrCondCodeOverrange 

An Under-range condition exists.

PwrSnsrCondCodeNormal 

Normal return. No error.

◆ PwrSnsrErrorCodesEnum

Error codes

Enumerator
PWR_SNSR_IO_GENERAL 

I/O error.

PWR_SNSR_IO_TIMEOUT 

I/O timeout error.

PWR_SNSR_MODEL_NOT_SUPPORTED 

Instrument model does not support this feature.

PWR_SNSR_INV_PARAMETER 

Invalid parameter value

PWR_SNSR_ERROR_INVALID_SESSION_HANDLE 

Session ID invalid.

PWR_SNSR_ERROR_STATUS_NOT_AVAILABLE 

Status not available.

PWR_SNSR_ERROR_RESET_FAILED 

Reset failed.

PWR_SNSR_ERROR_RESOURCE_UNKNOWN 

Unknown resource descriptor.

PWR_SNSR_ERROR_ALREADY_INITIALIZED 

Session already initialized.

PWR_SNSR_ERROR_OUT_OF_MEMORY 

Out of memory.

PWR_SNSR_ERROR_OPERATION_PENDING 

Operation pending.

PWR_SNSR_ERROR_NULL_POINTER 

Null pointer not allowed.

PWR_SNSR_ERROR_UNEXPECTED_RESPONSE 

Unexpected response from the instrument.

PWR_SNSR_ERROR_NOT_INITIALIZED 

Session not initialized.

PWR_SNSR_LIBUSB_ERROR_IO 

Input/output error

PWR_SNSR_LIBUSB_ERROR_INVALID_PARAM 

Invalid parameter

PWR_SNSR_LIBUSB_ERROR_ACCESS 

Access denied (insufficient permissions)

PWR_SNSR_LIBUSB_ERROR_NO_DEVICE 

No such device (it may have been disconnected)

PWR_SNSR_LIBUSB_ERROR_NOT_FOUND 

Entity not found

PWR_SNSR_LIBUSB_ERROR_BUSY 

Resource busy

PWR_SNSR_LIBUSB_ERROR_TIMEOUT 

Operation timed out

PWR_SNSR_LIBUSB_ERROR_OVERFLOW 

Overflow

PWR_SNSR_LIBUSB_ERROR_PIPE 

Pipe error

PWR_SNSR_LIBUSB_ERROR_INTERRUPTED 

System call interrupted (perhaps due to signal)

PWR_SNSR_LIBUSB_ERROR_NO_MEM 

Insufficient memory

PWR_SNSR_LIBUSB_ERROR_NOT_SUPPORTED 

Operation not supported or unimplemented on this platform

PWR_SNSR_LIBUSB_ERROR_OTHER 

Other error

◆ PwrSnsrFilterStateEnum

Filter state enum.

Enumerator
PwrSnsrFilterStateOff 

Filter off.

PwrSnsrFilterStateOn 

Filter on.

PwrSnsrFilterStateAuto 

Automatically calculated filter.

◆ PwrSnsrHoldoffModeEnum

Trigger holdoff mode.

Enumerator
PwrSnsrHoldoffModeNormal 

Trigger will not arm again after the trigger conditions and its inverse are satisfied and then the amount of time set for trigger holdoff.

PwrSnsrHoldoffModeGap 

Trigger will not arm again after the trigger conditions are satisfied and then the amount of time set for trigger holdoff.

◆ PwrSnsrMarkerNumberEnum

Marker number enumeration.

Enumerator
PwrSnsrMarkerNumberMarker1 

Marker 1

PwrSnsrMarkerNumberMarker2 

Marker2

◆ PwrSnsrMeasBuffGateEnum

Measurement buffer gate modes.

◆ PwrSnsrMeasBuffStartModeEnum

Measurement buffer start modes.

◆ PwrSnsrMeasBuffStopReasonEnum

Measurement buffer stop reason.

◆ PwrSnsrPulseUnitsEnum

Enum for pulse calculation units.

Enumerator
PwrSnsrPulseUnitsWatts 

Calculates distal, mesial, and proximal using watts.

PwrSnsrPulseUnitsVolts 

Calculates distal, mesial, and proximal using volts.

◆ PwrSnsrRdgsEnableFlag

Select the action to take when either the statistical terminalcount is reached or the terminal time has elapsed.

Enumerator
PwrSnsrSequenceEnable 

Enable sequence array capture.

PwrSnsrStartTimeEnable 

Enable start time array capture.

PwrSnsrDurationEnable 

Enable duration array capture.

PwrSnsrMinEnable 

Enable min measurement array capture.

PwrSnsrAvgEnable 

Enable average measurement capture.

PwrSnsrMaxEnable 

Enable max measurement capture.

◆ PwrSnsrStatGatingEnum

Gating value for statistical capture.

Enumerator
PwrSnsrStatGatingFreeRun 

No gating.

PwrSnsrStatGatingMarkers 

Gating is constrained to the portion of the the trace between the markers.

◆ PwrSnsrTermActionEnum

Select the action to take when either the statistical terminalcount is reached or the terminal time has elapsed.

Enumerator
PwrSnsrTermActionStop 

Stop accumulating samples and hold the result.

PwrSnsrTermActionRestart 

Clear the CCDF and begin a new one.

PwrSnsrTermActionDecimate 

Divide all sample bins by 2 and continue.

◆ PwrSnsrTriggerModeEnum

Trigger mode for synchronizing data acquisition with pulsed signals.

Enumerator
PwrSnsrTriggerModeNormal 

The power meter causes a sweep to be triggered each time the power level crosses the preset trigger level in the direction specified by the slope.

PwrSnsrTriggerModeAuto 

The power meter automatically triggers if the configured trigger does not occur within the meter's timeout period.

PwrSnsrTriggerModeAutoLevel 

The power meter automatically adjusts the trigger level the trigger level to halfway between the highest and lowest power levels detected.

◆ PwrSnsrTriggerPositionEnum

Set or return the position of the trigger event on displayed sweep.

Enumerator
PwrSnsrTriggerPositionLeft 

Left trigger position.

PwrSnsrTriggerPositionMiddle 

Middle trigger position.

PwrSnsrTriggerPositionRight 

Right trigger position.

◆ PwrSnsrTriggerSlopeEnum

Values for edge trigger slope

Enumerator
PwrSnsrTriggerSlopePositive 

A negative (falling) edge passing through the trigger level triggers the power meter.

PwrSnsrTriggerSlopeNegative 

A positive (rising) edge passing through the trigger level triggers the power meter.

◆ PwrSnsrTriggerSourceEnum

Trigger source used for synchronizing data acquisition.

Enumerator
PwrSnsrTriggerSourceChannel1 

Channel 1

PwrSnsrTriggerSourceExternal 

EXT setting uses the signal applied to the rear MULTI I/O connector.

PwrSnsrTriggerSourceChannel2 

Channel 2

PwrSnsrTriggerSourceChannel3 

Channel 3

PwrSnsrTriggerSourceChannel4 

Channel 4

PwrSnsrTriggerSourceChannel5 

Channel 5

PwrSnsrTriggerSourceChannel6 

Channel 6

PwrSnsrTriggerSourceChannel7 

Channel 7

PwrSnsrTriggerSourceChannel8 

Channel 8

PwrSnsrTriggerSourceChannel9 

Channel 9

PwrSnsrTriggerSourceChannel10 

Channel 10

PwrSnsrTriggerSourceChannel11 

Channel 11

PwrSnsrTriggerSourceChannel12 

Channel 12

PwrSnsrTriggerSourceChannel13 

Channel 13

PwrSnsrTriggerSourceChannel14 

Channel 14

PwrSnsrTriggerSourceChannel15 

Channel 15

PwrSnsrTriggerSourceChannel16 

Channel 16

PwrSnsrTriggerSourceIndependent 

Sets each sensor in a measurment group to use its own internal trigger.

◆ PwrSnsrTriggerStatusEnum

Trigger status of the acquisition system.

Enumerator
PwrSnsrTriggerStatusStopped 

Acquision is stopped.

PwrSnsrTriggerStatusPretrig 

Aquiring data and waiting for the pre-trigger to be satisfied.

PwrSnsrTriggerStatusWaiting 

Meter is armed and waiting for trigger event.

PwrSnsrTriggerStatusAcquiringNew 

Acquiring new data.

PwrSnsrTriggerStatusAutoTrig 

Meter is autotriggering.

PwrSnsrTriggerStatusFreerun 

Trigger is in free-run mode.

PwrSnsrTriggerStatusTriggered 

Meter is currently triggered.

PwrSnsrTriggerStatusRunning 

Acquisition is running.

◆ PwrSnsrTrigOutModeEnum

Multi IO trigger out modes.

◆ PwrSnsrUnitsEnum

Units returned by channel measurements.

Enumerator
PwrSnsrUnitsdBm 

dBm

PwrSnsrUnitswatts 

Watts

PwrSnsrUnitsvolts 

Volts

PwrSnsrUnitsDBV 

dBV

PwrSnsrUnitsDBMV 

dBmV

PwrSnsrUnitsDBUV 

dBuV

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_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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
TimeoutMaximum time in seconds to continue acquiring samples. Negative values will be treated as infinite.
CountNumber of samples to acquire.
StopReasonReason aqcuisition stopped.
ValNumber 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
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_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
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_ClearError()

EXPORT int PwrSnsr_ClearError ( SessionID  Vi)

This function clears the error code and error description for the given session.

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_ClearMeasurements()

EXPORT int PwrSnsr_ClearMeasurements ( SessionID  Vi)

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

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_ClearUserCal()

EXPORT int PwrSnsr_ClearUserCal ( SessionID  Vi,
const char *  Channel 
)

Resets the value of fixed cal, zero, and skew to factory defaults.

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".
Returns
Success (0) or error code.

◆ PwrSnsr_close()

EXPORT int PwrSnsr_close ( SessionID  Vi)

Closes the I/O session to the instrument. Driver methods and properties that access the instrument are not accessible after Close is called.

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_FetchAllMultiPulse()

EXPORT int PwrSnsr_FetchAllMultiPulse ( SessionID  Vi,
const char *  Channel,
int  PulseInfosSize,
PulseInfo  PulseInfos[],
int *  PulseInfosActualSize 
)

Return all previously acquired multiple pulse measurements. The elements in the PulseInfos array correspond to pulses on the current trace from left to right (ascending time order).

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".
PulseInfosSizeNumber of elements in PulseInfos array.
PulseInfosArray to fill with multi pulse information.
PulseInfosActualSizeActual number of valid elements in PulseInfos array.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchArrayMarkerPower()

EXPORT int PwrSnsr_FetchArrayMarkerPower ( SessionID  Vi,
const char *  Channel,
float *  AvgPower,
PwrSnsrCondCodeEnum AvgPowerCondCode,
float *  MaxPower,
PwrSnsrCondCodeEnum MaxPowerCondCode,
float *  MinPower,
PwrSnsrCondCodeEnum MinPowerCondCode,
float *  PkToAvgRatio,
PwrSnsrCondCodeEnum PkToAvgRatioCondCode,
float *  Marker1Power,
PwrSnsrCondCodeEnum Marker1PowerCondCode,
float *  Marker2Power,
PwrSnsrCondCodeEnum Marker2PowerCondCode,
float *  MarkerRatio,
PwrSnsrCondCodeEnum MarkerRatioCondCode 
)

Returns an array of the current marker measurements for the specified channel.

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".
AvgPowerAverage power between the markers.
AvgPowerCondCodeCondition code.
MaxPowerMaximum power between the markers.
MaxPowerCondCodeCondition code.
MinPowerMinimum power between the markers.
MinPowerCondCodeCondition code.
PkToAvgRatioThe ratio of peak to average power between the markers.
PkToAvgRatioCondCodeCondition code.
Marker1PowerThe power at Marker 1.
Marker1PowerCondCodeCondition code.
Marker2PowerThe power at Marker 2.
Marker2PowerCondCodeCondition code.
MarkerRatioRatio of power at Marker 1 and power at Marker 2.
MarkerRatioCondCodeCondition code.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchCCDFPercent()

EXPORT int PwrSnsr_FetchCCDFPercent ( SessionID  Vi,
const char *  Channel,
double  Power,
PwrSnsrCondCodeEnum CondCode,
double *  Val 
)

Return relative power (in dB) for a given percent on the CCDF plot.

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".
PowerRelative power in dB
CondCodeCondition code for the measurement.
ValPercent measurement at power.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchCCDFPower()

EXPORT int PwrSnsr_FetchCCDFPower ( SessionID  Vi,
const char *  Channel,
double  Percent,
PwrSnsrCondCodeEnum CondCode,
double *  Val 
)

Return relative power (in dB) for a given percent on the CCDF plot.

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".
PercentStatistical percent to retrieve power from.
CondCodeCondition code for the measurement.
Valrelative power at percent.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchCCDFTrace()

EXPORT int PwrSnsr_FetchCCDFTrace ( SessionID  Vi,
const char *  Channel,
int  TraceBufferSize,
float  Trace[],
int *  TraceActualSize 
)

Returns the points in the CCDF trace.

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".
TraceBufferSize
Trace
TraceActualSize
Returns
Success (0) or error code.

◆ PwrSnsr_FetchCursorPercent()

EXPORT int PwrSnsr_FetchCursorPercent ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
double *  Val 
)

Returns the percent CCDF at the cursor.

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".
CondCodeCondition code for the measurement.
Val
Returns
Success (0) or error code.

◆ PwrSnsr_FetchCursorPower()

EXPORT int PwrSnsr_FetchCursorPower ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
double *  Val 
)

Returns the power CCDF in dB at the cursor.

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".
CondCodeCondition code for the measurement.
Val
Returns
Success (0) or error code.

◆ PwrSnsr_FetchCWArray()

EXPORT int PwrSnsr_FetchCWArray ( SessionID  Vi,
const char *  Channel,
float *  PeakAverage,
PwrSnsrCondCodeEnum PeakAverageValid,
float *  PeakMax,
PwrSnsrCondCodeEnum PeakMaxValid,
float *  PeakMin,
PwrSnsrCondCodeEnum PeakMinValid,
float *  PeakToAvgRatio,
PwrSnsrCondCodeEnum PeakToAvgRatioValid 
)

Returns the current average, maximum, minimum powers or voltages and the
peak-to-average ratio of the specified channel. Units are the same as the
channel units. Note the peak-to-average ratio and marker ratio are returned
in dB for logarithmic channel units, and percent for all other channel units.

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".
PeakAverageAverage power of the peak power envelope.
PeakAverageValidCondition code.
PeakMaxmaximum power of the peak power envelope.
PeakMaxValidCondition code.
PeakMinMinimum power of the peak power envelope.
PeakMinValidCondition code.
PeakToAvgRatioPeak to average ratio.
PeakToAvgRatioValidCondition code.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchCWPower()

EXPORT int PwrSnsr_FetchCWPower ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Returns the most recently acquired CW power.

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".
CondCodeCondition code for the measurement.
ValCW power in channel units.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchDistal()

EXPORT int PwrSnsr_FetchDistal ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Returns the actual detected power of the distal level in the current channel units.

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".
CondCodeCondition code for the measurement.
ValDetected power of the distal level in the current channel units.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchDutyCycle()

EXPORT int PwrSnsr_FetchDutyCycle ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum IsValid,
float *  Val 
)

Returns the ratio of the pulse on-time to off-time.

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".
IsValidCondition code.
ValMeasurement return value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchEdgeDelay()

EXPORT int PwrSnsr_FetchEdgeDelay ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum IsValid,
float *  Val 
)

Returns time offset from the trigger reference to the first mesial transition level of either slope on the waveform.

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".
IsValid
Val
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_FetchFallTime()

EXPORT int PwrSnsr_FetchFallTime ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum IsValid,
float *  Val 
)

Returns the interval between the last signal crossing of the distal line to the last signalcrossing of the proximal line.

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".
IsValidCondition code.
ValMeasurement return value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchIEEEBottom()

EXPORT int PwrSnsr_FetchIEEEBottom ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum IsValid,
float *  Val 
)

Returns the IEEE-define base line, i.e. The two portions of a pulse waveform which represent the first nominal state from which a pulse departs and to which it ultimately returns.

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".
IsValidCondition code.
ValMeasurement return value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchIEEETop()

EXPORT int PwrSnsr_FetchIEEETop ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum IsValid,
float *  Val 
)

Returns the IEEE-defined top line, i.e. the portion of a pulse waveform which represents the second nominal state of a pulse.

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".
IsValidCondition code.
ValMeasurement return value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchIntervalAvg()

EXPORT int PwrSnsr_FetchIntervalAvg ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the average power or voltage in the time interval between marker 1 and marker 2. The units will be the same as the specified channel.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchIntervalFilteredMax()

EXPORT int PwrSnsr_FetchIntervalFilteredMax ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the maximum filtered power or voltage in the time interval between marker 1 and marker 2. The units will be the same as the specified channel.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchIntervalFilteredMin()

EXPORT int PwrSnsr_FetchIntervalFilteredMin ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the minmum power or voltage in the time interval between marker 1 and marker 2. The units will be the same as the specified channel.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchIntervalMax()

EXPORT int PwrSnsr_FetchIntervalMax ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the maximum instantaneous power or voltage in the time interval between marker1 and marker 2. The units will be the same as the specified channel.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchIntervalMaxAvg()

EXPORT int PwrSnsr_FetchIntervalMaxAvg ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return maximum of the average power trace between MK1 and MK2. The units will be the same as the specified channel.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchIntervalMin()

EXPORT int PwrSnsr_FetchIntervalMin ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the minimum instantaneous power or voltage in the time interval between marker1 and marker 2. The units will be the same as the specified channel.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchIntervalMinAvg()

EXPORT int PwrSnsr_FetchIntervalMinAvg ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return minimum of the average power trace between MK1 and MK2. The units will be the same as the specified channel.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchIntervalPkToAvg()

EXPORT int PwrSnsr_FetchIntervalPkToAvg ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the peak-to-average ratio of the power or voltage between marker 1 and marker 2. The units are dB for logarithmic channel units or percent for linear channel units.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchMarkerAverage()

EXPORT int PwrSnsr_FetchMarkerAverage ( SessionID  Vi,
const char *  Channel,
int  Marker,
PwrSnsrCondCodeEnum IsValid,
float *  Val 
)

Forthe specified marker, return the average power or voltage at the marker. The units are the same as the specified channel.

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".
MarkerMarker number.
IsValidCondition code.
ValMeasurement value
Returns
Success (0) or error code.

◆ PwrSnsr_FetchMarkerDelta()

EXPORT int PwrSnsr_FetchMarkerDelta ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the difference between MK1 and MK2. The units will be the same as marker units.

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".
CondCodeCondition code for the measurement.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchMarkerMax()

EXPORT int PwrSnsr_FetchMarkerMax ( SessionID  Vi,
const char *  Channel,
int  Marker,
PwrSnsrCondCodeEnum IsValid,
float *  Val 
)

Forthe specified marker, return the maximum power or voltage at the marker. The units are the same as the specified channel.

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".
MarkerMarker number.
IsValid
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchMarkerMin()

EXPORT int PwrSnsr_FetchMarkerMin ( SessionID  Vi,
const char *  Channel,
int  Marker,
PwrSnsrCondCodeEnum IsValid,
float *  Val 
)

Forthe specified marker, return the minimum power or voltage at the marker. The units are the same as the specified channel.

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".
MarkerMarker number.
IsValid
Valmeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchMarkerRatio()

EXPORT int PwrSnsr_FetchMarkerRatio ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the ratio of MK1 to MK2. The units will be dB for logarithmic units or percent for linear units.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchMarkerRDelta()

EXPORT int PwrSnsr_FetchMarkerRDelta ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum condCode,
float *  Val 
)

Return the difference between MK2 and MK1. The units will be the same as marker units.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchMarkerRRatio()

EXPORT int PwrSnsr_FetchMarkerRRatio ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the ratio of MK2 to MK1. The units will be dB for logarithmic units or percent for linear units.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchMesial()

EXPORT int PwrSnsr_FetchMesial ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Returns the actual detected power of the mesial level in the current channel units.

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".
CondCodeCondition code for the measurement.
ValDetected power of the mesial level in the current channel units.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchOfftime()

EXPORT int PwrSnsr_FetchOfftime ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum IsValid,
float *  Val 
)

Returns the time a repetitive pulse is off. (Equal to the pulse period minus the pulsewidth).

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".
IsValidCondition code.
ValMeasurement return value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchOvershoot()

EXPORT int PwrSnsr_FetchOvershoot ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum IsValid,
float *  Val 
)

Returns the difference between the distortion following a major transition and the IEEE top line in dB or percent, depending on the channel units.

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".
IsValidCondition code.
ValMeasurement return value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchPeriod()

EXPORT int PwrSnsr_FetchPeriod ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum IsValid,
float *  Val 
)

Returns the interval between two successive pulses. (Reciprocal of the Pulse RepetitionFrequency)

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".
IsValidCondition code.
ValMeasurement return value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchPowerArray()

EXPORT int PwrSnsr_FetchPowerArray ( SessionID  Vi,
const char *  Channel,
float *  PulsePeak,
PwrSnsrCondCodeEnum PulsePeakValid,
float *  PulseCycleAvg,
PwrSnsrCondCodeEnum PulseCycleAvgValid,
float *  PulseOnAvg,
PwrSnsrCondCodeEnum PulseOnValid,
float *  IEEETop,
PwrSnsrCondCodeEnum IEEETopValid,
float *  IEEEBottom,
PwrSnsrCondCodeEnum IEEEBottomValid,
float *  Overshoot,
PwrSnsrCondCodeEnum OvershootValid,
float *  Droop,
PwrSnsrCondCodeEnum DroopValid 
)

Returns an array of the current automatic amplitude measurements performed on
a periodic pulse waveform.

Measurements performed are: peak amplitude during
the pulse, average amplitude over a full cycle of the pulse waveform, average
amplitude during the pulse, IEEE top amplitude, IEEE bottom amplitude, and overshoot.
Units are the same as the channel's units.

Note the pulse overshoot is returned in dB for logarithmic channel units,
and percent for all other units. Also, the pulse ?ON interval used for peak

and average calculations is defined by the SENSe:PULSe:STARTGT and :ENDGT time gating settings.
A full pulse (rise and fall) must be visible on the display to make average
and peak pulse power measurements, and a full cycle of the waveform must be
visible to calculate average cycle amplitude.

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".
PulsePeakThe peak amplitude during the pulse.
PulsePeakValidCondition code.
PulseCycleAvgAverage cycle amplitude.
PulseCycleAvgValidCondition code.
PulseOnAvgAverage power of the ON portion of the pulse.
PulseOnValidCondition code.
IEEETopThe IEEE-defined top line, i.e. the portion of a pulse waveform, which represents the second nominal state of a pulse.
IEEETopValidCondition code.
IEEEBottomThe IEEE-define base line, i.e. The two portions of a pulse waveform which represent the first nominal state from which a pulse departs and to which it ultimately returns.
IEEEBottomValidCondition code.
OvershootThe difference between the distortion following a major transition and the IEEE top line in dB or percent,depending on the channel units.
OvershootValidCondition code.
DroopPulse droop.
DroopValidCondition code.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchPRF()

EXPORT int PwrSnsr_FetchPRF ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum IsValid,
float *  Val 
)

Returns the number of cycles of a repetitive signal that take place in one second (Pulse Repetition Frequency).

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".
IsValidCondition code.
ValMeasurement return value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchProximal()

EXPORT int PwrSnsr_FetchProximal ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Returns the actual detected power of the proximal level in the current channel units.

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".
CondCodeCondition code for the measurement.
ValDetected power of the proximal level in the current channel units.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchPulseCycleAvg()

EXPORT int PwrSnsr_FetchPulseCycleAvg ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum IsValid,
float *  Val 
)

Returns the average power of the entire pulse.

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".
IsValidCondition code.
ValMeasurement return value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchPulseOnAverage()

EXPORT int PwrSnsr_FetchPulseOnAverage ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum IsValid,
float *  Val 
)

Average power of the ON portion of the pulse.

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".
IsValidCondition code.
ValMeasurement return value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchPulsePeak()

EXPORT int PwrSnsr_FetchPulsePeak ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum IsValid,
float *  Val 
)

Returns the peak amplitude during the pulse.

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".
IsValidCondition code.
ValMeasurement return value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchRiseTime()

EXPORT int PwrSnsr_FetchRiseTime ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum IsValid,
float *  Val 
)

Returns the interval between the first signal crossing of the proximal line to the first signal crossing of the distal line.

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".
IsValidCondition code.
ValMeasurement return value.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchStatMeasurementArray()

EXPORT int PwrSnsr_FetchStatMeasurementArray ( SessionID  Vi,
const char *  Channel,
double *  Pavg,
PwrSnsrCondCodeEnum PavgCond,
double *  Ppeak,
PwrSnsrCondCodeEnum PpeakCond,
double *  Pmin,
PwrSnsrCondCodeEnum PminCond,
double *  PkToAvgRatio,
PwrSnsrCondCodeEnum PkToAvgRatioCond,
double *  CursorPwr,
PwrSnsrCondCodeEnum CursorPwrCond,
double *  CursorPct,
PwrSnsrCondCodeEnum CursorPctCond,
double *  SampleCount,
PwrSnsrCondCodeEnum SampleCountCond,
double *  SecondsRun,
PwrSnsrCondCodeEnum SecondsRunCond 
)

Returns an array of the current automatic statistical measurements performed on a sample population.

Measurements performed are: long term average, peak and minimum amplitude, peak-to-average ratio, amplitude at the CCDF percent cursor, statistical percent at the CCDF power cursor, and the sample population size in samples. Note the peak-to-average ratio is returned in dB for logarithmic channel units, and percent for all other channel units.

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".
PavgLong term average power in channel units.
PavgCondCondition code.
PpeakPeak power in channel units.
PpeakCondCondition code.
PminMinimum power in channel units.
PminCondCondition code.
PkToAvgRatioPeak-to-average power in percent or dB.
PkToAvgRatioCondCondition code.
CursorPwrPower at the cursor in channel units.
CursorPwrCondCondition code.
CursorPctStatistical percent at the cursor.
CursorPctCondCondition code.
SampleCountPopulation size in samples.
SampleCountCondCondition code.
SecondsRunNumber of seconds the measurement has run.
SecondsRunCondCondition code.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchTimeArray()

EXPORT int PwrSnsr_FetchTimeArray ( SessionID  Vi,
const char *  Channel,
float *  Frequency,
PwrSnsrCondCodeEnum FrequencyValid,
float *  Period,
PwrSnsrCondCodeEnum PeriodValid,
float *  Width,
PwrSnsrCondCodeEnum WidthValid,
float *  Offtime,
PwrSnsrCondCodeEnum OfftimeValid,
float *  DutyCycle,
PwrSnsrCondCodeEnum DutyCycleValid,
float *  Risetime,
PwrSnsrCondCodeEnum RisetimeValid,
float *  Falltime,
PwrSnsrCondCodeEnum FalltimeValid,
float *  EdgeDelay,
PwrSnsrCondCodeEnum EdgeDelayValid,
float *  Skew,
PwrSnsrCondCodeEnum SkewValid 
)

Returns an array of the current automatic timing measurements performed on a periodic pulse waveform.

Measurements performed are: the frequency, period, width, offtime and duty cycle of the pulse waveform, and the risetime and falltime of the edge transitions. For each of the measurements to be performed, the appropriate items to be measured must within the trace window. Pulse frequency, period, offtime and duty cycle measurements require that an entire cycle of the pulse waveform (minimum of three edge transitions) be present. Pulse width measurement requires that at least one full pulse is visible, and is most accurate if the pulse width is at least 0.4 divisions. Risetime and falltime measurements require that the edge being measured is visible, and will be most accurate if the transition takes at least 0.1 divisions. It is always best to have the power meter set on the fastest timebase possible that meets the edge visibility restrictions. Set the trace averaging as high as practical to reduce fluctuations and noise in the pulse timing measurements. Note that the timing of the edge transitions is defined by the settings of the SENSe:PULSe:DISTal, :MESIal and :PROXimal settings; see the descriptions Forthose commands. Units are the same as the channel's units.

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".
FrequencyThe number of cycles of a repetitive signal that take place in one second (Pulse Repetition Frequency).
FrequencyValidCondition code.
PeriodThe interval between two successive pulses.
PeriodValidCondition code.
WidthThe interval between the first and second signal crossings of the mesial line.
WidthValidCondition code.
OfftimeThe time a repetitive pulse is off. (Equal to the pulse period minus the pulse width).
OfftimeValidCondition code.
DutyCycleThe ratio of the pulse on-time to period.
DutyCycleValidCondition code.
RisetimeThe interval between the first signal crossing of the proximal line to the first signal crossing of the distal line.
RisetimeValidCondition code.
FalltimeThe interval between the last signal crossing of the distal line to the last signal crossing of the proximal line.
FalltimeValidCondition code.
EdgeDelayTime offset from the trigger reference to the first mesial transition level of either slope on the waveform.
EdgeDelayValidCondition code.
SkewThe trigger offset between the assigned trigger channel and this channel.
SkewValidCondition code.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchWaveform()

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

Returns a previously acquired waveform for this channel. The acquisition must be made prior to calling this method. Call this method separately for each channel.

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".
WaveformArrayBufferSizeSize in bytes of the Waveform buffer.
WaveformArrayThe array contains the average waveform. Units for the individual array elements are in the channel units setting.
WaveformArrayActualSizeSize in bytes of the data written to WaveformArray.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchWaveformMinMax()

EXPORT int PwrSnsr_FetchWaveformMinMax ( SessionID  Vi,
const char *  Channel,
int  MinWaveformBufferSize,
float  MinWaveform[],
int *  MinWaveformActualSize,
int  MaxWaveformBufferSize,
float  MaxWaveform[],
int *  MaxWaveformActualSize,
int  WaveformArrayBufferSize,
float  WaveformArray[],
int *  WaveformArrayActualSize 
)

Returns the previously acquired minimum and maximum waveforms for this specified channel. The acquisition must be made prior to calling this method. Call this method separately for each channel.

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".
MinWaveformBufferSizeSize in bytes of the MinWaveform buffer.
MinWaveformThis array contains the min waveform. Units for the individual array elements are in the channel units setting.
MinWaveformActualSizeSize in bytes of the data written to MinWaveform.
MaxWaveformBufferSizeSize in bytes of the MaxWaveform buffer.
MaxWaveformThis array contains the max waveform. Units for the individual array elements are in the channel units setting.
MaxWaveformActualSizeSize in bytes of the data written to MaxWaveform.
WaveformArrayBufferSizeSize in bytes of the Waveform buffer.
WaveformArrayThe array contains the average waveform. Units for the individual array elements are in the channel units setting.
WaveformArrayActualSizeSize in bytes of the data written to WaveformArray.
Returns
Success (0) or error code.

◆ PwrSnsr_FetchWidth()

EXPORT int PwrSnsr_FetchWidth ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum IsValid,
float *  Val 
)

Returns the pulse width, i.e. the interval between the first and second signal crossings of the mesial line.

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".
IsValidCondition code.
ValMeasurement return value.
Returns
Success (0) or error code.

◆ PwrSnsr_FindResources()

EXPORT int PwrSnsr_FindResources ( const char *  Delimiter,
int  ValBufferSize,
char  Val[] 
)

Returns a delimited string of available resources. These strings can be used in the initialize function to open a session to an instrument.

Parameters
DelimiterThe string used to delimit the list of resources ie. "|", " ", ";", etc.
ValBufferSizeNumber of elements in Val.
ValThe return string.
Returns
Success (0) or error code.

◆ PwrSnsr_GetAcqStatusArray()

EXPORT int PwrSnsr_GetAcqStatusArray ( SessionID  Vi,
const char *  Channel,
int *  SweepLength,
double *  SampleRate,
double *  SweepRate,
double *  SweepTime,
double *  StartTime,
int *  StatusWord 
)

Returns data about the status of the acquisition system.

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".
SweepLengthReturns the number of points in the trace.
SampleRateReturns the sample rate.
SweepRateReturns the number of triggered sweeps per second.
SweepTimeReturns the sweep time for the trace.
StartTimeReturns the start time relative to the trigger.
StatusWordInternal use - acquisition system status word.
Returns
Success (0) or error code.

◆ PwrSnsr_GetAttenuation()

EXPORT int PwrSnsr_GetAttenuation ( SessionID  Vi,
const char *  Channel,
float *  Attenuation 
)

Attenuation in dB for the sensor.

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".
Attenuation
Returns
Success (0) or error code.

◆ 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
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".
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
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".
Bandwidth
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
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".
ValBufferSizeBuffer size of Val.
ValArray of average measurements.
ValActualSizeActual 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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
MeasurementsAvailableThe 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_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
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".
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
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".
MaxFrequencyMaximum RF frequency measureable by this channel.
MinFrequencyMinimum RF frequency measureable by this channel.
FrequencyListBufferSizeNumber of elements in FrequencyList.
FrequencyListList of frequencies correlated to the cal factors.
FrequencyListActualSizeActual number of elements returned in FrequencyList.
CalFactorListBufferSizeNumber of elements in CalFactorList.
CalFactorListList of cal factors correlated to the frequencies.
CalFactorListActualSizeActual number of elements returned in CalFactorList.
BandwidthBandwidth of interest. Cal factors for low and high bandwidth are different.
Returns
Success (0) or error code.

◆ PwrSnsr_GetCapture()

EXPORT int PwrSnsr_GetCapture ( SessionID  Vi,
const char *  Channel,
int *  Capture 
)

Get whether statistical capture is enabled.

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".
Capture
Returns
Success (0) or error code.

◆ PwrSnsr_GetCCDFTraceCount()

EXPORT int PwrSnsr_GetCCDFTraceCount ( SessionID  Vi,
const char *  Channel,
int *  TraceCount 
)

Get the number of points in the CCDF trace plot.

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".
TraceCount
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelBuffer size for Channel
ChannelChannel number buffer
Indexthe 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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
CountNumber of channels
Returns
Success (0) or error code.

◆ PwrSnsr_GetChanTraceCount()

EXPORT int PwrSnsr_GetChanTraceCount ( SessionID  Vi,
const char *  Channel,
int *  TraceCount 
)

Get the number of points in the CCDF trace plot.

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".
TraceCountThe number of points in the CCDF trace plot.
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ContinuousCaptureTrue if AcquireMeasurements will stop the measurement buffer session or continue capturing measurement buffer entries after being called.
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
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".
CurrentTemp
Returns
Success (0) or error code.

◆ PwrSnsr_GetDiagStatusArray()

EXPORT int PwrSnsr_GetDiagStatusArray ( SessionID  Vi,
const char *  Channel,
float *  DetectorTemp,
float *  CpuTemp,
float *  MioVoltage,
float *  VccInt10,
float *  VccAux18,
float *  Vcc50,
float *  Vcc25,
float *  Vcc33 
)

Returns diagnostic data.

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".
DetectorTempTemperature in degrees C at the RF detector.
CpuTempTemperature of the CPU in degrees C.
MioVoltageVoltage at the Multi I/O port.
VccInt10Vcc 10 voltage.
VccAux18Vcc Aux 18 voltage.
Vcc50Vcc 50 voltage.
Vcc25Vcc 25 voltage.
Vcc33Vcc 33 voltage.
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
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".
Distal
Returns
Success (0) or error code.

◆ PwrSnsr_GetDongleSerialNumber()

EXPORT int PwrSnsr_GetDongleSerialNumber ( long *  val)

Get the hardware license serial number.

Parameters
valSerial number of the license dongle
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
DurationThe 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
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".
ValBufferSizeSize of the buffer.
ValArray of measurement durations in seconds.
ValActualSizeActual size of the returned buffer.
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
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".
EnabledBoolean. 1 for enabled; 0 for disabled.
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
EndDelayThe delay time added to the detected end of a burst for analysis.
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
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".
EndGate
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
EndQualThe 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_GetError()

EXPORT int PwrSnsr_GetError ( SessionID  Vi,
int *  ErrorCode,
int  ErrorDescriptionBufferSize,
char  ErrorDescription[] 
)

This function retrieves and then clears the error information for the session. Normally, the error information describes the first error that occurred since the user last called the Get Error or Clear Error function.

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

◆ PwrSnsr_GetExpirationDate()

EXPORT int PwrSnsr_GetExpirationDate ( int *  Date)

Get the hardware license expiration date.

Parameters
Dateexpiration date in the format YYYYMMDD
Returns
Success (0) or error code.

◆ PwrSnsr_GetExternalSkew()

EXPORT int PwrSnsr_GetExternalSkew ( SessionID  Vi,
const char *  Channel,
float *  External 
)

Gets the skew in seconds for the external trigger.

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".
ExternalTrigger skew in seconds (-1e-6 to 1e-6).
Returns
Success (0) or error code.

◆ PwrSnsr_GetFactoryCalDate()

EXPORT int PwrSnsr_GetFactoryCalDate ( SessionID  Vi,
const char *  Channel,
int  FactoryCalDateBufferSize,
char  FactoryCalDate[] 
)

The date (YYYYmmDD) the last time the sensor was calibrated at the factory.

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".
FactoryCalDateBufferSizeSize of FactoryCalDate in bytes.
FactoryCalDate
Returns
Success (0) or error code.

◆ PwrSnsr_GetFetchLatency()

EXPORT int PwrSnsr_GetFetchLatency ( SessionID  Vi,
int *  Latency 
)

Get the period the library waits to update fetch measurements in ms.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
LatencyFetch latency in ms.
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
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".
ManufactureDateBufferSize
ManufactureDate
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
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".
FilterTime
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
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".
FirmwareVersionBufferSizeSize of the FirmwareVersion buffer.
FirmwareVersionBuffer to hold the firmware version.
Returns
Success (0) or error code.

◆ PwrSnsr_GetFpgaVersion()

EXPORT int PwrSnsr_GetFpgaVersion ( SessionID  Vi,
const char *  Channel,
int  ValBufferSize,
char  Val[] 
)

Get the sensor FPGA version.

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".
ValBufferSizeSize pf Val in bytes
ValBuffer for staoring the 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
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".
FrequencyRF Frequency in Hz.
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
GateModeBuffer gate mode that defines the start and end of the entry time interval.
Returns
Success (0) or error code.

◆ PwrSnsr_GetGating()

EXPORT int PwrSnsr_GetGating ( SessionID  Vi,
const char *  Channel,
PwrSnsrStatGatingEnum Gating 
)

Get whether statistical capture is enabled.

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". whether the statical capture is gated by markers or free-running.
Gating
Returns
Success (0) or error code.

◆ PwrSnsr_GetHorizontalOffset()

EXPORT int PwrSnsr_GetHorizontalOffset ( SessionID  Vi,
const char *  Channel,
double *  HorizontalOffset 
)

Get the statistical mode horizontal scale offset in dB. The offset value will appear at the leftmost edge of the scale with units dBr (decibels relative).

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".
HorizontalOffset
Returns
Success (0) or error code.

◆ PwrSnsr_GetHorizontalScale()

EXPORT int PwrSnsr_GetHorizontalScale ( SessionID  Vi,
const char *  Channel,
double *  HorizontalScale 
)

Get the statistical mode horizontal scale in dB/Div.

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".
HorizontalScale
Returns
Success (0) or error code.

◆ PwrSnsr_GetImpedance()

EXPORT int PwrSnsr_GetImpedance ( SessionID  Vi,
const char *  Channel,
float *  Impedance 
)

Input impedance of the sensor.

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".
Impedance
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_GetInternalSkew()

EXPORT int PwrSnsr_GetInternalSkew ( SessionID  Vi,
const char *  Channel,
float *  InternalSkew 
)

Gets the skew in seconds for the internal trigger.

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".
InternalSkewTrigger skew in seconds (-1e-6 to 1e-6).
Returns
Success (0) or error code.

◆ PwrSnsr_GetIsAvailable()

EXPORT int PwrSnsr_GetIsAvailable ( SessionID  Vi,
const char *  Channel,
int *  IsAvailable 
)

Returns true if modulated/CW measurement system is available. Will always return false if measurement buffer is enabled.

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".
IsAvailableTrue if modulated/CW measurement system is available. Will always return false if measurement buffer is enabled.
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
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".
IsAvgSensorTrue if sensor is average responding.
Returns
Success (0) or error code.

◆ PwrSnsr_GetIsRunning()

EXPORT int PwrSnsr_GetIsRunning ( SessionID  Vi,
const char *  Channel,
int *  IsRunning 
)

Returns true if modulated/CW measuremnts are actively running.

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".
IsRunningTrue if modulated/CW measuremnts are actively running.
Returns
Success (0) or error code.

◆ PwrSnsr_GetManufactureDate()

EXPORT int PwrSnsr_GetManufactureDate ( SessionID  Vi,
const char *  Channel,
int  ManufactureDateBufferSize,
char  ManufactureDate[] 
)

Date the sensor was manufactured in the following format YYYYmmDD.

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".
ManufactureDateBufferSizeSize of ManufactureDate in bytes.
ManufactureDateReturn value.
Returns
Success (0) or error code.

◆ PwrSnsr_GetMarkerPixelPosition()

EXPORT int PwrSnsr_GetMarkerPixelPosition ( SessionID  Vi,
int  MarkerNumber,
int *  PixelPosition 
)

Get the horizontal pixel position (X-axis-position) of the selected vertical marker. There are 501 pixel positions numbered from 0 to 500 inclusive.

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

◆ PwrSnsr_GetMarkerTimePosition()

EXPORT int PwrSnsr_GetMarkerTimePosition ( SessionID  Vi,
int  MarkerNumber,
float *  TimePosition 
)

Get the time (x-axis-position) of the selected marker relative to the trigger.

Note that time markers must be positioned within the time limits of the trace window in the graph display. If a time outside of the display limits is entered, the marker will be placed at the first or last time position as appropriate.

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

◆ PwrSnsr_GetMaxFreqHighBandwidth()

EXPORT int PwrSnsr_GetMaxFreqHighBandwidth ( SessionID  Vi,
const char *  Channel,
float *  MaxFreqHighBandwidth 
)

Maximum frequency carrier the sensor can measure in high bandwidth.

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".
MaxFreqHighBandwidth
Returns
Success (0) or error code.

◆ PwrSnsr_GetMaxFreqLowBandwidth()

EXPORT int PwrSnsr_GetMaxFreqLowBandwidth ( SessionID  Vi,
const char *  Channel,
float *  MaxFreqLowBandwidth 
)

Maximum frequency carrier the sensor can measure in low bandwidth.

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".
MaxFreqLowBandwidth
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
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".
ValBufferSizeSize of the buffer.
ValArray of max measurements.
ValActualSizeActual size of the returned array in elements.
Returns
Success (0) or error code.

◆ PwrSnsr_GetMaxTimebase()

EXPORT int PwrSnsr_GetMaxTimebase ( SessionID  Vi,
float *  MaxTimebase 
)

Gets the maximum timebase setting available.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
MaxTimebase
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
MeasBuffEnabledTrue 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
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".
ValNumber of measurement entries available.
Returns
Success (0) or error code.

◆ PwrSnsr_GetMemChanArchive()

EXPORT int PwrSnsr_GetMemChanArchive ( SessionID  Vi,
const char *  memChan,
int  ValBufferSize,
char  Val[] 
)

Returns an XML document containing settings and readings obtained using the SaveToMemoryChannel method.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
MemChanThe name of the memory channel to get the archive from.
ValBufferSize
ValXML document containing settings and readings.
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
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".
Mesial
Returns
Success (0) or error code.

◆ PwrSnsr_GetMinFreqHighBandwidth()

EXPORT int PwrSnsr_GetMinFreqHighBandwidth ( SessionID  Vi,
const char *  Channel,
float *  MinFreqHighBandwidth 
)

Minimum frequency of RF the sensor can measure in high bandwidth.

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".
MinFreqHighBandwidth
Returns
Success (0) or error code.

◆ PwrSnsr_GetMinFreqLowBandwidth()

EXPORT int PwrSnsr_GetMinFreqLowBandwidth ( SessionID  Vi,
const char *  Channel,
float *  MinFreqLowBandwidth 
)

Minimum frequency carrier the sensor can measure in low bandwidth.

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".
MinFreqLowBandwidth
Returns
Success (0) or error code.

◆ PwrSnsr_GetMinimumSupportedFirmware()

EXPORT int PwrSnsr_GetMinimumSupportedFirmware ( int *  Version)

Gets the minimum supported firmware as an integer. Format is YYYYMMDD.

Returns
Success (0) or error code.

◆ PwrSnsr_GetMinimumTrig()

EXPORT int PwrSnsr_GetMinimumTrig ( SessionID  Vi,
const char *  Channel,
float *  MinimumTrig 
)

Minimum internal trigger level in dBm.

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".
MinimumTrig
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
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".
ValBufferSizeSize of the buffer.
ValArray of min measurements.
ValActualSizeActual size of the returned array in elements.
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
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".
ModelBufferSizeSize of the buffer..
ModelBuffer where the model is read into.
Returns
Success (0) or error code.

◆ PwrSnsr_GetNumberOfCals()

EXPORT int PwrSnsr_GetNumberOfCals ( long *  val)

Get the number of calibrations left on the license.

Parameters
valNumber of cals left.
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
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".
OffsetdB
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
OverRanTrue if the power meter's internal buffer filled up before being emptied.
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
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".
EnvelopeAverageOut 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
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".
EnvelopeTrackingOut boolean parameter value.
Returns
Success (0) or error code.

◆ PwrSnsr_GetPeakPowerMax()

EXPORT int PwrSnsr_GetPeakPowerMax ( SessionID  Vi,
const char *  Channel,
float *  PeakPowerMax 
)

Maximum power level the sensor can measure.

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".
PeakPowerMax
Returns
Success (0) or error code.

◆ PwrSnsr_GetPeakPowerMin()

EXPORT int PwrSnsr_GetPeakPowerMin ( SessionID  Vi,
const char *  Channel,
float *  PeakPowerMin 
)

Minimum power level the sensor can measure.

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".
PeakPowerMin
Returns
Success (0) or error code.

◆ PwrSnsr_GetPercentPosition()

EXPORT int PwrSnsr_GetPercentPosition ( SessionID  Vi,
const char *  Channel,
double *  PercentPosition 
)

Get the cursor percent on the CCDF plot.

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". Channel Channel number. For single instruments, set this to 1.
PercentPosition
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
PeriodThe period in seconds each timed mode acquisition is started.
Returns
Success (0) or error code.

◆ PwrSnsr_GetPowerPosition()

EXPORT int PwrSnsr_GetPowerPosition ( SessionID  Vi,
const char *  Channel,
double *  PowerPosition 
)

Get the cursor power in dB on the CCDF plot.

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".
PowerPosition
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
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".
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
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".
PwrSnsrPulseUnitsEnum
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
FlagBit masked value indicating which measurement arrays will be queried (see PwrSnsrRdgsEnableFlag).
Returns
Success (0) or error code.

◆ PwrSnsr_GetReadingPeriod()

EXPORT int PwrSnsr_GetReadingPeriod ( SessionID  Vi,
const char *  Channel,
float *  ReadingPeriod 
)

Returns the period (rate) in seconds per new filtered reading.

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".
ReadingPeriodThe period (rate) in seconds per new filtered reading.
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ReturnCountThe 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,
long long  Val[],
int *  ValActualSize 
)

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

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".
ValBufferSizeSize of the buffer.
ValArray of sequence numbers.
ValActualSizeActual size of the returned array in elements.
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
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".
SerialNumberBufferSizeSize in bytes of Serial number.
SerialNumberOut parameter. ASCII string serial number.
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
SessionCountGet 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_GetSlaveSkew()

EXPORT int PwrSnsr_GetSlaveSkew ( SessionID  Vi,
const char *  Channel,
float *  SlaveSkew 
)

Gets the skew in seconds for the slave trigger.

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".
SlaveSkewTrigger skew in seconds (-1e-6 to 1e-6).
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
StartDelayDelay time in seconds added to the detected beginning of a burst for analysis.
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
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".
StartGate
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
StartModeMode 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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
StartQualThe 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
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".
ValBufferSizeSize of the buffer.
ValArray of start times.
ValActualSizeActual size of the returned array in elements.
Returns
Success (0) or error code.

◆ PwrSnsr_GetSweepTime()

EXPORT int PwrSnsr_GetSweepTime ( SessionID  Vi,
const char *  Channel,
float *  SweepTime 
)

Get sweep time for the trace in seconds.

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".
SweepTimeSweep time for the trace in seconds.
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
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".
TempCompBoolean. 1 for on; 0 for off.
Returns
Success (0) or error code.

◆ PwrSnsr_GetTermAction()

EXPORT int PwrSnsr_GetTermAction ( SessionID  Vi,
const char *  Channel,
PwrSnsrTermActionEnum TermAction 
)

Get the termination action for statistical capturing.

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".
TermAction
Returns
Success (0) or error code.

◆ PwrSnsr_GetTermCount()

EXPORT int PwrSnsr_GetTermCount ( SessionID  Vi,
const char *  Channel,
double *  TermCount 
)

Get the termination count for statistical capturing. After the sample count has been reached, the action determined by TermAction is taken.

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".
TermCount
Returns
Success (0) or error code.

◆ PwrSnsr_GetTermTime()

EXPORT int PwrSnsr_GetTermTime ( SessionID  Vi,
const char *  Channel,
int *  TermTime 
)

Get the termination time in seconds for statistical capturing. After the time has elapsed, the action determined by TermAction is taken.

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".
TermTime
Returns
Success (0) or error code.

◆ PwrSnsr_GetTimebase()

EXPORT int PwrSnsr_GetTimebase ( SessionID  Vi,
float *  Timebase 
)

Get the Pulse Mode timebase in seconds/division. (10 divisions = 1 trace) Value = 5e-9 to 10e-3 (or max timebase) sec in a 1-2-5 sequence,.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Timebase
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
TimedOutTrue if the last measurement buffer session timed out.
Returns
Success (0) or error code.

◆ PwrSnsr_GetTimeOut()

EXPORT int PwrSnsr_GetTimeOut ( SessionID  Vi,
long *  Val 
)

Returns the time out value for I/O in milliseconds.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ValTime out in milliseconds. -1 denote infinite time out.
Returns
Success (0) or error code.

◆ PwrSnsr_GetTimePerPoint()

EXPORT int PwrSnsr_GetTimePerPoint ( SessionID  Vi,
const char *  Channel,
float *  TimePerPoint 
)

Get time spacing for each waveform point in seconds.

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".
TimePerPointTime spacing for each waveform point in seconds.
Returns
Success (0) or error code.

◆ PwrSnsr_GetTimespan()

EXPORT int PwrSnsr_GetTimespan ( SessionID  Vi,
float *  Timespan 
)

Get the horizontal time span of the trace in pulse mode. Time span = 10* Time/Division. Value = 5e-8 to 100e-3 sec in a 1-2-5 sequence.

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

◆ PwrSnsr_GetTraceStartTime()

EXPORT int PwrSnsr_GetTraceStartTime ( SessionID  Vi,
const char *  Channel,
float *  TraceStartTime 
)

Get time offset (start time) of the trace in seconds. May be negative, indicating pre-trigger information.

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".
TraceStartTimeTime offset (start time) of the trace in seconds. May be negative, indicating pre-trigger information.
Returns
Success (0) or error code.

◆ PwrSnsr_GetTrigDelay()

EXPORT int PwrSnsr_GetTrigDelay ( SessionID  Vi,
float *  Delay 
)

Return the trigger delay time in seconds with respect to the trigger for the trigger display location in the LEFT position.

Positive values cause the actual trigger to occur after the trigger condition is met. This places the trigger event to the left of the trigger point on the display, and is useful for viewing events during a pulse, some fixed delay time after the rising edge trigger. Negative trigger delay places the trigger event to the right of the trigger point on the display, and is useful for looking at events before the trigger edge.

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

◆ PwrSnsr_GetTrigHoldoff()

EXPORT int PwrSnsr_GetTrigHoldoff ( SessionID  Vi,
float *  Holdoff 
)

Return the trigger holdoff time in seconds.

Trigger holdoff is used to disable the trigger for a specified amount of time after each trigger event. The holdoff time starts immediately after each valid trigger edge, and will not permit any new triggers until the time has expired. When the holdoff time is up, the trigger re-arms, and the next valid trigger event (edge) will cause a new sweep. This feature is used to help synchronize the power meter with burst waveforms such as a TDMA or GSM frame. The trigger holdoff resolution is 10 nanoseconds, and it should be set to a time that is just slightly shorter than the frame repetition interval.

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

◆ PwrSnsr_GetTrigHoldoffMode()

EXPORT int PwrSnsr_GetTrigHoldoffMode ( SessionID  Vi,
PwrSnsrHoldoffModeEnum HoldoffMode 
)

Returns the holdoff mode to normal or gap holdoff.

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

◆ PwrSnsr_GetTrigLevel()

EXPORT int PwrSnsr_GetTrigLevel ( SessionID  Vi,
float *  Level 
)

Return the trigger level for synchronizing data acquisition with a pulsed input signal.

The internal trigger level entered should include any global offset and will also be affected by the frequency cal factor. The available internal trigger level range is sensor dependent. The trigger level is set and returned in dBm. This setting is only valid for normal and auto trigger modes.

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

◆ PwrSnsr_GetTrigMode()

EXPORT int PwrSnsr_GetTrigMode ( SessionID  Vi,
PwrSnsrTriggerModeEnum Mode 
)

Return the trigger mode for synchronizing data acquisition with pulsed signals.

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

◆ PwrSnsr_GetTrigPosition()

EXPORT int PwrSnsr_GetTrigPosition ( SessionID  Vi,
PwrSnsrTriggerPositionEnum Position 
)

Return the position of the trigger event on displayed sweep.

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

◆ PwrSnsr_GetTrigSlope()

EXPORT int PwrSnsr_GetTrigSlope ( SessionID  Vi,
PwrSnsrTriggerSlopeEnum Slope 
)

Return the trigger slope or polarity.

When set to positive, trigger events will be generated when a signal rising edge crosses the trigger level threshold. When negative, trigger events are generated on the falling edge of the pulse.

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

◆ PwrSnsr_GetTrigSource()

EXPORT int PwrSnsr_GetTrigSource ( SessionID  Vi,
PwrSnsrTriggerSourceEnum Source 
)

Set the signal the power meter monitors for a trigger. It can be channel external input, or independent.

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

◆ PwrSnsr_GetTrigStatus()

EXPORT int PwrSnsr_GetTrigStatus ( SessionID  Vi,
PwrSnsrTriggerStatusEnum Status 
)

The status of the triggering system. Update rate is controlled by FetchLatency setting.

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

◆ PwrSnsr_GetTrigVernier()

EXPORT int PwrSnsr_GetTrigVernier ( SessionID  Vi,
float *  Vernier 
)

Return the fine position of the trigger event on the power sweep.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
VernierTrigger position -30.0 to 30.0 (0.0 = left, 5.0 = middle, 10.0 = Right).
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
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".
Units
Returns
Success (0) or error code.

◆ PwrSnsr_GetVerticalCenter()

int EXPORT PwrSnsr_GetVerticalCenter ( SessionID  Vi,
const char *  Channel,
float *  VerticalCenter 
)

Gets vertical center based on current units: <arg> = (range varies by units)

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".
VerticalCenterVertical center in units
Returns
Success (0) or error code.

◆ PwrSnsr_GetVerticalScale()

int EXPORT PwrSnsr_GetVerticalScale ( SessionID  Vi,
const char *  Channel,
float *  VerticalScale 
)

Gets vertical scale based on current units: <arg> = (range varies by units)

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".
VerticalCenterVertical scale in units
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
WriteProtectionReturns trueif the measurement buffer is allowed to overwrite members that have not been read by the user.
Returns
Success (0) or error code.

◆ PwrSnsr_init()

EXPORT int PwrSnsr_init ( char *  ResourceName,
SessionID *  Vi 
)

Initialize a communication session with a supported USB power sensor.

Parameters
ResourceNameName of the resource. The resource descriptor is in the following format:
USB::[VID]::[PID]::[Serial Number]::BTN
Where serial number is the USB power meter’s serial number in decimal format,
and the VID and PID are in hexidecimal format.
e.g. For serial number 1234, VID of 0x1bfe and PID of 0x5500:
USB::0x1BFE::0x5500::1234::BTN
Multiple channel synthetic meters can be defined by combining more than one descriptor separated by a semicolon.
Channel assignment is determined by the order in the list, in other words CH1 would be the first listed resource,
CH2 the second resource, etc.
e.g. Define a synthetic peak power meter using serial number 1234 for CH1 and serial number 4242 for CH2:
USB::0x1BFE::0x5500::1234::BTN;USB::0x1BFE::0x5500::4242::BTN
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_IsLicenseDongleConnected()

EXPORT int PwrSnsr_IsLicenseDongleConnected ( int *  val)

Get whether the hardware license dongle is connected.

Parameters
valBoolean. 1 for connected or 0 for not connected.
Returns
Success (0) or error code.

◆ PwrSnsr_LoadMemChanFromArchive()

EXPORT int PwrSnsr_LoadMemChanFromArchive ( SessionID  Vi,
const char *  memChan,
const char *  ArchiveContent 
)

Loads the named memory channel using the given archive. If the memory channel does not exist, one is created.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
MemChanMemory channel name. Must have the form MEM1...n, where n is the number of measurement channels. In single channel configurations, this parameter should always be "MEM1".
ArchiveContentAn xml document containing settings and readings obtained using the SaveToMemoryChannel method. An archive can be obtained using the GetMemChanArchive method.
Returns
Success (0) or error code.

◆ PwrSnsr_MeasurePower()

EXPORT int PwrSnsr_MeasurePower ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return average power using a default instrument configuration in Modulated Mode and dBm units. Instrument remains stopped in Modulated Mode after a measurement.

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".
CondCodeCondition code for the measurement.
ValAverage power in dBm
Returns
Success (0) or error code.

◆ PwrSnsr_MeasureVoltage()

EXPORT int PwrSnsr_MeasureVoltage ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return average voltage using a default instrument configuration in Modulated Mode and volts units. Instrument remains stopped in Modulated Mode after a measurement.

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".
CondCodeCondition code for the measurement.
ValAverage voltage in linear volts.
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
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".
ValBufferSizeSize of the buffer in elements.
ValArray of average power measurements.
ValActualSizeActual 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
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".
ValBufferSizeSize of the buffer.
ValArray of buffered measurement durations.
ValActualSizeActual 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
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".
ValBufferSizeSize of the buffer.
ValArray of max measurements.
ValActualSizeActual 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
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".
ValBufferSizeSize of the buffer.
ValArray of min measurements.
ValActualSizeActual 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,
long long  Val[],
int *  ValActualSize 
)

Query the power meter for all buffered sequence numbers.

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".
ValBufferSizeSize of the buffer.
ValArray of sequence numbers.
ValActualSizeActual 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
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".
ValBufferSizeSize of the buffer.
ValArray of start times in seconds.
ValActualSizeActual size of the returned array in elements.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadArrayMarkerPower()

EXPORT int PwrSnsr_ReadArrayMarkerPower ( SessionID  Vi,
const char *  Channel,
float *  AvgPower,
PwrSnsrCondCodeEnum AvgPowerCondCode,
float *  MaxPower,
PwrSnsrCondCodeEnum MaxPowerCondCode,
float *  MinPower,
PwrSnsrCondCodeEnum MinPowerCondCode,
float *  PkToAvgRatio,
PwrSnsrCondCodeEnum PkToAvgRatioCondCode,
float *  Marker1Power,
PwrSnsrCondCodeEnum Marker1PowerCondCode,
float *  Marker2Power,
PwrSnsrCondCodeEnum Marker2PowerCondCode,
float *  MarkerRatio,
PwrSnsrCondCodeEnum MarkerRatioCondCode 
)

Returns an array of the current marker measurements for the specified channel.

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".
AvgPowerAverage power between the markers.
AvgPowerCondCodeCondition code.
MaxPowerMaximum power between the markers.
MaxPowerCondCodeCondition code.
MinPowerMinimum power between the markers.
MinPowerCondCodeCondition code.
PkToAvgRatioThe ratio of peak to average power between the markers.
PkToAvgRatioCondCodeCondition code.
Marker1PowerThe power at Marker 1.
Marker1PowerCondCodeCondition code.
Marker2PowerThe power at Marker 2.
Marker2PowerCondCodeCondition code.
MarkerRatioRatio of power at Marker 1 and power at Marker 2.
MarkerRatioCondCodeCondition code.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadByteArray()

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

Reads byte array from the meter.

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".
CountMaximum count of bytes to return.
ValBufferSizeSize of the buffer.
ValByte array from the USB.
ValActualSizeActual size of the returned array in bytes.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadControl()

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

Reads a control transfer on the USB.

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".
CountMaximum count to return.
ValBufferSizeSize of the buffer.
ValByte array from a USB control transfer.
ValActualSizeActual size of the returned array in bytes.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadCWArray()

EXPORT int PwrSnsr_ReadCWArray ( SessionID  Vi,
const char *  Channel,
float *  PeakAverage,
PwrSnsrCondCodeEnum PeakAverageValid,
float *  PeakMax,
PwrSnsrCondCodeEnum PeakMaxValid,
float *  PeakMin,
PwrSnsrCondCodeEnum PeakMinValid,
float *  PeakToAvgRatio,
PwrSnsrCondCodeEnum PeakToAvgRatioValid 
)

Returns the current average, maximum, minimum powers or voltages and the peak-to-average ratio of the specified channel. Units are the same as the channel's units. Note the peak-to-average ratio and marker ratio are returned in dB for logarithmic channel units, and percent for all other channel units.

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".
PeakAverageAverage power of the peak power envelope.
PeakAverageValidCondition code.
PeakMaxMaximum power of the peak power envelope.
PeakMaxValidCondition code.
PeakMinMinimum power of the peak power envelope.
PeakMinValidCondition code.
PeakToAvgRatioPeak to average ratio.
PeakToAvgRatioValidCondition code.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadCWPower()

EXPORT int PwrSnsr_ReadCWPower ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum IsValid,
float *  Val 
)

Initiates a CW power acquisition and returns the result in channel units.

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".
IsValidCondition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadDutyCycle()

EXPORT int PwrSnsr_ReadDutyCycle ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Returns the ratio of the pulse on-time to off-time.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadEdgeDelay()

EXPORT int PwrSnsr_ReadEdgeDelay ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Returns time offset from the trigger reference to the first mesial transition level of either slope on the waveform.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadFallTime()

EXPORT int PwrSnsr_ReadFallTime ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Returns the interval between the last signal crossing of the distal line to the last signal crossing of the proximal line.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadIEEEBottom()

EXPORT int PwrSnsr_ReadIEEEBottom ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Returns the IEEE-define base line, i.e. The two portions of a pulse waveform which represent the first nominal state from which a pulse departs and to which it ultimately returns.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadIEEETop()

EXPORT int PwrSnsr_ReadIEEETop ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Returns the IEEE-defined top line, i.e. the portion of a pulse waveform which represents the second nominal state of a pulse.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadIntervalAvg()

EXPORT int PwrSnsr_ReadIntervalAvg ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the average power or voltage in the time interval between marker 1 and marker 2. The units will be the same as the specified channel.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadIntervalFilteredMax()

EXPORT int PwrSnsr_ReadIntervalFilteredMax ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the maximum filtered power or voltage in the time interval between marker 1 and marker 2. The units will be the same as the specified channel.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadIntervalFilteredMin()

EXPORT int PwrSnsr_ReadIntervalFilteredMin ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the minmum power or voltage in the time interval between marker 1 and marker 2. The units will be the same as the specified channel.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadIntervalMax()

EXPORT int PwrSnsr_ReadIntervalMax ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the maximum instantaneous power or voltage in the time interval between marker1 and marker 2. The units will be the same as the specified channel.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadIntervalMaxAvg()

EXPORT int PwrSnsr_ReadIntervalMaxAvg ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return maximum of the average power trace between MK1 and MK2. The units will be the same as the specified channel.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadIntervalMin()

EXPORT int PwrSnsr_ReadIntervalMin ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the minimum instantaneous power or voltage in the time interval between marker1 and marker 2. The units will be the same as the specified channel.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadIntervalMinAvg()

EXPORT int PwrSnsr_ReadIntervalMinAvg ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return minimum of the average power trace between MK1 and MK2. The units will be the same as the specified channel.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadIntervalPkToAvg()

EXPORT int PwrSnsr_ReadIntervalPkToAvg ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the peak-to-average ratio of the power or voltage between marker 1 and marker 2. The units are dB for logarithmic channel units or percent for linear channel units.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadMarkerAverage()

EXPORT int PwrSnsr_ReadMarkerAverage ( SessionID  Vi,
const char *  Channel,
int  Marker,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Forthe specified marker, return the average power or voltage at the marker. The units are the same as the specified channel.

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".
MarkerMarker number.
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value
Returns
Success (0) or error code.

◆ PwrSnsr_ReadMarkerDelta()

EXPORT int PwrSnsr_ReadMarkerDelta ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the difference between MK1 and MK2. The units will be the same as marker units.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadMarkerMax()

EXPORT int PwrSnsr_ReadMarkerMax ( SessionID  Vi,
const char *  Channel,
int  Marker,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Forthe specified marker, return the maximum power or voltage at the marker. The units are the same as the specified channel.

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".
MarkerMarker number.
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadMarkerMin()

EXPORT int PwrSnsr_ReadMarkerMin ( SessionID  Vi,
const char *  Channel,
int  Marker,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Forthe specified marker, return the minimum power or voltage at the marker. The units are the same as the specified channel.

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".
MarkerMarker number.
CondCodeCondition code for the measurement. Condition code.
Valmeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadMarkerRatio()

EXPORT int PwrSnsr_ReadMarkerRatio ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the ratio of MK1 to MK2. The units will be dB for logarithmic units or percent for linear units.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadMarkerRDelta()

EXPORT int PwrSnsr_ReadMarkerRDelta ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the difference between MK2 and MK1. The units will be the same as marker units.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadMarkerRRatio()

EXPORT int PwrSnsr_ReadMarkerRRatio ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Return the ratio of MK2 to MK1. The units will be dB for logarithmic units or percent for linear units.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadOfftime()

EXPORT int PwrSnsr_ReadOfftime ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Returns the time a repetitive pulse is off. (Equal to the pulse period minus the pulse width).

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadOvershoot()

EXPORT int PwrSnsr_ReadOvershoot ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Returns the difference between the distortion following a major transition and the IEEE top line in dB or percent, depending on the channel units.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadPeriod()

EXPORT int PwrSnsr_ReadPeriod ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Returns the interval between two successive pulses.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadPowerArray()

EXPORT int PwrSnsr_ReadPowerArray ( SessionID  Vi,
const char *  Channel,
float *  PulsePeak,
PwrSnsrCondCodeEnum PulsePeakValid,
float *  PulseCycleAvg,
PwrSnsrCondCodeEnum PulseCycleAvgValid,
float *  PulseOnAvg,
PwrSnsrCondCodeEnum PulseOnValid,
float *  IEEETop,
PwrSnsrCondCodeEnum IEEETopValid,
float *  IEEEBottom,
PwrSnsrCondCodeEnum IEEEBottomValid,
float *  Overshoot,
PwrSnsrCondCodeEnum OvershootValid,
float *  Droop,
PwrSnsrCondCodeEnum DroopValid 
)

Returns an array of the current automatic amplitude measurements performed on a periodic pulse waveform.

Measurements performed are: peak amplitude during the pulse, average amplitude over a full cycle of the
pulse waveform, average amplitude during the pulse, IEEE top amplitude, IEEE bottom amplitude, and overshoot.
Units are the same as the channel's units. Note the pulse overshoot is returned in dB for logarithmic channel units,
and percent for all other units. Also, the pulse ON interval used for peak and average calculations is
defined by the SENSe:PULSe:STARTGT and :ENDGT time gating settings.
A full pulse (rise and fall) must be visible on the display to make average and peak pulse power measurements,
and a full cycle of the waveform must be visible to calculate average cycle amplitude.

Parameters
ChannelChannel number. For single instruments, set this to "CH1".
PulsePeakThe peak amplitude during the pulse.
PulsePeakValidCondition code.
PulseCycleAvgAverage cycle amplitude.
PulseCycleAvgValidCondition code.
PulseOnAvgAverage power of the ON portion of the pulse.
PulseOnValidCondition code.
IEEETopThe IEEE-defined top line, i.e. the portion of a pulse waveform, which represents the second nominal state of a pulse.
IEEETopValidCondition code.
IEEEBottomThe IEEE-define base line, i.e. The two portions of a pulse waveform which represent the first nominal state from which a pulse departs and to which it ultimately returns.
IEEEBottomValidCondition code.
OvershootThe difference between the distortion following a major transition and the IEEE top line in dB or percent,depending on the channel units.
OvershootValidCondition code.
DroopPulse droop.
DroopValidCondition code.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadPRF()

EXPORT int PwrSnsr_ReadPRF ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Returns the number of cycles of a repetitive signal that take place in one second (Pulse Repetition Frequency).

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadPulseCycleAvg()

EXPORT int PwrSnsr_ReadPulseCycleAvg ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Returns the average power of the entire pulse.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadPulseOnAverage()

EXPORT int PwrSnsr_ReadPulseOnAverage ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Average power of the ON portion of the pulse.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadPulsePeak()

EXPORT int PwrSnsr_ReadPulsePeak ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Returns the peak amplitude during the pulse.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadRiseTime()

EXPORT int PwrSnsr_ReadRiseTime ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Returns the interval between the first signal crossing of the proximal line to the first signal crossing of the distal line.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadSCPI()

EXPORT int PwrSnsr_ReadSCPI ( SessionID  Vi,
int  ValueBufferSize,
long *  ValueActualSize,
char  Value[],
int  Timeout 
)

Read a SCPI string response from the instrument.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ValueBufferSizeNumber of elements in Value.
ValueActualSizeNumber of elements actually written to Value.
ValueThe string returned from the instrument SCPI interface.
TimeoutTime out in milliseconds for the read operation. Use -1 for infinite and -2 to use the existing time out value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadSCPIBytes()

EXPORT int PwrSnsr_ReadSCPIBytes ( SessionID  Vi,
int  ValueBufferSize,
char  Value[],
long *  ValueActualSize,
int  Timeout 
)

Read a SCPI byte array response from the instrument.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ValueBufferSizeNumber of elements in Value.
ValueThe byte array returned from the instrument SCPI interface.
ValueActualSize
TimeoutTime out in milliseconds for the read operation. Use -1 for infinite and -2 to use the existing time out value. Time out in milliseconds for the read operation. Use -1 for infinite and -2 to use the existing time out value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadSCPIFromNamedParser()

EXPORT int PwrSnsr_ReadSCPIFromNamedParser ( SessionID  Vi,
const char *  name,
int  ValueBufferSize,
long *  ValueActualSize,
char  Value[],
int  Timeout 
)

Read a SCPI string response from the instrument.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
nameName of the parser. If parser doesn't exist, returns PWR_SNSR_ERROR_NULL_POINTER. PwrSnsr_SendSCPIToNamedParser can be used to create a named parser.
ValueBufferSizeNumber of elements in Value.
ValueActualSizeNumber of elements actually written to Value.
ValueThe string returned from the instrument SCPI interface.
TimeoutTime out in milliseconds for the read operation. Use -1 for infinite and -2 to use the existing time out value.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadTimeArray()

EXPORT int PwrSnsr_ReadTimeArray ( SessionID  Vi,
const char *  Channel,
float *  Frequency,
PwrSnsrCondCodeEnum FrequencyValid,
float *  Period,
PwrSnsrCondCodeEnum PeriodValid,
float *  Width,
PwrSnsrCondCodeEnum WidthValid,
float *  Offtime,
PwrSnsrCondCodeEnum OfftimeValid,
float *  DutyCycle,
PwrSnsrCondCodeEnum DutyCycleValid,
float *  Risetime,
PwrSnsrCondCodeEnum RisetimeValid,
float *  Falltime,
PwrSnsrCondCodeEnum FalltimeValid,
float *  EdgeDelay,
PwrSnsrCondCodeEnum EdgeDelayValid,
float *  Skew,
PwrSnsrCondCodeEnum SkewValid 
)

Returns an array of the current automatic timing measurements performed on a periodic pulse waveform.

Measurements performed are: the frequency, period, width, offtime and duty cycle of the pulse waveform, and the risetime and falltime of the edge transitions. For each of the measurements to be performed, the appropriate items to be measured must within the trace window. Pulse frequency, period, offtime and duty cycle measurements require that an entire cycle of the pulse waveform (minimum of three edge transitions) be present. Pulse width measurement requires that at least one full pulse is visible, and is most accurate if the pulse width is at least 0.4 divisions. Risetime and falltime measurements require that the edge being measured is visible, and will be most accurate if the transition takes at least 0.1 divisions. It is always best to have the power meter set on the fastest timebase possible that meets the edge visibility restrictions. Set the trace averaging as high as practical to reduce fluctuations and noise in the pulse timing measurements. Note that the timing of the edge transitions is defined by the settings of the SENSe:PULSe:DISTal, :MESIal and :PROXimal settings; see the descriptions For those commands. Units are the same as the channel's units.

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".
FrequencyThe number of cycles of a repetitive signal that take place in one second (Pulse Repetition Frequency).
FrequencyValidCondition code.
PeriodThe interval between two successive pulses.
PeriodValidCondition code.
WidthThe interval between the first and second signal crossings of the mesial line.
WidthValidCondition code.
OfftimeThe time a repetitive pulse is off. (Equal to the pulse period minus the pulse width).
OfftimeValidCondition code.
DutyCycleThe ratio of the pulse on-time to period.
DutyCycleValidCondition code.
RisetimeThe interval between the first signal crossing of the proximal line to the first signal crossing of the distal line.
RisetimeValidCondition code.
FalltimeThe interval between the last signal crossing of the distal line to the last signal crossing of the proximal line.
FalltimeValidCondition code.
EdgeDelayTime offset from the trigger reference to the first mesial transition level of either slope on the waveform.
EdgeDelayValidCondition code.
SkewThe trigger offset between the assigned trigger channel and this channel.
SkewValidCondition code.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadWaveform()

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

Initiates an acquisition on all enabled channels, waits (up to MaxTime) for the acquisition to complete, and returns the waveform for this channel. Call FetchWaveform to obtain the waveforms for other channels.

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".
WaveformArrayBufferSizeSize in bytes of the Waveform buffer.
WaveformArrayThe array contains the average waveform. Units for the individual array elements are in the channel units setting.
WaveformArrayActualSizeSize in bytes of the data written to WaveformArray.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadWaveformMinMax()

EXPORT int PwrSnsr_ReadWaveformMinMax ( SessionID  Vi,
const char *  Channel,
int  MinWaveformBufferSize,
float  MinWaveform[],
int *  MinWaveformActualSize,
int  MaxWaveformBufferSize,
float  MaxWaveform[],
int *  MaxWaveformActualSize,
int  WaveformArrayBufferSize,
float  WaveformArray[],
int *  WaveformArrayActualSize 
)

Initiates an acquisition on all enabled channels, waits (up to MaxTime) for the acquisition to complete, and returns the min/max waveforms for this channel. Call FetchMinMaxWaveform to obtain the min/max waveforms for other channels.

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".
MinWaveformBufferSizeSize in bytes of the MinWaveform buffer.
MinWaveformThis array contains the min waveform. Units for the individual array elements are in the channel units setting.
MinWaveformActualSizeSize in bytes of the data written to MinWaveform.
MaxWaveformBufferSizeSize in bytes of the MaxWaveform buffer.
MaxWaveformThis array contains the max waveform. Units for the individual array elements are in the channel units setting.
MaxWaveformActualSizeSize in bytes of the data written to MaxWaveform.
WaveformArrayBufferSizeSize in bytes of the Waveform buffer.
WaveformArrayThe array contains the average waveform. Units for the individual array elements are in the channel units setting.
WaveformArrayActualSizeSize in bytes of the data written to WaveformArray.
Returns
Success (0) or error code.

◆ PwrSnsr_ReadWidth()

EXPORT int PwrSnsr_ReadWidth ( SessionID  Vi,
const char *  Channel,
PwrSnsrCondCodeEnum CondCode,
float *  Val 
)

Returns the pulse width, i.e. the interval between the first and second signal crossings of the mesial line.

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".
CondCodeCondition code for the measurement. Condition code.
ValMeasurement value.
Returns
Success (0) or error code.

◆ PwrSnsr_reset()

EXPORT int PwrSnsr_reset ( SessionID  Vi)

Places the instrument in a known state.

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_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
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_SaveToMemoryChannel()

EXPORT int PwrSnsr_SaveToMemoryChannel ( SessionID  Vi,
const char *  memChan,
const char *  ChannelName 
)

Saves the given channel to a memory channel. If the memory channel does not exist, a new one is created.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
MemChanMemory channel name. Must have the form MEM1...n, where n is the number of measurement channels. In single channel configurations, this parameter should always be "MEM1".
ChannelThe channel name to copy from.
Returns
Success (0) or error code.

◆ PwrSnsr_SaveUserCal()

EXPORT int PwrSnsr_SaveUserCal ( SessionID  Vi,
const char *  Channel 
)

Instructs power meter to save the value of fixed cal, zero, and skew values.

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".
Returns
Success (0) or error code.

◆ PwrSnsr_self_test()

EXPORT int PwrSnsr_self_test ( SessionID  Vi,
int *  TestResult 
)

Performs an instrument self test, waits for the instrument to complete the test, and queries the instrument for the results. If the instrument passes the test, TestResult is 0.

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

◆ PwrSnsr_SendSCPIBytes()

EXPORT int PwrSnsr_SendSCPIBytes ( SessionID  Vi,
int  CommandBufferSize,
char  Command[] 
)

Send a SCPI command as a byte array.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
CommandBufferSizeNumber of elements in Command.
CommandCommand to send.
Returns
Success (0) or error code.

◆ PwrSnsr_SendSCPICommand()

EXPORT int PwrSnsr_SendSCPICommand ( SessionID  Vi,
const char *  Command 
)

Send a SCPI command to the instrument.

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

◆ PwrSnsr_SendSCPIToNamedParser()

EXPORT int PwrSnsr_SendSCPIToNamedParser ( SessionID  Vi,
const char *  name,
const char *  Command 
)

Send a SCPI command to the instrument using a named SCPI parser.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
nameName of the parser. Creates a new parser if the name is not already used.
Command
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
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".
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
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".
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
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".
CalFactor
Returns
Success (0) or error code.

◆ PwrSnsr_SetCapture()

EXPORT int PwrSnsr_SetCapture ( SessionID  Vi,
const char *  Channel,
int  Capture 
)

Set whether statistical capture is enabled.

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".
Capture
Returns
Success (0) or error code.

◆ PwrSnsr_SetCCDFTraceCount()

EXPORT int PwrSnsr_SetCCDFTraceCount ( SessionID  Vi,
const char *  Channel,
int  TraceCount 
)

Set the number of points (1 - 16384) in the CCDF trace plot.

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".
TraceCount
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ContinuousCaptureTrue 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_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
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".
Distal
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
DurationThe duration samples are captured during each timed mode acquisition in seconds.
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
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".
EnabledBoolean. 1 for enable; 0 for disable.
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
EndDelayDelay time added to the detected end of a burst for analysis.
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
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".
EndGate
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
EndQualThe 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_SetExternalSkew()

EXPORT int PwrSnsr_SetExternalSkew ( SessionID  Vi,
const char *  Channel,
float  External 
)

Sets the skew in seconds for the external trigger.

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".
ExternalTrigger skew in seconds (-1e-6 to 1e-6).
Returns
Success (0) or error code.

◆ PwrSnsr_SetFetchLatency()

EXPORT int PwrSnsr_SetFetchLatency ( SessionID  Vi,
int  Latency 
)

Set the period the library waits to update fetch measurements in ms.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
LatencyFetch latency in ms.
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
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".
FilterState
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
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".
FilterTime
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
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".
FrequencyRF Frequency in Hz.
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
GateModeBuffer gate mode that defines the start and end of the entry time interval.
Returns
Success (0) or error code.

◆ PwrSnsr_SetGating()

EXPORT int PwrSnsr_SetGating ( SessionID  Vi,
const char *  Channel,
PwrSnsrStatGatingEnum  Gating 
)

Set whether the statical capture is gated by markers or free-running.

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".
Gating
Returns
Success (0) or error code.

◆ PwrSnsr_SetHorizontalOffset()

EXPORT int PwrSnsr_SetHorizontalOffset ( SessionID  Vi,
const char *  Channel,
double  HorizontalOffset 
)

Set the statistical mode horizontal scale offset in dB. The offset value will appear at the leftmost edge of the scale with units dBr (decibels relative).

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".
HorizontalOffset
Returns
Success (0) or error code.

◆ PwrSnsr_SetHorizontalScale()

EXPORT int PwrSnsr_SetHorizontalScale ( SessionID  Vi,
const char *  Channel,
double  HorizontalScale 
)

Set the statistical mode horizontal scale in dB/Div.

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".
HorizontalScale
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_SetInternalSkew()

EXPORT int PwrSnsr_SetInternalSkew ( SessionID  Vi,
const char *  Channel,
float  InternalSkew 
)

Sets the skew in seconds for the internal trigger.

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".
InternalSkewTrigger skew in seconds (-1e-6 to 1e-6).
Returns
Success (0) or error code.

◆ PwrSnsr_SetMarkerPixelPosition()

EXPORT int PwrSnsr_SetMarkerPixelPosition ( SessionID  Vi,
int  MarkerNumber,
int  PixelPosition 
)

Set the horizontal pixel position (X-axis-position) of the selected vertical marker. There are 501 pixel positions numbered from 0 to 500 inclusive.

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

◆ PwrSnsr_SetMarkerTimePosition()

EXPORT int PwrSnsr_SetMarkerTimePosition ( SessionID  Vi,
int  MarkerNumber,
float  TimePosition 
)

Set the time (x-axis-position) of the selected marker relative to the trigger.

Note that time markers must be positioned within the time limits of the trace window in the graph display. If a time outside of the display limits is entered, the marker will be placed at the first or last time position as appropriate.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
MarkerNumber
TimePosition
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
MeasBuffEnabledTrue to enable measurement buffer, false to disable.
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
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".
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
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".
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
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".
EnvelopeAveragePeak 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
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".
EnvelopeTrackingBoolean value. True to set peak hold tracking on.
Returns
Success (0) or error code.

◆ PwrSnsr_SetPercentPosition()

EXPORT int PwrSnsr_SetPercentPosition ( SessionID  Vi,
const char *  Channel,
double  PercentPosition 
)

Set the cursor percent on the CCDF plot.

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".
PercentPosition
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
PeriodThe period in seconds each timed mode acquisition is started.
Returns
Success (0) or error code.

◆ PwrSnsr_SetPowerPosition()

EXPORT int PwrSnsr_SetPowerPosition ( SessionID  Vi,
const char *  Channel,
double  PowerPosition 
)

Set the cursor power in dB on the CCDF plot.

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".
PowerPosition
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
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".
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
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".
PwrSnsrPulseUnitsEnum
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
FlagBit 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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ReturnCountThe 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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
SessionCountSet 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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
SecondsSet 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_SetSlaveSkew()

EXPORT int PwrSnsr_SetSlaveSkew ( SessionID  Vi,
const char *  Channel,
float  SlaveSkew 
)

Sets the skew in seconds for the slave trigger.

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".
SlaveSkewTrigger skew in seconds (-1e-6 to 1e-6).
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
StartDelayDelay time in seconds added to the detected beginning of a burst for analysis.
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
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".
StartGate
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
StartModeMode 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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
StartQualThe 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_SetTempComp()

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

Set the state of the peak sensor temperature compensation system.

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".
TempCompBoolean. 1 for on; 0 for off.
Returns
Success (0) or error code.

◆ PwrSnsr_SetTermAction()

EXPORT int PwrSnsr_SetTermAction ( SessionID  Vi,
const char *  Channel,
PwrSnsrTermActionEnum  TermAction 
)

Set the termination action for statistical capturing.

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".
TermAction
Returns
Success (0) or error code.

◆ PwrSnsr_SetTermCount()

EXPORT int PwrSnsr_SetTermCount ( SessionID  Vi,
const char *  Channel,
double  TermCount 
)

Set the termination count for statistical capturing. After the sample count has been reached, the action determined by TermAction is taken.

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".
TermCount
Returns
Success (0) or error code.

◆ PwrSnsr_SetTermTime()

EXPORT int PwrSnsr_SetTermTime ( SessionID  Vi,
const char *  Channel,
int  TermTime 
)

Set the termination time in seconds (1 - 3600) for statistical capturing. After the time has elapsed, the action determined by TermAction is taken.

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".
TermTime
Returns
Success (0) or error code.

◆ PwrSnsr_SetTimebase()

EXPORT int PwrSnsr_SetTimebase ( SessionID  Vi,
float  Timebase 
)

Set the Pulse Mode timebase in seconds/division. (10 divisions = 1 trace) Value = 5e-9 to 10e-3 sec (or max timebase) in a 1-2-5 sequence,.

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

◆ PwrSnsr_SetTimeOut()

EXPORT int PwrSnsr_SetTimeOut ( SessionID  Vi,
long  Milliseconds 
)

Sets the time out in milliseconds for I/O.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
MillisecondsTime out in milliseconds. Use -1 for infinite time out.
Returns
Success (0) or error code.

◆ PwrSnsr_SetTimespan()

EXPORT int PwrSnsr_SetTimespan ( SessionID  Vi,
float  Timespan 
)

Set the horizontal time span of the trace in pulse mode. Time span = 10* Time/Division. Value = 5e-8 to 100e-3 sec in a 1-2-5 sequence.

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

◆ PwrSnsr_SetTrigDelay()

EXPORT int PwrSnsr_SetTrigDelay ( SessionID  Vi,
float  Delay 
)

Sets the trigger delay time in seconds with respect to the trigger for the trigger display location in the LEFT position.

Positive values cause the actual trigger to occur after the trigger condition is met. This places the trigger event to the left of the trigger point on the display, and is useful for viewing events during a pulse, some fixed delay time after the rising edge trigger. Negative trigger delay places the trigger event to the right of the trigger point on the display, and is useful for looking at events before the trigger edge.

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

◆ PwrSnsr_SetTrigHoldoff()

EXPORT int PwrSnsr_SetTrigHoldoff ( SessionID  Vi,
float  Holdoff 
)

Sets the trigger holdoff time in seconds.

Trigger holdoff is used to disable the trigger for a specified amount of time after each trigger event. The holdoff time starts immediately after each valid trigger edge, and will not permit any new triggers until the time has expired. When the holdoff time is up, the trigger re-arms, and the next valid trigger event (edge) will cause a new sweep. This feature is used to help synchronize the power meter with burst waveforms such as a TDMA or GSM frame. The trigger holdoff resolution is 10 nanoseconds, and it should be set to a time that is just slightly shorter than the frame repetition interval.

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

◆ PwrSnsr_SetTrigHoldoffMode()

EXPORT int PwrSnsr_SetTrigHoldoffMode ( SessionID  Vi,
PwrSnsrHoldoffModeEnum  HoldoffMode 
)

Sets the holdoff mode to normal or gap holdoff.

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

◆ PwrSnsr_SetTrigLevel()

EXPORT int PwrSnsr_SetTrigLevel ( SessionID  Vi,
float  Level 
)

Set the trigger level for synchronizing data acquisition with a pulsed input signal.

The internal trigger level entered should include any global offset and will also be affected by the frequency cal factor. The available internal trigger level range is sensor dependent. The trigger level is set and returned in dBm. This setting is only valid for normal and auto trigger modes.

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

◆ PwrSnsr_SetTrigMode()

EXPORT int PwrSnsr_SetTrigMode ( SessionID  Vi,
PwrSnsrTriggerModeEnum  Mode 
)

Set the trigger mode for synchronizing data acquisition with pulsed signals.

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

◆ PwrSnsr_SetTrigOutMode()

EXPORT int PwrSnsr_SetTrigOutMode ( SessionID  Vi,
const char *  Channel,
int  Mode 
)

Sets the trigger out/mult io mode. Setting trigger mode overrides this command.

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".
ModeTrigger out/multi IO mode
Returns
Success (0) or error code.

◆ PwrSnsr_SetTrigPosition()

EXPORT int PwrSnsr_SetTrigPosition ( SessionID  Vi,
PwrSnsrTriggerPositionEnum  Position 
)

Set the position of the trigger event on displayed sweep.

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

◆ PwrSnsr_SetTrigSlope()

EXPORT int PwrSnsr_SetTrigSlope ( SessionID  Vi,
PwrSnsrTriggerSlopeEnum  Slope 
)

Sets the trigger slope or polarity.

When set to positive, trigger events will be generated when a signal rising edge crosses the trigger level threshold. When negative, trigger events are generated on the falling edge of the pulse.

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

◆ PwrSnsr_SetTrigSource()

EXPORT int PwrSnsr_SetTrigSource ( SessionID  Vi,
PwrSnsrTriggerSourceEnum  Source 
)

Get the signal the power meter monitors for a trigger. It can be channel external input, or independent.

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

◆ PwrSnsr_SetTrigVernier()

EXPORT int PwrSnsr_SetTrigVernier ( SessionID  Vi,
float  Vernier 
)

Set the fine position of the trigger event on the power sweep.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
VernierTrigger position -30.0 to 30.0 (0.0 = left, 5.0 = middle, 10.0 = Right).
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
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".
Units
Returns
Success (0) or error code.

◆ PwrSnsr_SetVerticalCenter()

int EXPORT PwrSnsr_SetVerticalCenter ( SessionID  Vi,
const char *  Channel,
float  VerticalCenter 
)

Sets vertical center based on current units: <arg> = (range varies by units)

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".
VerticalCenterVertical center in units
Returns
Success (0) or error code.

◆ PwrSnsr_SetVerticalScale()

int EXPORT PwrSnsr_SetVerticalScale ( SessionID  Vi,
const char *  Channel,
float  VerticalScale 
)

Sets vertical scale based on current units: <arg> = (range varies by units)

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".
VerticalCenterVertical scale in units
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
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
WriteProtectionSet 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
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_StatModeReset()

EXPORT int PwrSnsr_StatModeReset ( SessionID  Vi,
const char *  Channel 
)

Resets statistical capturing mode by clearing the buffers and restarting the aquisition timer.

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

◆ PwrSnsr_StopAcquisition()

EXPORT int PwrSnsr_StopAcquisition ( SessionID  Vi)

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

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_Write()

EXPORT int PwrSnsr_Write ( SessionID  Vi,
const char *  Channel,
int  DataBufferSize,
unsigned char  Data[] 
)

Write a byte array to the meter.

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".
DataBufferSizeSize of the buffer in bytes.
DataData to send.
Returns
Success (0) or error code.

◆ PwrSnsr_Zero()

EXPORT int PwrSnsr_Zero ( SessionID  Vi,
const char *  Channel 
)

Performs a zero offset null adjustment.

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".
Returns
Success (0) or error code.

◆ PwrSnsr_ZeroQuery()

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

Performs a zero offset null adjustment and returns true if successful.

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".
ValBoolean value for operation success or failure.
Returns
Success (0) or error code.