Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Group

Model Preparation

Description

Set the XHP mode option for a list of subsystems of the current model. The new option becomes valid as soon as the next Load command is completed.

Required Control

System Control

Usage

SubsystemNames = (subsystemName1, subsystemName2, ...)

XHPOptions = (XHPOption1, XHPOption2, ...)

RtlabApi.SetNodeXHP (SubsystemNames, XHPOptions)

Input

  • SubsystemNames: Tuple of the subsystem names.

  • XHPOptions: Tuple of boolean values to set the XHP mode for the corresponding subsystem. FALSE (0) means subsystem will not run in XHP mode. TRUE (1) means the subsystem will run in XHP mode.

Output

None

Exception

  • EOK: Success.

  • EPERM: System control had not been granted to this client.

  • EBADF: Model not specified by previous Connect or

SetCurrentModel
  • OpenProject.

  • EIO: Error sending the request or receiving the reply.

  • ENOENT: Invalid subsystem name found in subsysName list parameter.

  • EINVAL: Unable to change the node mapping because of the model state.

Examples

None

Related Items

GetNodeXHP.

Modules

import RtlabApi