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

Interface forming the basis for all ResultListeners. More...

Inheritance diagram for OpenTap.IResultListener:
OpenTap.IResource OpenTap.ITapPlugin OpenTap.IExecutionListener OpenTap.IMergedTableResultListener OpenTap.ResultListener OpenTap.LogResultListener OpenTap.TestPlanRunSummaryListener

Public Member Functions

void OnTestPlanRunStart (TestPlanRun planRun)
 Called just when test plan starts. More...
 
void OnTestPlanRunCompleted (TestPlanRun planRun, System.IO.Stream logStream)
 Called when test plan finishes. At this point no more result will be sent to the result listener from said test plan run. More...
 
void OnTestStepRunStart (TestStepRun stepRun)
 Called just before a test step is started. More...
 
void OnTestStepRunCompleted (TestStepRun stepRun)
 Called when a test step run is completed. Result might still be propagated to the result listener after this event. More...
 
void OnResultPublished (Guid stepRunID, ResultTable result)
 Called when a result is received. More...
 
- Public Member Functions inherited from OpenTap.IResource
void Open ()
 When overridden in a derived class, opens a connection to the resource represented by this class.
 
void Close ()
 When overridden in a derived class, closes the connection made to the resource represented by this class.
 

Additional Inherited Members

- Properties inherited from OpenTap.IResource
string Name [getset]
 A short name to display in the user interface in areas with limited space.
 
bool IsConnected [get]
 Indicates whether this DUT is currently connected. This value should be set by Open() and Close().
 

Detailed Description

Interface forming the basis for all ResultListeners.

Member Function Documentation

◆ OnResultPublished()

void OpenTap.IResultListener.OnResultPublished ( Guid  stepRunID,
ResultTable  result 
)

Called when a result is received.

Parameters
stepRunIDStep run parameters.
resultResult structure.

Implemented in OpenTap.ResultListener.

◆ OnTestPlanRunCompleted()

void OpenTap.IResultListener.OnTestPlanRunCompleted ( TestPlanRun  planRun,
System.IO.Stream  logStream 
)

Called when test plan finishes. At this point no more result will be sent to the result listener from said test plan run.

Parameters
planRunTest plan run parameters.
logStreamThe log file from the test plan run as a stream.

Implemented in OpenTap.ResultListener.

◆ OnTestPlanRunStart()

void OpenTap.IResultListener.OnTestPlanRunStart ( TestPlanRun  planRun)

Called just when test plan starts.

Parameters
planRunTest plan run parameters.

Implemented in OpenTap.ResultListener, and OpenTap.TestPlanRunSummaryListener.

◆ OnTestStepRunCompleted()

void OpenTap.IResultListener.OnTestStepRunCompleted ( TestStepRun  stepRun)

Called when a test step run is completed. Result might still be propagated to the result listener after this event.

Parameters
stepRunStep run parameters.

Implemented in OpenTap.ResultListener, and OpenTap.TestPlanRunSummaryListener.

◆ OnTestStepRunStart()

void OpenTap.IResultListener.OnTestStepRunStart ( TestStepRun  stepRun)

Called just before a test step is started.

Parameters
stepRunStep run parameters.

Implemented in OpenTap.ResultListener, and OpenTap.TestPlanRunSummaryListener.

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