Vector/CANoe Reference

Application

VectorAHI - OpenCANoe with Configuration

Opens the CANoe application and loads a configuration.

Input-Pins

• configFile → The complete path for the configuration.

• autoSave (optional) → A boolean value that indicates whether the active configuration should be saved if it has been changed (see Remarks).
  • Possible values are:
    • True → Automatic saving is executed.
    • False → Automatic saving is not executed.

• promptUser (optional) → A boolean value that indicates whether the user should intervene in error situations (see Remarks).
  • Possible values are:
    • True → The user is prompted for input in error situations.
    • False → The user is not notified.

Remarks

• If False is entered for the autoSave parameter, the function fails if the active configuration was changed.
• If False is entered for the promptUser parameter, the function fails if an error situation occurs.

Possible error situations include

• The active configuration was created or changed and not saved yet.
• Automatic saving fails for some reason (write protection, full disk, ...).

VectorAHI - OpenCANoe

Opens the CANoe application and loads a configuration.

VectorAHI - CloseCANoe

Closes the CANoe application.

Configuration

VectorAHI - Load Configuration

Loads a configuration into CANoe.

Input-Pins

• configFile → The complete path for the configuration.
• autoSave (optional) → A boolean value that indicates whether the active configuration should be saved if it has been changed (see Remarks).
  • Possible values are:
    • True: Automatic saving is executed.
    • False: Automatic saving is not executed.
• promptUser (optional) → A boolean value indicates whether the user should intervene in error situations (see Remarks).
  • Possible values are
    • True: The user is prompted for input in error situations.
    • False: The user is not notified.

Remarks

• If False is entered for the autoSave parameter, the function fails if the active configuration was changed.
• If False is entered for the promptUser parameter, the function fails if an error situation occurs.

Possible error situations include

• The active configuration was created or changed and not saved yet.
• Automatic saving fails for some reason (write protection, full disk, ...).

BUS

VectorAHI - InitializeBus
Initializes the bus to be used.

VectorAHI - ActivateBusTyp
Activates the bus to be used.

Signal

VectorAHI - GetRawValueOfSignal
Returns the current value of the signal as it was transmitted on the bus.

VectorAHI - SetRawValueOfSignal
Sets the RawValue of the BUS signal.

VectorAHI - GetSignalValue
Returns the active value of the Signal.

VectorAHI - GetSignalFullname
Determines the fully qualified name of a signal or a message.

VectorAHI - BUS Signal - Wait for rawValue
Wait until the Signal get the specified RawValue.

Vector AHI - BUS Signal - Wait for signalValue
Wait until the Signal get the specified value.

CAPL

VectorAHI - Call CAPL Function
Calls a CAPL function.

Reg/DeReg

VectorAHI - Register CAPL Function(s)]]
Registration of CAPL functions.

Configuration

VectorAHI - Configuration set (un)modified

VectorAHI - Configuration is modified
Returns information on whether the current configuration was modified since the time it was loaded or created, or sets this property.

General setup

VectorAHI - Compile&Verify
Compile all CAPL Functions in all Nodes.

Environment

Environment variable

VectorAHI - SetEnvironmentVariable
Sets the environment variable value.

VectorAHI - GetEnvironmentVariable
Returns the environment variable value.

VectorAHI - EnvironmentVariable - Wait for value
Wait until the environment variable get the specified value.

System

System variable

VectorAHI - SetSystemVariable
Sets the system variable value.

VectorAHI - GetSystemVariable
Returns the system variable value.

VectorAHI - SystemVariable - Wait for value]]
Wait until the system variable get the specified value.

Measurement

VectorAHI - Start Measurement
Starts the CANoe measurement.

VectorAHI - Measurement Running
If the measurement is running, True is returned; otherwise False is returned.

VectorAHI - Stop Measurement
Stops the CANoe measurement.

UI

Write

VectorAHI - Get text from write window

VectorAHI - Clear text of write window

Variable Update Service

VectorAHI - Start environment autom. update service
Start the expecco environment update service, which monitors the registered canoe variables for a value change.

VectorAHI - Stop environment autom. update service
Stop the expecco environment update service.

VectorAHI - Deregister environment or system variable from autom. update
Deregister a CANoe environment or system variable from the update service.

VectorAHI - Register environment variable for autom. update

VectorAHI - Register system variable for autom. update

---

Copyright © 2014-2024 eXept Software AG