Skip to main content

​
TestJoinSignalInRange

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

​
Function Syntax

  • long TestJoinSignalInRange (Signal aSignal, float aLowLimit, float aHighLimit); // form 1
  • long TestJoinSignalInRange (dbEnvVar aEnvVar, float aLowLimit, float aHighLimit); // form 2
  • long TestJoinSignalInRange (sysvar aSysVar, float aLowLimit, float aHighLimit); // form 3
  • long TestJoinSignalInRange (Signal aSignal, float aLowLimit, float aHighLimit, word waitForSignalUpdate); // form 4
  • long TestJoinSignalInRange (sysvar aSysVar, int64 aLowLimit, int64 aHighLimit); // form 5
  • long TestJoinSignalInRange (ServiceSignalNumber aSignal, float aLowLimit, float aHighLimit); // form 6
  • long TestJoinSignalInRange (ServiceSignalNumber aSignal, float aLowLimit, float aHighLimit, word waitForSignalUpdate); // form 7

​
Description

Completes the current set of “joined events or system variables” with the transmitted event. This function does not wait. By default, this condition will be checked immediately when the set of joined events is evaluated by TestWaitForAllJoinedEvents or TestWaitForAnyJoinedEvent and may not wait for a value change. It is also possible to delay the checking of the condition until the next message with the given signal arrives.

​
Parameters

  • aSignal: Signal that should be awaited with a value inside or equal the limits.
  • aEnvVar: Environment variable that should be awaited with a value inside or equal the limits.
  • aSysVar: System variable that should be awaited with a value inside or equal the limits. May also be a specific element of a variable of type struct or generic array. Note: Not available for a single element of a double or integer array.
  • aLowLimit: Lower limit of the value.
  • aHighLimit: Upper limit of the value.
  • waitForSignalUpdate: Condition should be checked immediately when the set of joined events is evaluated by TestWaitForAllJoinedEvents or TestWaitForAnyJoinedEvent, or condition should be checked when the next message with the given signal will arrive.

​
Return Values

  • -3: Join error.
  • -2: Type of the system/environment variable is not valid – only float or integer are valid – or signal or system variable is not valid or invalid limits of the given range.
  • -1: General error, for example, functionality is not available.
  • > 0: Number of the joined event.

​
Example

// waits until the value of signal or system variable ‚Velocity’ is in the given range
long result;
dword index = 0;
result = TestJoinSignalInRange(Velocity, 30, 50);
// ... other join events
TestJoinEnvVarEvent(MyEnvVar);
TestJoinTextEvent("ErrorFrame occurred!");

index = TestWaitForAnyJoinedEvent(2000);
TestWaitForSignalInRange • TestWaitForAnyJoinedEvent • TestWaitForAllJoinedEvents