CAPLfunctionTestRemoveCondition

TestRemoveCondition

Valid for: CANoe DE • CANoe:lite DE • CANoe4SW DE • CANoe4SW:lite DE

Note
Conditions can only be removed in the test case or on the test module level on which they were also added. If a test case is abandoned, then the constraints created in this test case are removed automatically. Similarly, with the end of a test module, all constraints are removed automatically.

Function Syntax

long TestRemoveCondition (dword aAuxHandle);
long TestRemoveCondition (char aEventText[]);

Description

Removes an event object or an event text that was added as a condition. This function can be used both within a test case and also on the test module level.

Parameters

• aAuxHandle: Event object, for example a check from the TestService Library. Specified is the handle that is returned when a check is created.
• aEventText: Textual name of an event whose occurrence should be monitored. This event can be triggered with the function TestSupplyTextEvent.

Return Values

• 0: Constraint was removed successfully
• < 0: Constraint could not be removed

Example

dword checkId;
dword numCheckEvents;

// start the Error Frame observation
checkId = ChkStart_ErrorFramesOccured();
// Add check as condition,
// that means that check violations are reported and
// the verdict of the test case is set to "failed"
TestAddCondition(checkId);
// sequence of different actions and waiting conditions
TestWaitForTimeout(1000);
// Remove check as condition
TestRemoveCondition(checkId);

// stop the check
ChkControl_Stop(checkId);
// reset stored values of the check
ChkControl_Reset(checkId);

// start the check again without adding as condition,
// that means that Error Frames are observed, but violations
// are not reported and do not set the test case verdict to "failed"
ChkControl_Start(checkId);
// sequence of different actions and waiting conditions
TestWaitForTimeout(1000);
// stop the check
ChkControl_Stop(checkId);

// analysis of check
numCheckEvents = ChkQuery_NumEvents(checkId);
if (numCheckEvents > 0)
    TestStepFail("Error Frame occurred!");

// destroy check
ChkControl_Destroy(checkId);

TestAddCondition • TestCheckConditon • TestSupplyTextEvent