IviRFSigGen_ConfigureAM

CVI/LabWindows IVI Class Driver

IviRFSigGen_ConfigureAM

IviRFSigGenModulateAM Capability Group

C Function Prototype

ViStatus IviRFSigGen_ConfigureAM (ViSession vi, ViConstString source, ViInt32 scaling, ViReal64 depth);

Purpose

This function configures the modulation source, scaling, and depth for the signal generator's amplitude modulation.

Parameters

Name Type Description
vi ViSession The ViSession handle that you obtain from the IviRFSigGen_init or IviRFSigGen_InitWithOptions function. The handle identifies a particular instrument session.

Default Value: None

source ViConstString Specifies the source of the signal that is used as the modulating signal. If more than one source is specified, the voltages of all sources (internal and external) are summed. Multiple source names are separated by commas. The driver uses this value to set the IVIRFSIGGEN_ATTR_AM_SOURCE attribute.

Default Value: ""

scaling ViInt32 Specifies linear or logarithmic attenuation for amplitude modulation. The unit of the IVIRFSIGGEN_ATTR_AM_DEPTH attribute is changed with this setting. The driver uses this value to set the IVIRFSIGGEN_ATTR_AM_SCALING attribute.

Defined Values:
IVIRFSIGGEN_VAL_AM_SCALING_LINEAR
IVIRFSIGGEN_VAL_AM_SCALING_LOGARITHMIC

Default Value: IVIRFSIGGEN_VAL_AM_SCALING_LINEAR

depth ViReal64 Specifies the extent of modulation the signal generator applies to the RF-signal (carrier waveform) with the modulating signal as a result of summing all sources, internal and external. The driver uses this value to set the IVIRFSIGGEN_ATTR_AM_DEPTH attribute.

Units: If the IVIRFSIGGEN_ATTR_AM_SCALING attribute is set to Linear, then the units are percent (%). If the IVIRFSIGGEN_ATTR_AM_SCALING attribute is set to logarithmic, then the units are dBm.

Default Value: 0.0

Return Values