winIDEA SDK
Loading...
Searching...
No Matches
isys::ITestCaseController Class Referenceabstract

Interface class for test case controllers. More...

#include <ITestCaseController.h>

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

Public Member Functions

virtual void clean ()=0
virtual void cleanPersistentVars ()=0
 Cleans persistent variables from the stack.
virtual void commitDeletedVars ()=0
 Deletes variables deleted with deletePersistentVariable() on the target.
virtual void createPersistentVariable (const std::string &variableName, const std::string &typeName)=0
 This method creates variable on stack.
virtual CTestStubControllerSPtr createStub (const std::string &stubbedFunctionName)=0
virtual CTestStubControllerSPtr createStub (IConnectTest::EStubFlags flags, const std::string &stubbedFunctionName)=0
virtual void createUserStub (const std::string &functionName, const std::string &stubFunctionName)=0
virtual void deletePersistentVariable (const std::string &variableName)=0
 Deletes variable.
virtual void destroy ()=0
virtual std::string evaluate (const std::string &expression, uint32_t dwEvalFlags=0)=0
virtual CTestStubControllerSPtr getActiveStub ()=0
virtual IConnectTest::EState getStatus ()=0
virtual IConnectTest::EState getStatus (uint32_t flags)=0
virtual uint32_t getTestCaseHandle ()=0
 Returns the test case handle.
virtual bool init ()=0
virtual void initPersistentVars ()=0
 Allocates persistent variables, which were created with createPersistentVariable(), on the stack.
virtual std::string modify (const std::string &lval, const std::string &rval, uint32_t dwEvalFlags=0)=0
virtual void modifyAsString (const std::string &lval, const std::string &rval, uint32_t dwEvalFlags=0)=0
virtual void run ()=0
virtual void setDebugModeOn ()=0
virtual void setTestBatchNS (bool isBatchBegin)=0
virtual void setTestTimeout (int timeout)=0
 Sets timeout in milliseconds for test execution - after this timeout the test is terminated.
virtual bool waitUntilStopped (int timeout=0, uint32_t pollingInterval=100)=0
virtual ~ITestCaseController ()

Detailed Description

Interface class for test case controllers.

Constructor & Destructor Documentation

◆ ~ITestCaseController()

virtual isys::ITestCaseController::~ITestCaseController ( )
inlinevirtual
Since
9.12.288

Member Function Documentation

◆ clean()

virtual void isys::ITestCaseController::clean ( )
pure virtual
Since
9.12.288

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

◆ cleanPersistentVars()

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

Cleans persistent variables from the stack.

Python example: test_persistent_vars.py

Since
9.12.288

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

◆ commitDeletedVars()

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

Deletes variables deleted with deletePersistentVariable() on the target.

Python example: test_persistent_vars.py

Since
9.12.288

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

◆ 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).
Since
9.12.288

Python example: test_persistent_vars.py

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

◆ createStub() [1/2]

virtual CTestStubControllerSPtr isys::ITestCaseController::createStub ( const std::string & stubbedFunctionName)
pure virtual
Since
9.12.288

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

◆ createStub() [2/2]

virtual CTestStubControllerSPtr isys::ITestCaseController::createStub ( IConnectTest::EStubFlags flags,
const std::string & stubbedFunctionName )
pure virtual
Since
9.12.288

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

◆ createUserStub()

virtual void isys::ITestCaseController::createUserStub ( const std::string & functionName,
const std::string & stubFunctionName )
pure virtual
Since
9.12.288

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.
Since
9.12.288

Python example: test_persistent_vars.py

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

◆ destroy()

virtual void isys::ITestCaseController::destroy ( )
pure virtual
Since
9.12.288

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

◆ evaluate()

virtual std::string isys::ITestCaseController::evaluate ( const std::string & expression,
uint32_t dwEvalFlags = 0 )
pure virtual
Since
9.12.288

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

◆ getActiveStub()

virtual CTestStubControllerSPtr isys::ITestCaseController::getActiveStub ( )
pure virtual
Since
9.12.288

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

◆ getStatus() [1/2]

virtual IConnectTest::EState isys::ITestCaseController::getStatus ( )
pure virtual
Since
9.12.288

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

◆ getStatus() [2/2]

virtual IConnectTest::EState isys::ITestCaseController::getStatus ( uint32_t flags)
pure virtual
Since
9.12.288

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

◆ getTestCaseHandle()

virtual uint32_t 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.

Since
9.12.288

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

◆ init()

virtual bool isys::ITestCaseController::init ( )
pure virtual
Since
9.12.288

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().

Python example: test_persistent_vars.py

Since
9.12.288

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

◆ modify()

virtual std::string isys::ITestCaseController::modify ( const std::string & lval,
const std::string & rval,
uint32_t dwEvalFlags = 0 )
pure virtual
Since
9.12.288

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

◆ modifyAsString()

virtual void isys::ITestCaseController::modifyAsString ( const std::string & lval,
const std::string & rval,
uint32_t dwEvalFlags = 0 )
pure virtual
Since
9.12.288

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

◆ run()

virtual void isys::ITestCaseController::run ( )
pure virtual
Since
9.12.288

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

◆ setDebugModeOn()

virtual void isys::ITestCaseController::setDebugModeOn ( )
pure virtual
Since
9.12.288

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

◆ setTestBatchNS()

virtual void isys::ITestCaseController::setTestBatchNS ( bool isBatchBegin)
pure virtual
Since
9.12.288

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

◆ setTestTimeout()

virtual void isys::ITestCaseController::setTestTimeout ( int timeout)
pure virtual

Sets timeout in milliseconds for test execution - after this timeout the test is terminated.

Since
9.12.288

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

◆ waitUntilStopped()

virtual bool isys::ITestCaseController::waitUntilStopped ( int timeout = 0,
uint32_t pollingInterval = 100 )
pure virtual
Since
9.12.288

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