RTP Series API Programming Reference  1.2.1
Modulated Measurements

Functions

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

Detailed Description

Modulated measurement functions

Function Documentation

◆ 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_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_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.