PendingFrames Class

NI VeriStand 2018 Help

Edition Date: May 2018

Part Number: 372846M-01

»View Product Info
Download Help (Windows Only)

Members See Also


Represents a Pending Frames channel associate with an NI-XNET DataFileReplay file. This channel stores the number of frames in the outgoing transmission queue of the current NI-XNET streaming session. You can use this channel to determine whether data is replaying as expected.

Namespace: NationalInstruments.VeriStand.SystemDefinitionAPI

Assembly: NationalInstruments.VeriStand.SystemDefinitionAPI (in NationalInstruments.VeriStand.SystemDefinitionAPI.dll) Version: 2017.0.0.0 (2017.0.0.128)

Syntax

Visual Basic (Declaration)
Public Class PendingFrames _
	Inherits Channel

C#
public class PendingFrames : Channel

Visual C++
public ref class PendingFrames : public Channel

Remarks

Data is Replaying Correctly

  • If the value of Pending Frames is changing, the value of DataFileStatus is true (True in Visual Basic), and the value of DataFileError is 0 (no error), data is replaying correctly.
  • If the value of Pending Frames is a non-zero number that is not changing, the value of DataFileStatus is true (True in Visual Basic), and the value of DataFileError is 0 (no error), data is replaying, but you might need to reduce the number of frames you are adding for replay or the rate at which you are adding them. The output queue for streaming has a limited size, and you might be attempting to stream too much data too quickly.
  • If the value of Pending Frames is 0, the value of DataFileStatus was true (True in Visual Basic) but changes to false (False in Visual Basic), and the value of DataFileError is 0 (no error), data replay has completed.

Data is Not Replaying Correctly

  • If the value of Pending Frames is 0, the value of DataFileStatus is true (True in Visual Basic), and the value of DataFileError is 0 (no error), you have exceeded the size of the outgoing buffer. Data is not replaying correctly. Reduce the number of frames you are attempting to write to the output stream in a single chunk.
  • If the value of DataFileError is anything other than 0, data is not replaying correctly, regardless of the Pending Frames value.
Note:The replay process creates this channel. You cannot directly call this class.

Inheritance Hierarchy

System.Object
    NationalInstruments.VeriStand.SystemDefinitionAPI.BaseNode
        NationalInstruments.VeriStand.SystemDefinitionAPI.Channel
            NationalInstruments.VeriStand.SystemDefinitionAPI.PendingFrames

Thread Safety

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

See Also

Reference

PendingFrames Members

NationalInstruments.VeriStand.SystemDefinitionAPI Namespace

WAS THIS ARTICLE HELPFUL?

Not Helpful