Macros

Table of Contents

• Macro resolving
• Table of predefined macros
• Where to go next ?

Macros are place holders for a value within a string. These macros are used within ADTF to

• Retrieve environment variables
• Set and retrieve session or system specific paths and values
• Set and retrieve user-specific macros

It is recommended to provide macros using ADTF Environment files.
Alternate it is also possible via ADTF System or within you code (search for adtf::services::ant::adtf_register_macro within the ADTF documentation).

Macro resolving

Macros should be used to create platform independent sessions, especially file paths and other values.

The CE provides a macro button to resolve abolsute path by using environment variables and macros whereever possible.

Table of predefined macros

Here is an overview of already set and used macros for resolving:

Macro	Description
ADTF_SESSION_DIR	Directory of the current session file
ADTF_SESSION_FILE_NAME	Name of the current session file without path
ADTF_SESSION_FILE_NAME_NOEXT	Name of the current session file without path and extension
ADTF_SYSTEM_DIR	Directory of the current system file
ADTF_SYSTEM_FILE_NAME	Name of the current system file without path
ADTF_SYSTEM_FILE_NAME_NOEXT	Name of the current system file without path extension
ADTF_GRAPH_DIR	Directory of the current graph file
ADTF_GRAPH_FILE_NAME	Name of the current graph file without path
ADTF_GRAPH_FILE_NAME_NOEXT	Name of the current graph file without path extension
ADTF_REMOTE_CONTROL_URL	RPC url to access the launched session (ADTF Launcher)

Note

The CE uses additional macros internally, which are not related to the runtime (ADTF Launcher), so they would neither be taken into account for macro resolving nor listed here.
An example is ADTF_CONFIGURATION_EDITOR_DIR.

Where to go next ?

After reading this page, you should have a good overview about available macros and where to find them.
Let's have a look at the Interfaces to extend the CE's functionality.