Override MHL Cases

Public API Builder tool

The Override MHL Cases tab of the Public API Builder tool allows you to add Public API MHL Cases of a Worker base class into a Worker that inherits from the Worker base class. This allows you to create a Public API in a Worker base class, and override the Public API's MHL cases into one or more Workers that inherit from the Worker base class.

Good to know

An example of overridden Public API MHL cases can be found in the Workers in the DMM HAL Demo example project. The screenshots below are taken from this example project.

Override MHL cases tab (Public API Builder tool)

Overriding Worker base class Public API MHL cases

To add the Public API MHL cases from a Worker base class into a Worker, perform the following steps.

Step 1. Select the Worker that you want to add Worker base class Public API MHL cases to.

Step 2. Select one or more Public API MHL cases that you want to add to the selected Worker.

Step 3. Press Add selected MHL Cases to Worker.

After the tool has completed adding the Worker base class MHL cases into the selected Worker, you can jump into the Worker's new MHL cases directly from the tool, through the 4. Right Click Menu. The image below is shows an override MHL case in a Worker, that was added by following the steps above.

Override MHL case

Override MHL case features

You can tell that a MHL case in a Worker overrides a MHL case of the same name in a Worker base class by the following features:

1. The message data types used by the MHL case are typedefs that are owned by the Worker base class, and not by the Worker that is using them.

2. The description text for the MHL case is written in blue text. This means that this description is owned by the Worker base class. If the Worker base class MHL case description is changed with the Public API Request Editor tool, then the MHL case description in the override case (image above) will also be updated.