NI-DCPower .NET fx45 API Reference

Table of Contents

DCPowerOutputMeasurement Class

  • Updated2024-01-04
  • 5 minute(s) read
DCPowerOutputMeasurement Class

DCPowerOutputMeasurement Class

Provides properties and methods used to perform operations related to NI-DCPower output measurements.

Inheritance Hierarchy

SystemObject
  NationalInstruments.ModularInstruments.NIDCPowerDCPowerSubObject
    NationalInstruments.ModularInstruments.NIDCPowerDCPowerOutputMeasurement

Namespace:  NationalInstruments.ModularInstruments.NIDCPower
Assembly:  NationalInstruments.ModularInstruments.NIDCPower.Fx45 (in NationalInstruments.ModularInstruments.NIDCPower.Fx45.dll) Version: 2023

Syntax

public sealed class DCPowerOutputMeasurement : DCPowerSubObject
Public NotInheritable Class DCPowerOutputMeasurement
	Inherits DCPowerSubObject

The DCPowerOutputMeasurement type exposes the following members.

Properties

  NameDescription
Public propertyApertureTime
Gets or sets the measurement aperture time, in seconds, for the channel configuration. You can specify aperture time units in the ApertureTimeUnits property.
Public propertyApertureTimeUnits
Gets or sets the units of the ApertureTime property for the channel configuration.
Public propertyAutorange
Specifies whether the hardware automatically selects the best range to measure the signal.
Public propertyAutorangeApertureTimeMode
Specifies whether the aperture time used for the measurement autorange algorithm is determined automatically or customized using the AutorangeApertureTimeMode property
Public propertyAutorangeBehavior
Specifies the the algorithm the hardware uses for measurement autoranging. Enable autoranging using Autorange property.
Public propertyAutorangeMaximumDelayAfterRangeChange
Balances between settling time and maximum measurement time by specifying the maximum time delay between when a range change occurs and when measurements resume.
Public propertyAutorangeMinimumApertureTime
Gets or sets the measurement autorange minimum aperture time for the channel configuration. You can specify aperture time units in the AutorangeMinimumApertureTimeUnits property.
Public propertyAutorangeMinimumApertureTimeUnits
Gets or sets the units of the AutorangeMinimumApertureTime property for the channel configuration.
Public propertyAutorangeMinimumCurrentRange
Specifies the lowest current range used during measurement autoranging. The maximum range used is range that includes the value specified in the compliance limit property. Limiting the lowest range used during autoranging can improve the speed of the autoranging algorithm and/or minimize thrashing between ranges for noisy signals.
Public propertyAutorangeMinimumVoltageRange
Specifies the lowest voltage range used during measurement autoranging. The maximum range used is range that includes the value specified in the compliance limit property. Limiting the lowest range used during autoranging can improve the speed of the autoranging algorithm and/or minimize thrashing between ranges for noisy signals.
Public propertyAutorangeThresholdMode
Specifies thresholds used during autoranging to determine when range changing occurs. Enable autoranging using Autorange property.
Public propertyAutoZero
Gets or sets the auto-zero method to use on the device.
Public propertyBufferSize
Gets or sets the number of samples that the active channel measurement buffer can hold.
Public propertyFetchBacklog
Returns the number of measurements acquired that have not been fetched yet.
Public propertyIsRecordLengthFinite
Gets or sets a value indicating whether to take continuous measurements.
Public propertyMeasureWhen
Gets or sets when the measure unit should acquire measurements. Unless this property is configured to OnMeasureTrigger, the DCPowerMeasureTriggerType property is ignored.
Public propertyNoiseRejection
Gets or sets the relative weighting of samples in a measurement.
Public propertyPowerLineFrequency
Gets or sets the power line frequency for all channels in the session. NI-DCPower uses this value to select a timebase for setting the ApertureTime property in power line cycles (PLCs).
Public propertyRecordDeltaTime
Gets the amount of time between the starts of two consecutive measurements in a measure record. Use this property only after you commit the desired measurement settings.
Public propertyRecordLength
Gets or sets the number of measurements that compose a measure record. If you set this property to a value greater than 1, the DCPowerMeasurementWhen property must be set to AutomaticallyAfterSourceComplete or OnMeasureTrigger.
Public propertyResetAverageBeforeMeasurement
Gets or sets whether the measurement returned from any measurement call starts with a new measurement call or returns a measurement that has already begun or completed.
Public propertySamplesToAverage
Gets or sets the number of samples to average when you take a measurement. Increasing the number of samples to average decreases measurement noise, but increases the time required to take a measurement.
Public propertySense
Gets or sets either local or remote sensing of the output voltage for the specified channel(s).
Top

Methods

  NameDescription
Public methodConfigureApertureTime
Configures the aperture time on the specified channel(s).
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top

Remarks

For more information, refer to NI DC Power Supplies and SMUs Help.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Log in to get a better experience