RTP Series API Programming Reference  1.2.1
Trigger

Functions

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_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_SetTrigOutMode (SessionID Vi, const char *Channel, int Mode)
 Sets the trigger out/mult io mode. Setting trigger mode overrides this command. More...
 

Detailed Description

Trigger related functions

Function Documentation

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