VeriStand .NET API Reference

CustomDevice.Decimation Property

Gets or sets the decimation factor for the custom device, which determines how many iterations of the Primary Control Loop (PCL) occur between calls to the custom device.

Namespace: NationalInstruments.VeriStand.SystemDefinitionAPI
Assembly: NationalInstruments.VeriStand.SystemDefinitionAPI (in NationalInstruments.VeriStand.SystemDefinitionAPI.dll) Version: 2013.0.0.0 (2013.0.0.0)
Visual Basic (Declaration)
Public Overridable Property Decimation As Integer
C#
public virtual int Decimation { get; set; }
Visual C++
public:
virtual property int Decimation {
	int get ();
	void set (int value);
}

Property Value

The decimation factor. A value of 1 specifies no decimation.

Remarks

NI VeriStand handles decimation differently for inline and asynchronous custom devices.

Inline Custom Devices

The PCL does not call a custom device if this property specifies not to call the device on that iteration. For example, if you set this property to 4, the PCL calls the device on every fourth iteration.

Because inline custom devices execute within the PCL, the custom device must execute in a short enough amount of time for the entire PCL to complete a full iteration, including the execution of the custom device.

Asynchronous Custom Devices

This property only affects when the PCL reads and writes the FIFOs it uses to communicate with the custom device. For example, if you set this property to 4, the PCL reads and writes the FIFOs on every fourth iteration.

Because asynchronous custom devices run in a parallel loop to the PCL, the amount of time the custom device takes to execute does not affect the timing of the PCL execution.

See Also

Log in to get a better experience