IF_TestCase

Overview

Type:	Interface
Available as of:	V1.0.0.0

NOTE: This interface type is not intended for use in user logic.

Task

The IF_TestCase interface is automatically implemented in every test case.

Execute Method

The Execute method contains the actions and verifications of the tests.

Interface

Input	Data type	Description
i_xFirstCall	BOOL	TRUE: The method is called for the first time. FALSE: After the first call to the method. Can be used to initialize state machines.
i_ifErrorLogger	IF_ErrorLogger	Interface to report detected errors.

Input

Data type

Description

i_xFirstCall

BOOL

TRUE: The method is called for the first time.

FALSE: After the first call to the method.

Can be used to initialize state machines.

i_ifErrorLogger

IF_ErrorLogger

Interface to report detected errors.

Output	Data type	Description
q_rProgress	REAL	Used to display the test case progress. Write-enabled parameter.
q_sState	STRING[255]	Textual description of the status of a test case. Write-enabled parameter.

Output

Data type

Description

q_rProgress

REAL

Used to display the test case progress.

Write-enabled parameter.

q_sState

STRING[255]

Textual description of the status of a test case.

Write-enabled parameter.

Return value

Data type	Description
ET_TestReturn	Refer to the ET_TestReturn enumeration.

Finalize Method

The Finalize method is performed when the Execute method has been completed successfully or not, or when it has been canceled. In contrast to CleanUp, the Finalize method is performed in the same cycle as the Execute method.