OpenTAP 9.24
API Reference
Public Member Functions | List of all members
OpenTap.IResultSource Interface Reference

Interface that the TestStep can access through the Results property. More...

Inheritance diagram for OpenTap.IResultSource:
OpenTap.ResultSource

Public Member Functions

void Wait ()
 Waits for the propagation of results from all Proxies to the Listeners. Normally this is not necessary. However, if a step needs to change a property after it has written results, this method makes sure the ResultListeners record the previous/correct value before changing it.
 
void Defer (Action action)
 Defer an action from the current teststep run. This action will be called as soon as possible, and block the execution for any parent steps. More...
 
void Finally (Action< Task > action)
 Run an action as the final step after the last deferred action. This should not be used while the associated TestStep is running. More...
 
void Publish (string name, List< string > columnNames, params IConvertible[] results)
 Stores a result. These results will be propagated to the ResultStore after the TestStep completes. More...
 
void PublishTable (string name, List< string > columnNames, params Array[] results)
 The fastest way to store a result. These results will be propagated to the ResultStore after the TestStep completes. More...
 

Detailed Description

Interface that the TestStep can access through the Results property.

Member Function Documentation

◆ Defer()

void OpenTap.IResultSource.Defer ( Action  action)

Defer an action from the current teststep run. This action will be called as soon as possible, and block the execution for any parent steps.

Parameters
action

Implemented in OpenTap.ResultSource.

◆ Finally()

void OpenTap.IResultSource.Finally ( Action< Task >  action)

Run an action as the final step after the last deferred action. This should not be used while the associated TestStep is running.

Parameters
action

◆ Publish()

void OpenTap.IResultSource.Publish ( string  name,
List< string >  columnNames,
params IConvertible[]  results 
)

Stores a result. These results will be propagated to the ResultStore after the TestStep completes.

Parameters
nameName of the result.
columnNamesTitles of the columns.
resultsThe values of the results to store.

Implemented in OpenTap.ResultSource.

◆ PublishTable()

void OpenTap.IResultSource.PublishTable ( string  name,
List< string >  columnNames,
params Array[]  results 
)

The fastest way to store a result. These results will be propagated to the ResultStore after the TestStep completes.

Parameters
nameName of the result.
columnNamesTitles of the columns.
resultsThe columns of the results to store.

This is the fastest way to store a large number of results.

Implemented in OpenTap.ResultSource.

OpenTAP 9.24 API built Tue Apr 30 2024 13:44:41