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

Interface to listen to when steps execute what. More...

Inheritance diagram for OpenTap.IExecutionListener:
OpenTap.IResultListener OpenTap.IResource OpenTap.ITapPlugin

Public Member Functions

void OnTestStepExecutionChanged (Guid stepId, TestStepRun stepRun, StepState newState, long changeTime)
 Called whenever a step changes its execution state. More...
 
- Public Member Functions inherited from OpenTap.IResultListener
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 to listen to when steps execute what.

Member Function Documentation

◆ OnTestStepExecutionChanged()

void OpenTap.IExecutionListener.OnTestStepExecutionChanged ( Guid  stepId,
TestStepRun  stepRun,
StepState  newState,
long  changeTime 
)

Called whenever a step changes its execution state.

Parameters
stepIdThe given step
stepRunThe given step run. For PrePlanRun and PostPlanRun this is null.
newStateThe state that the teststep transitioned into.
changeTimeThe precise timestamp of when the change happened.

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