Skip to main content

ChkCreate_J1939BAM, ChkStart_J1939BAM

Valid for: CANoe DE • CANoe4SW DE

Function Syntax

  • dword ChkCreate_J1939BAM(dword min, dword max, char[] callback1);
  • dword ChkCreate_J1939BAM(dword originatorAddress, dword min, dword max, char[] callback1);
  • dword ChkCreate_J1939BAM(Node origninatorNode, dword min, dword max, char[] callback1);
  • dword ChkStart_J1939BAM(dword min, dword max, char[] callback1);
  • dword ChkStart_J1939BAM(dword orginatorAddress, dword min, dword max, char[] callback1);
  • dword ChkStart_J1939BAM(Node origninatorNode, dword min, dword max, char[] callback1);

Constructor

TestCheck::CreateJ1939BAM
  • TestCheck::CreateJ1939BAM (dword min, dword max, char[] callback2);
  • TestCheck::CreateJ1939BAM (dword orginatorAddress, dword min, dword max, char[] callback2);
  • TestCheck::CreateJ1939BAM (Node origninatorNode, dword min, dword max, char[] callback2);

Check Name

J1939 BAM (Check Description)

Description

Observes the BAM transport protocol. It is possible to observe all BAM transmissions or only the transmission of a specific originator node. Note: Dependent on the used parameter type the appropriate bus context in a multibus environment has only to be set before the function is called if the corresponding database object will be ambiguous. Further information on site MultiBus Environment.

Parameters

  • originatorNode: Originator node from database
  • originatorAddress: Originator address
    • Possible values:
      • 0 – 253: Observe originator node with this address
      • 254, -1 (or 0xFFFFFFFF): Observe all nodes
  • min: Minimum distance [ms] (Default 50ms)
  • max: Maximum distance [ms] (Default 200ms)
  • callback1: This parameter is optional. Name of the callback which is called when the check fails. Signature: void Callback( dword checkId )
  • callback2: This parameter is optional. Name of the callback which is called when the check fails. Signature: void Callback( TestCheck check )

Return Values

  • 0: Check could not be created and must not be referenced
  • > 0: Check was created successfully and may be referenced using the returned (handle-) value

Possible Errors

  • Specified node object does not exist in the database.
  • Invalid originator address.
  • CAPL callback does not exist.

Example

// checks the BAM transport protocol of node N1
checkId = ChkStart_J1939BAM(N1, 100, 200);
TestAddCondition(checkId);

// sequence of different actions and waiting conditions
TestWaitForTimeout(1000);
TestRemoveCondition(checkId);
Functions to Configure ChecksCommands to Control Checks