CNiIviScopeChannel::Configure

Measurement Studio IVI

Class
CNiIviScopeChannel::
Configure()
Base ClassesData ItemsFunctionsGo to hierarchy chart    Prev page: RangeNext page: ConfigureCharacteristics    
Public Function Declared in:
NiIviScope.h

'Declaration' icon -- Shortcut to top of page. Declaration

inline void Configure(
    const CString &channel,
    double range,
    double offset,
    long coupling,
    double probeAttenuation,
    bool enabled);

'Description' icon -- Shortcut to top of page. Description

Configures the most commonly configured properties of the oscilloscope channel sub-system.

Shortcut to top of page. Parameters

const CString &channel

The channel you want to configure.

double range

Specifies the absolute value in volts of the input range the oscilloscope can acquire for the channel. For example, to acquire a sine wave which spans between -5.0 and 5.0 volts, set this property to 10.0 volts.

This function sets the Range property to the value you specify for this parameter.

double offset

Specifies the location in volts relative to ground of the center of the range that you specify with the Range property. For example, to acquire a sine wave that spans between 0.0 and 10.0 volts, set this property to 5.0 volts.

This function sets the Offset property to the value you specify for this parameter.

long coupling

Specifies how the oscilloscope couples the input signal for the channel.

The following list includes valid values:

  • CNiIviScope::Ac - The oscilloscope AC couples the input signal.
  • CNiIviScope::Dc - The oscilloscope DC couples the input signal.
  • CNiIviScope::Gnd - The oscilloscope Ground couples the input signal.

This function sets the Coupling property to the value you specify for this parameter.

double probeAttenuation

Specifies the scaling factor by which the probe you attach to the channel attenuates the input. For example, when you use a 10:1 probe, set this property to 10.0.

This driver reserves negative values to control the oscilloscope's automatic probe sense capability. Setting this property to CNiIviScope::OnProbeSense configures the oscilloscope to sense the attenuation of the probe automatically. After you enable the automatic probe sense, subsequent queries of this property return the value CNiIviScope::OnProbeSense. Use the ProbeSense property to obtain the actual probe attenuation.

If you set the oscilloscope to sense the probe attenuation automatically, the probe attenuation value can change at any time. When the oscilloscope detects a new probe attenuation value, other settings in the oscilloscope might also change. The driver has no way of knowing when these changes occur. Therefore, when you enable the automatic probe sense capability, this driver disables caching for properties that depend on the probe attenuation. These properties include Range, Offset and all the properties that configure trigger levels. To maximize performance, set this property to a manual probe attenuation setting.

If the oscilloscope is set to sense the probe attenuation automatically, setting this property to a positive value disables the automatic probe sense and configures the oscilloscope to use the manual probe attenuation you specify.

If you use a manual probe attenuation, you must set this property to reflect the new probe attenuation each time you attach a different probe.

This function sets the ProbeAttenuation property to the value you specify for this parameter.

bool enabled

Specifies whether the oscilloscope acquires a waveform or measurement for a channel.

This function sets the Enabled property to the value you specify for this parameter.

'See Also' icon -- Shortcut to top of page. See Also