RTP Series API Programming Reference  1.2.1
Trace Functions

Functions

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

Detailed Description

Trace functions

Function Documentation

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