Macros

Table of Contents

• Description
• Retreiving and setting macros
• Table of predefined macros
• Table of scoped macros

Description

Macros are place holders for a value within a string or a filename/filepath.
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

Retreiving and setting macros

A global interface adtf::services::IMacroResolver is provided.
If no Macro Resolver is used within the system, environment variables are used

We recommend to use always:

• adtf::services::adtf_resolve_macros to retrieve a macro value
• adtf::services::adtf_register_macro to set a macro value

Note

The Session Manager will automatically resolve macros on properties.

Table of predefined macros

Here is an overview of the predefined macros available while ADTF is running (additional to those introduced via the loaded .adtfenvironment files):

Macro	Remark
ADTF_ACTIVE_FILTERGRAPH_NAME	Resolves to the name of the currently active filter graph.
ADTF_DIR	Resolves to your ADTF installation directory.
ADTF_GRAPH_DIR	Resolves to the directory of the current .adtfgraph file loaded (if loaded via adtfgraph).
ADTF_GRAPH_FILE_NAME	Resolves to the current .adtfgraph file loaded without path (if loaded via adtfgraph).
ADTF_GRAPH_FILE_NAME_NOEXT	Resolves to the current .adtfgraph file loaded without path and without extension(if loaded via adtfgraph).
ADTF_PLAYBACK_DIRS	Resolves to the directories that the currently opened playback files reside in, separated by ';'.
ADTF_PLAYBACK_FILE_BASENAMES	Resolves to the basenames (filenames without directory components) of the currently opened playback files, separated by ';'.
ADTF_PLAYBACK_FILE_BASENAMES_NOEXT	Resolves to the basenames (filenames without directory components) without the extension of the currently opened playback files, separated by ';'.
ADTF_PLAYBACK_FILE_NAMES	Resolves to the filenames of the currently opened playback files, separated by ';'.
ADTF_PLAYBACK_FILE_NAMES_NOEXT	Resolves to the filenames without the extension of the currently opened playback files, separated by ';'.
ADTF_RECORDER_DEFAULT_FILENAME_EXTENSION	Resolves to the default filename extension provided by the used recorder processor, including the leading dot (e.g. '.csv'). Resolves to an empty string if unavailable. Only available in the filename property of the recorder or via calls to IRecorder.
ADTF_REMOTE_CONTROL_URL	Resolves to the given RPC endpoint of the current ADTF System.
ADTF_SESSION_DATA_DIR	Resolves to the directory of the current session data (if loaded via adtfsession). By default this directory points to the '/'.
ADTF_SESSION_DIR	Resolves to the directory of the current .adtfsession file loaded (if loaded via adtfsession).
ADTF_SESSION_FILE_NAME	Resolves to the current .adtfsession file loaded without path (if loaded via adtfsession).
ADTF_SESSION_FILE_NAME_NOEXT	Resolves to the current .adtfsession file loaded without path and without extension (if loaded via adtfsession).
ADTF_SYSTEM_DIR	Resolves to the directory of the current .adtfsystem file loaded (if loaded via adtfsystem).
ADTF_SYSTEM_FILE_NAME	Resolves to the current .adtfsystem file loaded without path (if loaded via adtfsystem).
ADTF_SYSTEM_FILE_NAME_NOEXT	Resolves to the current .adtfsystem file loaded without path and without extension (if loaded via adtfsystem).

Table of scoped macros

Scoped Macros are resolved only while initializing and setting properties.
They can only be used within properties while the Session Manager creates the filter graph.

Macro	Remark
THIS_OBJECT_FULL_NAME	Resolves to the current full path name of an object (. separated). Only availiable in properties during filter graph creation.
THIS_OBJECT_NAME	Resolves to the current current name of an object. Only availiable in properties during filter graph creation.
THIS_OBJECT_PARENT	Resolves to the current full path name of an objects parent (. separated). Only availiable in properties during filter graph creation.