Model Plugin – OnTheFly Step Results

Use the OnTheFly Step Results entry point to obtain step results during test execution. For example, when you enable the On-The-Fly Reporting option in the Report Options dialog box, the built-in reporting plug-in calls OnTheFly Step Results to append results information to the report during test execution.

A process model calls OnTheFly Step Results only for plug-ins configured to process results on-the-fly. The <NI_ModelPlugin>.Base.ProcessOnTheFly subproperty stores the on-the-fly setting. TestStand collects step results until the number of results exceeds a threshold value you specify and then passes the results through the process model to OnTheFly Step Results for processing. The number of results the entry point receives can vary depending on multiple factors, such as the options you specify in the Advanced Result Processing Settings dialog box.

A process model calls OnTheFly Step Results from all threads that generate results. Controller threads in the Batch and Parallel process models do not generate results.

Although a test socket thread can create multiple child threads, the TestStand process models prevent sockets from calling OnTheFly Step Results simultaneously for results from more than one thread in the same test socket. Therefore, OnTheFly Step Results can access per-socket data without additional synchronization.

The OnTheFly Step Results entry point accepts the following parameters:

The Steps, Results, CallbackNames, and ParentIds parameters are parallel arrays. For any given array index n, the result element at Results[n] and the values of Steps[n], CallbackNames[n], and ParentIds[n] represent the n^th result and the step that generated the result, the callback name of the result, and the ID of the parent for that result, respectively.