OpenTAP 9.25
API Reference
Public Member Functions | List of all members
OpenTap.ResultSource Class Reference

Temporarily holds results from a TestStep, before they are propagated to the ResultListener by the TestPlan. See TestStep.Results More...

Inheritance diagram for OpenTap.ResultSource:
OpenTap.IResultSource

Public Member Functions

void AddParameter (ResultParameter param)
 Adds an additional parameter to this TestStep run. More...
 
 ResultSource (TestStepRun stepRun, TestPlanRun planRun)
 Creates a new ResultProxy. Done for each test step run. More...
 
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 test step run. This means the action will be executed some time after the current run. More...
 
void Publish< T > (T result)
 Stores an object as a result. These results will be propagated to the ResultStore after the TestStep completes. More...
 
void Publish (ResultTable result)
 Publishes a result table.
 
void Publish< T > (string name, T result)
 Stores an object as a result. These results will be propagated to the ResultStore after the TestStep completes. 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...
 
void PublishTable (ResultTable table)
 Publishes a result table.
 

Detailed Description

Temporarily holds results from a TestStep, before they are propagated to the ResultListener by the TestPlan. See TestStep.Results

Constructor & Destructor Documentation

◆ ResultSource()

OpenTap.ResultSource.ResultSource ( TestStepRun  stepRun,
TestPlanRun  planRun 
)
inline

Creates a new ResultProxy. Done for each test step run.

Parameters
stepRunTestStepRun that this result proxy is proxy for.
planRunTestPlanRun that this result proxy is proxy for.

Member Function Documentation

◆ AddParameter()

void OpenTap.ResultSource.AddParameter ( ResultParameter  param)
inline

Adds an additional parameter to this TestStep run.

Parameters
paramParameter to add.

◆ Defer()

void OpenTap.ResultSource.Defer ( Action  action)
inline

Defer an action from the current test step run. This means the action will be executed some time after the current run.

Parameters
action

Implements OpenTap.IResultSource.

◆ Publish()

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

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.

Implements OpenTap.IResultSource.

◆ Publish&lt; T &gt;() [1/2]

void OpenTap.ResultSource.Publish< T > ( string  name,
result 
)
inline

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

Template Parameters
T
Parameters
nameThe name of the result.
resultThe result whose properties should be stored.

◆ Publish&lt; T &gt;() [2/2]

void OpenTap.ResultSource.Publish< T > ( result)
inline

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

Template Parameters
T
Parameters
resultThe result whose properties should be stored.

◆ PublishTable()

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

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.

Implements OpenTap.IResultSource.

OpenTAP 9.25 API built Tue Aug 6 2024 07:49:24