You copied the Doc URL to your clipboard.

Adding bookmarks using Annotate

You can use annotate to add bookmarks to the Timeline automatically. The process is similar to adding standard annotate overlays, but requires the use of a different set of annotate functions. For general instructions on how to set up annotation, see Customize reports using Annotate.

Figure 49. Automatically adding bookmarks during capture

Automatically adding bookmarks during capture

The file streamline_annotate.h, located in .../gator/annotate/, contains all of the functions necessary to automatically add bookmarks. You must include this header file in your source code to use them.

Note

You can locate all of the files provided by DS-5 by selecting Help → ARM Extras... from the main menu.

Use the following functions to add bookmarks:

ANNOTATE_MARKER()

Use this function to add a a red bookmark to the Timeline view without a title. It has no parameters.

ANNOTATE_MARKER_STR(...)

This function adds a marker to the Timeline view with a title. Pass a string as a parameter to ANNOTATE_MARKER_STR(...) and the Timeline view displays it when you hover over the bookmark.

ANNOTATE_MARKER_COLOR(setColor)

This functions adds a bookmark and assigns it a color. Pass a color through as a parameter to automatically assign it to the bookmark.

ANNOTATE_MARKER_COLOR_STR(setColor, ...)

This function creates a bookmark with a title, and a color. Set the color and the title string using the function parameters and the created bookmark appears in the Timeline view with the defined properties.

Note

To annotate from within the kernel or a module, use the annotate_kernel.h file instead of streamline_annotate.h. The annotate statements in annotate_kernel.h duplicate the functionality of the standard annotate statements defined in streamline_annotate.h, but they are titled differently. Kernel annotate statements all have the KERNEL_ prefix. For example, to add a titled bookmark using Annotate, include annotate_kernel.h and add the KERNEL_ANNOTATE_MARKER_STR(string) statement to your kernel or module code.

Was this page helpful? Yes No