winIDEA SDK
isys::ITestCaseController Class Referenceabstract

Description

Interface class for test case controllers.

#include <ITestCaseController.h>

Inheritance diagram for isys::ITestCaseController:
isys::CSystemTestController isys::CTestCaseController

Public Member Functions

virtual DWORD getTestCaseHandle ()=0
 Returns the test case handle. More...
 
virtual void setTestTimeout (int timeout)=0
 Sets timeout in milliseconds for test execution - after this timeout the test is terminated.
 
virtual void createPersistentVariable (const std::string &variableName, const std::string &typeName)=0
 This method creates variable on stack. More...
 
virtual void deletePersistentVariable (const std::string &variableName)=0
 Deletes variable. More...
 
virtual void commitDeletedVars ()=0
 Deletes variables deleted with deletePersistentVariable() on the target.
 
virtual void initPersistentVars ()=0
 Allocates persistent variables, which were created with createPersistentVariable(), on the stack. More...
 
virtual void cleanPersistentVars ()=0
 Cleans persistent variables from the stack.
 

Member Function Documentation

◆ createPersistentVariable()

virtual void isys::ITestCaseController::createPersistentVariable ( const std::string &  variableName,
const std::string &  typeName 
)
pure virtual

This method creates variable on stack.

The variable object created with this method is destroyed when the parent CSystemTestController object is destroyed. This method may not be called when unit test is in progress. Call initPersistentVars() and modify() to initialize the created variable.

Parameters
variableNamename of the variable to be created
typeNametype of the variable. This should be one of the existing types in the application under test (defined in debug symbol table).

Python example.

Implemented in isys::CSystemTestController, and isys::CTestCaseController.

◆ deletePersistentVariable()

virtual void isys::ITestCaseController::deletePersistentVariable ( const std::string &  variableName)
pure virtual

Deletes variable.

Note that method commitDeletedVars() must be called after all vars are deleted to apply changes on the target.

Parameters
variableNamename of the variable to be deleted. The variable had to be created with createVariable() before this call.

Implemented in isys::CSystemTestController, and isys::CTestCaseController.

◆ getTestCaseHandle()

virtual DWORD isys::ITestCaseController::getTestCaseHandle ( )
pure virtual

Returns the test case handle.

To be used when there is a need for other processes to access the test case info.

Implemented in isys::CSystemTestController, and isys::CTestCaseController.

◆ initPersistentVars()

virtual void isys::ITestCaseController::initPersistentVars ( )
pure virtual

Allocates persistent variables, which were created with createPersistentVariable(), on the stack.

When persistent variables are no longer needed, call cleanPersistentVars().

Implemented in isys::CSystemTestController, and isys::CTestCaseController.