ADTF  v2.14.3
adtf_constants.h File Reference

These definitions are constants used within adtf namespace. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

 adtf
 The adtf defines the namespace for all functionality that is provided by the definitions of the ADTF basic interfaces and their default implementations within the library adtf_sdkXXX.a/ adtf_sdkXXX.lib.
 

Macros

#define NS_SESSION   "/session"
 standard namespace paths More...
 
#define NS_SESSION_CMDLINE   "/session/commandline"
 namespace path for parameters of the command line
 
#define NS_SESSION_DIR   "/session/directory"
 namespace path for the start directory in qfiledialog
 
#define NS_SESSION_MANIFEST   "/session/manifest"
 namespace path for the manifest file
 
#define NS_SESSION_GLOBALS   "/session/globals"
 namespace path of the settings of the current configuration
 
#define NS_SESSION_FILE   "/session/file"
 namespace path of the settings of the loaded file
 
#define NS_SESSION_CURRENT   "/session/current"
 namespace path of the current configuration
 
#define NS_SETTINGS   "/settings"
 namespace path for global settings, have a look at global settings editor
 
#define NS_LAYOUTS   "/layouts"
 namespace path for layouts
 
#define NS_LAYOUTS_SYSTEM   "/layouts/system"
 namespace path for system layouts
 
#define NS_LAYOUTS_RUNNING   "/layouts/running"
 namespace path for running layouts
 
#define NS_LAYOUTS_RUNNING_SETTINGS   "/layouts/running_settings"
 namespace path for running layouts
 
#define NS_CONFIGURATION_EDITOR   "/configuration_editor"
 namespace path for configuration_editor settings
 
#define NS_GLOBALS_EDITOR   "/globals_editor"
 namespace path for global_settings_editor settings
 
#define NS_SUB_PLUGINS   "/plugins"
 plugins subpath
 
#define NS_SUB_ENVIRONMENT   "/environment"
 environment subpath
 
#define NS_SUB_TEMPLATES   "/templates"
 templates subpath
 
#define NS_SUB_FILTERS   "/filters"
 filters subpath
 
#define NS_SUB_VERSIONS   "/versions"
 versions subpath
 
#define NS_SUB_INFO   "/info"
 info subpath
 
#define NS_SUB_PINS   "/pins"
 pins subpath
 
#define NS_SUB_DYNAMICPINTEMPLATES   "/dynamicpintemplates"
 dynamicpintemplates subpath
 
#define NS_SUB_BINDING_OBJECTS   "/binding_objects"
 pins subpath
 
#define NS_SUB_SERVICES   "/services"
 services subpath
 
#define NS_SUB_GENERAL   "/general"
 general subpath
 
#define NS_SUB_FILEINFO   "/fileinfo"
 general subpath
 
#define NS_SUB_CFG   "/config"
 configuration subpath
 
#define NS_SUB_CFGS   "/configurations"
 configurations subpath
 
#define NS_SUB_INCLUDE   "/include"
 includes subpath
 
#define NS_SUB_GUI   "/gui"
 graphical user interface subpath
 
#define NS_SUB_CONFIGSETTINGS   "/configsettings"
 info in
 
#define NS_SUB_REFPROPERTIES   "/RefProperties"
 info in
 
#define NS_SUB_GLOBAL_LAYOUTS   "/global_layouts"
 global layout configurations
 
#define NS_SUB_LAYOUTS_WINDOWS   "/windows"
 windows layouts
 
#define NS_SUB_LAYOUTS_COMPONENTS   "/components"
 components layouts
 
#define NS_SUB_LAYOUTS_APPLICATION   "/application"
 application layouts
 
#define NS_SESSION_MANIFEST_GENERAL   NS_SESSION_MANIFEST NS_SUB_GENERAL
 namespace path to the general section of the session manifest
 
#define NS_SESSION_GLOBALS_PLUGINS   NS_SESSION_GLOBALS NS_SUB_PLUGINS
 namespace path to the global plugins
 
#define NS_SESSION_GLOBALS_TEMPLATES   NS_SESSION_GLOBALS NS_SUB_TEMPLATES
 namespace path to the global templates
 
#define NS_SESSION_GLOBALS_GENERAL   NS_SESSION_GLOBALS NS_SUB_GENERAL
 namespace path to the global generals
 
#define NS_SESSION_GLOBALS_ENVIRONMENT   NS_SESSION_GLOBALS NS_SUB_ENVIRONMENT
 namespace path to the global environment settings
 
#define NS_SESSION_FILE_PLUGINS   NS_SESSION_FILE NS_SUB_PLUGINS
 namespace path to the session plugins
 
#define NS_SESSION_FILE_GENERAL   NS_SESSION_FILE NS_SUB_GENERAL
 namespace path to the session specific generals
 
#define NS_SESSION_FILE_CFGS   NS_SESSION_FILE NS_SUB_CFGS
 namespace path to the session configurations
 
#define NS_SESSION_FILE_ENVIRONMENT   NS_SESSION_FILE NS_SUB_ENVIRONMENT
 namespace path to the session environment settings
 
#define NS_SESSION_FILE_CONFIGSETTINGS   NS_SESSION_FILE NS_SUB_CONFIGSETTINGS
 namespace path to the session file config property settings
 
#define NS_SESSION_FILE_FILEINFO   NS_SESSION_FILE NS_SUB_FILEINFO
 namespace path of the settings of the loaded file
 
#define NS_SESSION_CURRENT_PLUGINS   NS_SESSION_CURRENT NS_SUB_PLUGINS
 namespace path to the plugins of the current session
 
#define NS_SESSION_CURRENT_FILTERS   NS_SESSION_CURRENT NS_SUB_FILTERS
 namespace path to the filters of the current session
 
#define NS_SESSION_CURRENT_SERVICE   NS_SESSION_CURRENT NS_SUB_SERVICES
 namespace path to the services of the current session
 
#define NS_SESSION_CURRENT_GENERAL   NS_SESSION_CURRENT NS_SUB_GENERAL
 namespace path to the general properties of the current session
 
#define NS_SESSION_CURRENT_CFG   NS_SESSION_CURRENT NS_SUB_CFG
 namespace path to the current configuration
 
#define NS_SESSION_CURRENT_ENVIRONMENT   NS_SESSION_CURRENT NS_SUB_ENVIRONMENT
 namespace path to the current environment settings
 
#define NS_SESSION_CURRENT_CONFIGSETTINGS   NS_SESSION_CURRENT NS_SUB_CONFIGSETTINGS
 namespace path to the current session config settings
 
#define NS_SESSION_CURRENT_FILEINFO   NS_SESSION_CURRENT NS_SUB_FILEINFO
 namespace path of the settings of the loaded file
 
#define NS_RUNTIME   "/runtime"
 namespace path for the runtime entries
 
#define NS_RUNTIME_PLUGINS   "/runtime/plugins"
 namespace path for the plugins
 
#define NS_RUNTIME_CLASSES   "/runtime/classes"
 namespace path for the classes
 
#define NS_RUNTIME_OBJECTS   "/runtime/objects"
 namespace path for the objects
 
#define NS_PROJECT   "/project"
 namespace path for loaded projects
 
#define NS_FILTER_EDITOR   "/filter_editor"
 namespace subpath to the filter editor
 
#define NS_FILTER_EDITOR_MAP   NS_FILTER_EDITOR "/filter_map"
 namespace subpath to the filter editor map
 
#define NS_PROJECT_REL_CONFIGURATIONS   "/configurations"
 namespace path to project related configurations
 
#define NS_PROJECT_REL_FILES   "/files"
 namespace path to project related files
 
#define NS_SETTINGS_GUI   NS_SETTINGS NS_SUB_GUI
 namespace path for the gui settings this path is managed via XSystem Service. More information can be found on GUI Namespace Settings.
 
#define NS_SETTINGS_RECORDERDLG   NS_SETTINGS_GUI "/recorder_dlg"
 namespace path for the recorder dialog settings
 
#define NS_SETTINGS_CUSTOMKEYS   NS_SETTINGS_RECORDERDLG "/custom_keys"
 namespace path for the keys for the different recorders
 
#define NS_SETTINGS_GLOBAL_LAYOUTS   NS_SETTINGS NS_SUB_GLOBAL_LAYOUTS
 namespace path for the layout configurations
 
#define NS_DISPLAY   "/display"
 display subpath
 
#define NS_DISPLAY_MENU   NS_DISPLAY "/menu"
 menu subpath for the display
 
#define NS_DISPLAY_LAYOUT   NS_DISPLAY "/layout"
 layout subpath for the display
 
#define NS_DISPLAY_LAYOUT_WINDOWS   NS_DISPLAY_LAYOUT "/windows"
 windows subpath for the display layout
 
#define NSPROP_ACTIVEFOLDER   "ActiveFolder"
 namespace path to the active folder property
 
#define NSPROP_NAMESPACE_TYPE   "NamespaceType"
 namespace type property
 
#define NSPROP_NAMESPACE_PATH   "NamespacePath"
 namespace path property
 
#define NSPROP_LOCAL_PATH   "LocalPath"
 local path property
 
#define NSPROP_DISPLAY_NAME   "DisplayName"
 display name property
 
#define NSPROP_FILEINFO   "file_info"
 file information name property
 
#define NSPROP_IDENTIFIER   "Identifier"
 general properties of filter identifier property of filter
 
#define NSPROP_CATEGORY   "Category"
 category property of filter
 
#define NSPROP_CLASSLABEL   "ClassLabel"
 class label property of filter
 
#define NSPROP_CLASSID   "ClassId"
 class label property of filter
 
#define NSPROP_CLASS   "idref"
 class property of filter
 
#define NSPROP_VERSION_LABEL   "Version Label"
 version label property
 
#define NSPROP_VERSION   "Version"
 version property
 
#define NSPROP_PINDIRECTION   "Direction"
 pin direction property
 
#define NSPROP_MAJORMEDIATYPE   "MajorType"
 major type property
 
#define NSPROP_SUBMEDIATYPE   "SubType"
 sub type property
 
#define NSPROP_DYNAMICPIN   "DynamicPin"
 declares a dynamic pin
 
#define NSPROP_DYNAMICBINDINGOBJECT   "DynamicPin"
 we use the same as NSPROP_DYNAMICPIN, but it is not a pin (this property has the same meaning)
 
#define NSPROP_PIN_THREADING   "Threading"
 threading model for output pin
 
#define NSPROP_PIN_DESCRIPTION   "Description"
 text description of pin
 
#define NSPROP_CLASS_DESCRIPTION   "Description"
 text description of class
 
#define NSPROP_BINDING_DIRECTION   "Direction"
 binding direction property
 
#define NSPROP_BINDING_DESCRIPTION   "ShortDescription"
 binding direction property
 
#define NSPROP_BINDING_INTERFACE_ID   "Iid"
 binding interface id
 
#define NSPROP_BINDING_PROXY_OID   "ProxyOid"
 Binding proxy OID.
 
#define NSPROP_LICENSED   "licensed"
 License flag.
 
#define NSITEM_NEWITEM   "NewItem"
 general namespace item properties new item property
 
#define NSITEM_DELETED   "Deleted"
 deleted item property
 
#define NSITEM_NAME   "Name"
 item name property
 
#define NSITEM_CREATED   "Created"
 item created property
 
#define NSTYPE_ITEM   "/item/"
 default items
 
#define NSTYPE_FILE   NSTYPE_ITEM "file/"
 file item
 
#define NSTYPE_FOLDER   NSTYPE_ITEM "folder/"
 folder item
 
#define NSTYPE_ROOT   NSTYPE_FOLDER "root"
 special items // the hierarchy can not be deeper then i.e. /item/file/filter or /item/folder/config
 
#define NSTYPE_CONFIG   NSTYPE_FOLDER "configuration"
 configuration item
 
#define NSTYPE_GENERAL   NSTYPE_FOLDER "general"
 general item
 
#define NSTYPE_ENVIRONMENT   NSTYPE_FOLDER "environment"
 general item
 
#define NSTYPE_CONFIGSETTINGS   NSTYPE_FOLDER "configsettings"
 general item
 
#define NSTYPE_FILEINFO   NSTYPE_FILE "fileinfo"
 file info item
 
#define NSTYPE_SERVICE   NSTYPE_FILE "service"
 service item
 
#define NSTYPE_FILTER   NSTYPE_FILE "filter"
 filter item
 
#define NSTYPE_PIN   NSTYPE_FILE "pin"
 pin item
 
#define NSTYPE_BINDING_OBJECT   NSTYPE_FILE "binding_object"
 pin item
 
#define NSTYPE_PLUGIN   NSTYPE_FILE "plugin"
 plugin item
 
#define NSTYPE_PLUGINS   NSTYPE_FOLDER "plugins"
 plugins item
 
#define NSTYPE_TEMPLATES   NSTYPE_FILE "templates"
 templates item
 
#define NSTYPE_CONNECTION   NSTYPE_FILE "connection"
 connection item
 
#define NSTYPE_OUTPORT   NSTYPE_FILE "outport"
 outport item
 
#define NSTYPE_INPORT   NSTYPE_FILE "inport"
 inport item
 
#define NSTYPE_SUBGRAPH   NSTYPE_FILE "subgraph"
 subgraph item
 
#define NSTYPE_BREAKPOINT   NSTYPE_FILE "breakpoint"
 breakpoint item
 
#define NSTYPE_ENVVAR   NSTYPE_FILE "variable"
 environment variable item
 
#define NSTYPE_INCLUDE   NSTYPE_FILE "include"
 include item
 
#define NSTYPE_CONFIG_SYS   NSTYPE_FILE "config/sys"
 System configuration item in project tree.
 
#define NSTYPE_CONFIG_INCLUDE   NSTYPE_FILE "config/include"
 Configuration include item in project tree.
 
#define NSSUBPROP_HIDDEN   ".IsHidden"
 Set this Sub Property to True to hide the property in the property view. More...
 
#define NSSUBPROP_REQUIRED   ".IsRequired"
 If this Sub Property is set to True the property is marked as mandatory. More...
 
#define NSSUBPROP_COLOR   ".IsColor"
 With this Sub Property, a property can be declared as a color, if it is set to True. More...
 
#define NSSUBPROP_FILENAME   ".IsFilename"
 Set this Sub Property to True to mark the property as a filename property. More...
 
#define NSSUBPROP_FILENAME_LIST   ".IsFilenameList"
 Set this Sub Property to True to mark the property as a filename list property. More...
 
#define NSSUBPROP_FILE_SOURCE_PATH   ".FileSourcePath"
 This is for internal use!
 
#define NSSUBSUBPROP_FILENAME_LIST_SEPARATOR   ".FilenameListSeparator"
 This Sub-Sub Property is used to separate the selected filenames. More...
 
#define NSSUBPROP_DIRECTORY   ".IsDirectory"
 Set this Sub Property to True to mark the property as a directory property. More...
 
#define NSSUBSUBPROP_EXTENSIONFILTER   ".ExtensionFilter"
 This sub-Sub Property can be used to set the extension filter for the file-selection-dialog of the associated filename property. More...
 
#define NSSUBPROP_READONLY   ".IsReadOnly"
 If this Sub Property is set to True, the property value cannot be changed within the property view. More...
 
#define NSSUBPROP_DESCRIPTION   ".Description"
 Set this Sub Property to define a description text for the property. More...
 
#define NSSUBPROP_VALUELIST   ".ValueList"
 With this Sub Property a value list can be defined for the property. More...
 
#define NSSUBPROP_VALUELISTNOEDIT   ".ValueListNoEdit"
 This Sub Property is the same as the Sub Property NSSUBPROP_VALUELIST. More...
 
#define NSSUBPROP_MIN   ".min"
 Set this Sub Property to define the minimum value for the property. More...
 
#define NSSUBPROP_MINIMUM   NSSUBPROP_MIN
 see NSSUBPROP_MIN.
 
#define NSSUBPROP_MAX   ".max"
 Set this Sub Property to define the maximum value for the property. More...
 
#define NSSUBPROP_MAXIMUM   NSSUBPROP_MAX
 see NSSUBPROP_MAX.
 
#define NSSUBPROP_ISCHANGEABLE   ".IsChangeable"
 Set this Sub Property to define if this property can be changed at runtime. More...
 
#define NSSUBPROP_ISINACTIVE   ".IsInactive"
 If true , the property is shown with a gray background in the Property Browser, indicating that the user cannot change the property. More...
 
#define NSSUBPROP_DISPLAYNAME   ".DisplayName"
 This Sub Property can be set to define which name is displayed for a property. More...
 
#define NSSUBPROP_MULTI_LINE_TEXT_EDIT   ".IsMultiTextEdit"
 Set this Sub Property to True to mark the property as a multi line text edit property. More...
 
#define NSPROP_REFPROPERTY   "RefProperty"
 helper definition for NSSUBPROP_GLOBALCONFIGPROPERTYNAME
 
#define NSSUBPROP_REFPROPERTY   "." NSPROP_REFPROPERTY
 helper definition for NSSUBPROP_GLOBALCONFIGPROPERTYNAME
 
#define NSSUBPROP_GLOBALCONFIGPROPERTYNAME   NSSUBPROP_REFPROPERTY
 Set this Sub Property to mark the parent property as a Property that references a Referenced Configuration Property. More...
 
#define NSSUBPROP_CHANGED   ".IsChanged"
 Internal use only. More...
 
#define NSSUBPROP_ORGINALVALUE   ".OriginalValue"
 Internal use only. More...
 
#define NSSUBPROP_DONTEXPORT   ".DontExport"
 Set this Sub Property to True to prevent this property to be stored in the configuration file. More...
 
#define NSSUBPROP_FROMCONFIGFILE   ".FromConfigFile"
 internal use
 
#define NSSUBPROP_ENABLED   ".Enabled"
 internal use
 
#define NSSUBPROP_PLUGIN_FILE   ".IsPluginFile"
 internal use
 
#define NSFILTERGLOBALCONFIGPROPERTY_PREFIX   "FilterGlobalConfig::"
 propertyPrefixes / internal use
 
#define NSGLOBALCONFIGPROPERTY_PREFIX   "GlobalConfig::"
 propertyPrefixes / internal use
 
#define NSPROP_PLUGINDESCRIPTIONAVAILABLE   "PluginDescriptionAvailable"
 Internal use only.
 
#define NSPROP_MSGBUS_SYNCHRONIZING_TYPE   "synchronizing_type"
 public message bus property identifiers, which are not namespace specific Synchronizing type property
 
#define NSPROP_MSGBUS_UPDATE_RECEIVE_SAMPLE_TIME   "update_receive_sample_time"
 Update sample time on pin adapter property.
 
#define NSPROP_MSGBUS_ENABLE_MESSAGEBUS   "enable_messagebus"
 Enable message bus property.
 
#define PROP_PROFILING_WARN_MISSING_TIMING_SPOTS   "only_warn_missing_timing_spots"
 public profiling property to enable/disable error handling for missing timing spots Synchronizing type property
 
#define NSPROP_ADTF_CONFIG_FILE   "config_file"
 public property identifiers, which are not namespace specific config file property
 
#define NSPROP_ADTF_PROJECT_FILE   "project_file"
 project file property
 
#define NSPROP_ADTF_MANIFEST_FILE   "manifest_file"
 manifest file property
 
#define NSPROP_ADTF_GLOBALS_FILE   "globals_file"
 globals file property
 
#define NSPROP_ADTF_ACTIVE_CONFIG   "active_configuration"
 active configuration property
 
#define NSPROP_ADTF_ACTIVE_PROJECT   "active_project"
 active project property
 
#define NSPROP_ADTF_PLAYBACK_SPEED   "playback_speed"
 playback speed property
 
#define NSPROP_ADTF_PLAYLIST_FILE   "playlist_file"
 playlist file property
 
#define NSPROP_ADTF_SCRIPT_FILE   "script_file"
 script file property
 
#define NSPROP_IDREF   "idref"
 defines idref property
 
#define NSPROP_ALIAS   "alias"
 defines a alias property
 
#define NSPROP_NAME   "name"
 defines a name property
 
#define NSPROP_VALUE   "value"
 defines a value property
 
#define NSPROP_TYPE   "type"
 defines a type property
 
#define NSPROP_OBJECTID   "objectid"
 defines a objectid property
 
#define NSPROP_OPTIONAL   "optional"
 defines a optional property
 
#define NSPROP_BUILD_TYPE   "build_type"
 defines a build_type property
 
#define NSPROP_FILENAME   "filename"
 defines a property filename
 
#define NSPROP_PLUGIN   "plugin"
 defines a plugin property
 
#define NSPROP_URL   "url"
 defines a url property
 
#define NSPROP_STREAM   "stream"
 defines a property steam
 
#define NSPROP_PRIORITY   "priority"
 defines a property priority
 
#define NSPROP_SOURCE   "source"
 defines a property source
 
#define NSPROP_DEST   "dest"
 defines a property dest
 
#define NSPROP_CONNECTION_INTF   "interface"
 defines a property interface for connection
 
#define NSPROP_CONNECTION_PRIO   "connection_priority"
 defines a property interface for connection
 
#define NSPROP_ACTIVE   "active"
 defines a property active
 
#define NSPROP_VALID   "valid"
 defines a property active
 
#define NSPROP_ISBINDING   "isBinding"
 defines a property is binding object
 
#define NSPROP_DESCRIPTION   "description"
 defines a property description
 
#define NSPROP_EXECUTING_HOST   "executing_host"
 defines a property executing_host
 
#define NSPROP_CONNECTION_PRIORITY   "connection_priority"
 defines a property executing_host
 
#define NSPROP_WD_REPORT_DIR   "watchdog_report_dir"
 defines a property watchdog_report_dir
 
#define NSPROP_WD_ALIVE_ENABLED   "watchdog_alive_enabled"
 defines a property watchdog_alive_enabled
 
#define NSPROP_WD_ALIVE_INTERVAL   "watchdog_alive_interval"
 defines a property watchdog_alive_interval
 
#define NSPROP_WD_ALIVE_URL   "watchdog_alive_url"
 defines a property watchdog_alive_url
 
#define NSPROP_WD_ALIVE_SEND_ONLY_POSITIVE_STATUS   "watchdog_alive_send_only_positive_status"
 defines a property watchdog_alive_send_only_positive_status
 
#define NSPROP_LAYOUT_FILE   "layout_file"
 defines a property layout file
 
#define NSPROP_LAYOUT   "layout"
 defines a property layout
 
#define NSEXPORT_FILEINFOTAG   "fileinfo"
 xml tag for fileinfo
 
#define NSEXPORT_GENERALTAG   "general_settings"
 xml tag for general settings
 
#define NSEXPORT_CONFIGSETTINGSTAG   "configuration_settings"
 xml tag for configuration settings
 
#define NSEXPORT_SETTINGSTAG   "settings"
 xml tag for settings
 
#define NSEXPORT_PROPERTYTAG   "property"
 xml tag for property
 
#define NSEXPORT_SERVICETAG   "service"
 xml tag for service
 
#define NSEXPORT_FILTERTAG   "filter"
 xml tag for filter
 
#define NSEXPORT_INPORTTAG   "inport"
 xml tag for inport
 
#define NSEXPORT_OUTPORTTAG   "outport"
 xml tag for outport
 
#define NSEXPORT_SUBGRAPHTAG   "subgraph"
 xml tag for subgraph
 
#define NSEXPORT_GRAPHTAG   "graph"
 xml tag for graph
 
#define NSEXPORT_DEBUGGER   "debugger"
 xml tag for debugger
 
#define NSEXPORT_BREAKPOINTTAG   "breakpoint"
 xml tag for breakpoint
 
#define NSEXPORT_CONNECTIONTAG   "connection"
 xml tag for connection
 
#define NSEXPORT_ENVIRONMENTTAG   "environment"
 xml tag for environment
 
#define NSEXPORT_VARIABLETAG   "variable"
 xml tag for a variable
 
#define NSEXPORT_TEMPLATESTAG   "templates"
 xml tag for templates
 
#define NSEXPORT_PLUGINTAG   "plugin"
 xml tag for plugin
 
#define NSEXPORT_PLUGINSTAG   "plugins"
 xml tag for plugins
 
#define NSEXPORT_CONFIGURATIONSTAG   "configurations"
 xml tag for configurations
 
#define NSEXPORT_CONFIGURATIONTAG   "configuration"
 xml tag for configuration
 
#define NSEXPORT_ADTFINCLUDETAG   "adtf_include"
 xml tag for adtf includes
 
#define NSPROP_ADTFFILEVERSION   "adtfversion"
 xml attribute for adtf version
 
#define NSEXPORT_ADTFFILEVERSION_CURRENT   ADTF_VERSION_STR
 xml attribute default value for NSPROP_ADTFFILEVERSION
 
#define NSPROP_CONFIGFILEVERSION   "configversion"
 xml attribute for configuration file version
 
#define NSEXPORT_CONFIGFILEVERSION_CURRENT   "1.3"
 xml attribute default value for NSPROP_CONFIGFILEVERSION
 
#define NSPROP_PROJECTFILEVERSION   "projectversion"
 xml attribute for project file version
 
#define NSEXPORT_PROJECTFILEVERSION_CURRENT   "1.2"
 xml attribute default value for NSPROP_PROJECTFILEVERSION
 
#define NSPROP_EXPORTFILEVERSION   "exportversion"
 xml attribute for export file version
 
#define NSEXPORT_EXPORTFILEVERSION_CURRENT   "1.1"
 xml attribute default value for NSEXPORT_EXPORTFILEVERSION_CURRENT
 
#define NSNAME_OPTIONAL   "Optional"
 defines namespace entry name Optional
 
#define NSNAME_REQUIRED   "Required"
 defines namespace entry name Required
 
#define NSVALUE_DEBUG   "debug"
 defines namespace value debug
 
#define NSVALUE_RELEASE   "release"
 defines namespace value release
 
#define NSVALUE_TRUE   "true"
 defines namespace value true
 
#define NSVALUE_FALSE   "false"
 defines namespace value false
 
#define NSVALUE_TRIGGERS   "triggers"
 namespace value triggers
 
#define NSVALUE_TRIGGERED_BY   "triggered_by"
 namespace value triggered_by
 
#define NSPROP_CONFIGINFO   "config_information"
 Prefix of property names.
 
#define NSPROP_CONFIGINFO_ENABLECONNPINS   NSPROP_CONFIGINFO ".enable_connection_pins"
 Enable or disable the creation of connection pins. More...
 
#define NSPROP_CONFIGINFO_MAXCONNPINS   NSPROP_CONFIGINFO ".max_connection_pins"
 Defines the maximum of connection pins that will be created. More...
 
#define NSPROP_CONFIGINFO_ENABLECONFIGINPINS   NSPROP_CONFIGINFO ".enable_config_inputpins"
 Enable or disable the creation of connection input pins. More...
 
#define NSPROP_CONFIGINFO_ENABLECONFIGOUTPINS   NSPROP_CONFIGINFO ".enable_config_outputpins"
 Enable or disable the creation of connection output pins. More...
 
#define NSPROP_CONFIGINFO_ENABLEDYNAMICPROPS   NSPROP_CONFIGINFO ".enable_dynamic_properties"
 Enable or disable the creation of dynamic properties. More...
 
#define NSPROP_CONFIGINFO_ENABLECONFIGCLIENTBINDINGOBJECTS   NSPROP_CONFIGINFO ".enable_config_clientobjects"
 Enable or disable the config client binding objects. More...
 
#define NSPROP_CONFIGINFO_ENABLECONFIGSERVERBINDINGOBJECTS   NSPROP_CONFIGINFO ".enable_config_serverobjects"
 Enable or disable the server client binding objects. More...
 
#define NSPROP_CONFIGINFO_DISABLE_CONNECTION_VALIDITY_CHECK   NSPROP_CONFIGINFO ".disable_connection_validity_check"
 Disable Connection Check. More...
 
#define CMDLINE_ID_ADTF_CONFIG_FILE   "config"
 Load a different config at startup.
 
#define CMDLINE_ID_ADTF_ACTIVE_CONFIG   "active"
 Set the active config.
 
#define CMDLINE_ID_ADTF_PLAYLIST_FILE   "playlist"
 Load a playlist file and implicit set CMDLINE_ID_ADTF_RUN.
 
#define CMDLINE_ID_ADTF_PROJECT_FILE   "project"
 Load a different project at startup. More...
 
#define CMDLINE_ID_ADTF_GLOBALS_FILE   "globals"
 Specify the globals file which should be used.
 
#define CMDLINE_ID_ADTF_SCRIPT_FILE   "script"
 Load a script file.
 
#define CMDLINE_ID_ADTF_PLAYBACK_SPEED   "speed"
 Specify the playback speed.
 
#define CMDLINE_ID_ADTF_NO_SPLASH   "nosplash"
 Suppress the ADTF splash screen at startup.
 
#define CMDLINE_ID_ADTF_MINIMIZED   "minimized"
 Starts ADTF minimized.
 
#define CMDLINE_ID_ADTF_TRAY   "tray"
 Starts ADTF minimized and creates traybar icon.
 
#define CMDLINE_ID_ADTF_QUIT   "quit"
 Quits ADTF after playback (-quit) or n seconds after start (-quit=n) This implies CMDLINE_ID_ADTF_RUN.
 
#define CMDLINE_ID_ADTF_RUN   "run"
 Starts the playback after loading the configuration.
 
#define CMDLINE_ID_ADTF_INIT   "init"
 Initialize the configuration.
 
#define CMDLINE_ID_ADTF_STDOUT   "stdout"
 Log output is also made to the console window.
 
#define CMDLINE_ID_ADTF_UNDER_TEST   "undertest"
 For internal use only. More...
 
#define CMDLINE_ID_ADTF_LOGFILE   "logfile"
 Writes all stdout output to the given logfile. More...
 
#define CMDLINE_ID_ADTF_SKIP_BROKEN_DAT_FILE   "skip_broken_dat_files"
 Broken DAT Files within a DAT Playlist will be skipped and the error will be logged to the console. More...
 
#define CMDLINE_ID_ADTF_ENABLE_LICENSE_LOGGING   "enable-license-logging"
 Specifies if log file with license check info will be created. More...
 
#define CMDLINE_ID_ADTF_QUIT_TIME   "quit_time"
 Not a command line option but used, if a time is provided with quit.
 
#define CMDLINE_ID_ADTF_ARGV   "argv"
 Specifies a list of arguments that will be passed to called pythonscript.
 
#define CMDLINE_ID_ADTF_RUNNING_LAYOUT   "runninglayout"
 Specifies a runtime layout name or a runtime layout file which will be loaded as default.
 
#define CMDLINE_ID_ADTF_SYSTEM_LAYOUT   "systemlayout"
 Specifies a system layout name or a system layout file which will be loaded as default.
 
#define CONFIGFILE_HEADER   "<?xml version=\"1.0\" encoding=\"iso-8859-1\" standalone=\"no\"?>\n \ <adtf:configuration xmlns:adtf=\"adtf\">\n \ </adtf:configuration>"
 XML header for config files.
 
#define INCLUDEFILE_HEADER   "<?xml version=\"1.0\" encoding=\"iso-8859-1\" standalone=\"no\"?>\n \ <adtf:include xmlns:adtf=\"adtf\">\n \ </adtf:include>"
 XML header for adtf include files.
 
#define DESCRPTIONFILE_HEADER_DDL1   "<?xml version=\"1.0\" encoding=\"iso-8859-1\" standalone=\"no\"?>\n \ <adtf:ddl xmlns:adtf=\"adtf\"> \n \ <header> \ <language_version>1.02</language_version>\n \ <author></author>\n \ <date_creation></date_creation>\n \ <date_change></date_change>\n \ <description>ADTF generated</description>\n \ </header> \n \ <units> \n\ <baseunit name=\"nou\" symbol=\"\" description=\"this is the no unit class\"/> \ </units> \n\ <datatypes> \n\ <datatype name=\"tBool\" size=\"8\" description=\"predefined ADTF tBool datatype\"/> \n\ <datatype name=\"tChar\" size=\"8\" description=\"predefined ADTF tChar datatype\"/> \n\ <datatype name=\"tUInt8\" size=\"8\" description=\"predefined ADTF tUInt8 datatype\"/> \n\ <datatype name=\"tInt8\" size=\"8\" description=\"predefined ADTF tInt8 datatype\"/> \n\ <datatype name=\"tUInt16\" size=\"16\" description=\"predefined ADTF tUInt16 datatype\"/> \n\ <datatype name=\"tInt16\" size=\"16\" description=\"predefined ADTF tInt16 datatype\"/> \n\ <datatype name=\"tUInt32\" size=\"32\" description=\"predefined ADTF tUInt32 datatype\"/> \n\ <datatype name=\"tInt32\" size=\"32\" description=\"predefined ADTF tInt32 datatype\"/> \n\ <datatype name=\"tUInt64\" size=\"64\" description=\"predefined ADTF tUInt64 datatype\"/> \n\ <datatype name=\"tInt64\" size=\"64\" description=\"predefined ADTF tInt64 datatype\"/> \n\ <datatype name=\"tFloat32\" size=\"32\" description=\"predefined ADTF tFloat32 datatype\"/> \n\ <datatype name=\"tFloat64\" size=\"64\" description=\"predefined ADTF tFloat64 datatype\"/> \n\ </datatypes> \n\ <structs/> \n\ <streams/> \n\ </adtf:ddl>"
 XML header for the data definition language description (version 1) file.
 
#define DESCRPTIONFILE_HEADER_DDL2   "<?xml version=\"1.0\" encoding=\"iso-8859-1\" standalone=\"no\"?>\n \ <adtf:ddl xmlns:adtf=\"adtf\"> \n \ <header> \ <language_version>2.00</language_version>\n \ <author></author>\n \ <date_creation></date_creation>\n \ <date_change></date_change>\n \ <description>ADTF generated</description>\n \ </header> \n \ <units> \n\ <baseunit name=\"nou\" symbol=\"\" description=\"this is the no unit class\"/> \ </units> \n\ <datatypes> \n\ <datatype name=\"tBool\" size=\"8\" description=\"predefined ADTF tBool datatype\"/> \n\ <datatype name=\"tChar\" size=\"8\" description=\"predefined ADTF tChar datatype\"/> \n\ <datatype name=\"tUInt8\" size=\"8\" description=\"predefined ADTF tUInt8 datatype\"/> \n\ <datatype name=\"tInt8\" size=\"8\" description=\"predefined ADTF tInt8 datatype\"/> \n\ <datatype name=\"tUInt16\" size=\"16\" description=\"predefined ADTF tUInt16 datatype\"/> \n\ <datatype name=\"tInt16\" size=\"16\" description=\"predefined ADTF tInt16 datatype\"/> \n\ <datatype name=\"tUInt32\" size=\"32\" description=\"predefined ADTF tUInt32 datatype\"/> \n\ <datatype name=\"tInt32\" size=\"32\" description=\"predefined ADTF tInt32 datatype\"/> \n\ <datatype name=\"tUInt64\" size=\"64\" description=\"predefined ADTF tUInt64 datatype\"/> \n\ <datatype name=\"tInt64\" size=\"64\" description=\"predefined ADTF tInt64 datatype\"/> \n\ <datatype name=\"tFloat32\" size=\"32\" description=\"predefined ADTF tFloat32 datatype\"/> \n\ <datatype name=\"tFloat64\" size=\"64\" description=\"predefined ADTF tFloat64 datatype\"/> \n\ </datatypes> \n\ <enums/> \n\ <structs/> \n\ <streams/> \n\ </adtf:ddl>"
 XML header for the data definition language description (version 2) file.
 
#define SETTINGSFILE_HEADER   "<?xml version=\"1.0\" encoding=\"iso-8859-1\" standalone=\"no\"?>\n \ <adtf:settings xmlns:adtf=\"adtf\">\n \ </adtf:settings>"
 XML header for the settings file.
 
#define PLUGIN_DESCRIPTION_XML_ROOT   "adtf:plugin"
 Plugin description xml root name.
 
#define PLUGIN_DESCRIPTION_HEADER   "<?xml version=\"1.0\" encoding=\"iso-8859-1\" standalone=\"no\"?>\n \ <"PLUGIN_DESCRIPTION_XML_ROOT" xmlns:adtf=\"adtf\">\n \ </"PLUGIN_DESCRIPTION_XML_ROOT">"
 XML header for the plugin description files.
 
#define FILTER_DESCRIPTION_XML_ROOT   "adtf:filter"
 Filter description xml root name.
 
#define FILTER_DESCRIPTION_HEADER   "<?xml version=\"1.0\" encoding=\"iso-8859-1\" standalone=\"no\"?>\n \ <"FILTER_DESCRIPTION_XML_ROOT" xmlns:adtf=\"adtf\">\n \ </"FILTER_DESCRIPTION_XML_ROOT">"
 XML header for the filter description files.
 
#define SERVICE_DESCRIPTION_XML_ROOT   "adtf:service"
 Filter description xml root name.
 
#define SERVICE_DESCRIPTION_HEADER   "<?xml version=\"1.0\" encoding=\"iso-8859-1\" standalone=\"no\"?>\n \ <"SERVICE_DESCRIPTION_XML_ROOT" xmlns:adtf=\"adtf\">\n \ </"SERVICE_DESCRIPTION_XML_ROOT">"
 XML header for the service description files.
 
#define ADTF_USERDEFINEDCOMMENT_FILEEXT   "userdefined_comment"
 DAT-File extension for information from user-defined Record Dialog. More...
 

Enumerations

enum  tObjectCategory {
  OBJCAT_Unknown = 0, OBJCAT_Generic = 1, OBJCAT_Application = 2, OBJCAT_CameraDevice = 3,
  OBJCAT_SensorDevice = 4, OBJCAT_CanDevice = 5, OBJCAT_BusDevice = 6, OBJCAT_EthernetDevice = 7,
  OBJCAT_BridgeDevice = 8, OBJCAT_StandardDisplay = 9, OBJCAT_GraphicsDisplay = 10, OBJCAT_3DDisplay = 11,
  OBJCAT_TextDisplay = 12, OBJCAT_Recording = 13, OBJCAT_Playback = 14, OBJCAT_Storage = 15,
  OBJCAT_DataBuffer = 16, OBJCAT_DataFilter = 17, OBJCAT_Codec = 18, OBJCAT_Tool = 19,
  OBJCAT_Converter = 20, OBJCAT_Auxiliary = 21, OBJCAT_Clock = 22, OBJCAT_Event = 23,
  OBJCAT_Logging = 24, OBJCAT_Service = 100
}
 object categories
 

Detailed Description

These definitions are constants used within adtf namespace.

The most definitions are used to get Namespace Service paths and default properties. The for developers important definitions are: Sub Properties adtf::tObjectCategory

Copyright © Audi Electronics Venture GmbH. All rights reserved

Author
ELAMIHA
Date
2014-12-17 16:32:22 +0100 (Wed, 17 Dec 2014)
Revision
53283
Remarks

Definition in file adtf_constants.h.

Macro Definition Documentation

#define ADTF_USERDEFINEDCOMMENT_FILEEXT   "userdefined_comment"

DAT-File extension for information from user-defined Record Dialog.

The content is saved in XML format.

Definition at line 1063 of file adtf_constants.h.

#define CMDLINE_ID_ADTF_ENABLE_LICENSE_LOGGING   "enable-license-logging"

Specifies if log file with license check info will be created.

This can be useful on license issues.

Definition at line 953 of file adtf_constants.h.

#define CMDLINE_ID_ADTF_LOGFILE   "logfile"

Writes all stdout output to the given logfile.

The flag -stdout will be set automatically. The stderr output will be written in "logfile_stderr.txt". To get the whole output in one file use "launcher -stdout > logfile.txt 2>&1".

Definition at line 951 of file adtf_constants.h.

#define CMDLINE_ID_ADTF_PROJECT_FILE   "project"

Load a different project at startup.

NOTE: This feature is only usable with loaded project_tree and adtf_xsystem services.

Definition at line 938 of file adtf_constants.h.

#define CMDLINE_ID_ADTF_SKIP_BROKEN_DAT_FILE   "skip_broken_dat_files"

Broken DAT Files within a DAT Playlist will be skipped and the error will be logged to the console.

When using broken referenced files the property load_references of the Harddiskplayer has to be set to false and all referenced files must be included within the Playlist file. Otherwise all referenced files will be skipped.

Definition at line 952 of file adtf_constants.h.

#define CMDLINE_ID_ADTF_UNDER_TEST   "undertest"

For internal use only.

This will bring ADTF into a test mode.

Definition at line 950 of file adtf_constants.h.

#define NS_SESSION   "/session"

standard namespace paths

namespace path for session manager

Definition at line 30 of file adtf_constants.h.

#define NSPROP_CONFIGINFO_DISABLE_CONNECTION_VALIDITY_CHECK   NSPROP_CONFIGINFO ".disable_connection_validity_check"

Disable Connection Check.


Example:

1 SetPropertyBool(NSPROP_CONFIGINFO_DISABLE_CONNECTION_VALIDITY_CHECK, tTrue);

Definition at line 833 of file adtf_constants.h.

#define NSPROP_CONFIGINFO_ENABLECONFIGCLIENTBINDINGOBJECTS   NSPROP_CONFIGINFO ".enable_config_clientobjects"

Enable or disable the config client binding objects.


Example:

1 SetPropertyBool(NSPROP_CONFIGINFO_ENABLECONFIGCLIENTBINDINGOBJECTS, tTrue);

Definition at line 831 of file adtf_constants.h.

#define NSPROP_CONFIGINFO_ENABLECONFIGINPINS   NSPROP_CONFIGINFO ".enable_config_inputpins"

Enable or disable the creation of connection input pins.


Example:

1 SetPropertyBool(NSPROP_CONFIGINFO_ENABLECONFIGINPINS, tTrue);

Definition at line 828 of file adtf_constants.h.

#define NSPROP_CONFIGINFO_ENABLECONFIGOUTPINS   NSPROP_CONFIGINFO ".enable_config_outputpins"

Enable or disable the creation of connection output pins.


Example:

1 SetPropertyBool(NSPROP_CONFIGINFO_ENABLECONFIGOUTPINS, tTrue);

Definition at line 829 of file adtf_constants.h.

#define NSPROP_CONFIGINFO_ENABLECONFIGSERVERBINDINGOBJECTS   NSPROP_CONFIGINFO ".enable_config_serverobjects"

Enable or disable the server client binding objects.


Example:

1 SetPropertyBool(NSPROP_CONFIGINFO_ENABLECONFIGSERVERBINDINGOBJECTS, tTrue);

Definition at line 832 of file adtf_constants.h.

#define NSPROP_CONFIGINFO_ENABLECONNPINS   NSPROP_CONFIGINFO ".enable_connection_pins"

Enable or disable the creation of connection pins.


Example:

1 SetPropertyBool(NSPROP_CONFIGINFO_ENABLECONNPINS, tTrue);

Definition at line 826 of file adtf_constants.h.

#define NSPROP_CONFIGINFO_ENABLEDYNAMICPROPS   NSPROP_CONFIGINFO ".enable_dynamic_properties"

Enable or disable the creation of dynamic properties.


Example:

1 SetPropertyBool(NSPROP_CONFIGINFO_ENABLEDYNAMICPROPS, tTrue);

Definition at line 830 of file adtf_constants.h.

#define NSPROP_CONFIGINFO_MAXCONNPINS   NSPROP_CONFIGINFO ".max_connection_pins"

Defines the maximum of connection pins that will be created.


Example:

1 SetPropertyInt(NSPROP_CONFIGINFO_MAXCONNPINS, 2);

Definition at line 827 of file adtf_constants.h.

#define NSSUBPROP_CHANGED   ".IsChanged"

Internal use only.

internal use

This Sub Property will be set to True if the property was modified in the property view.
Example:

1 GetPropertyBool("MyProperty" NSSUBPROP_CHANGED);

Definition at line 579 of file adtf_constants.h.

#define NSSUBPROP_COLOR   ".IsColor"

With this Sub Property, a property can be declared as a color, if it is set to True.


Example:

1 SetPropertyStr("background", "#000000");
2 SetPropertyBool("background" NSSUBPROP_COLOR, tTrue);

Definition at line 548 of file adtf_constants.h.

#define NSSUBPROP_DESCRIPTION   ".Description"

Set this Sub Property to define a description text for the property.

The property view will show the description text as an ballon popup.
Example:

1 SetPropertyStr("MyProperty" NSSUBPROP_DESCRIPTION, "My description");
subproperty_description.png

Definition at line 558 of file adtf_constants.h.

#define NSSUBPROP_DIRECTORY   ".IsDirectory"

Set this Sub Property to True to mark the property as a directory property.

The property view will provide a folder-selection-dialog button for this property.
Example:

1 SetPropertyBool("MyProperty" NSSUBPROP_DIRECTORY, tTrue);

Definition at line 555 of file adtf_constants.h.

#define NSSUBPROP_DISPLAYNAME   ".DisplayName"

This Sub Property can be set to define which name is displayed for a property.

The property name will be shown as an ballon popup in the property view.
Example:

1  SetPropertyStr("MyPropertyName", "My Property");
2 SetPropertyStr("MyPropertyName" NSSUBPROP_DISPLAYNAME, "Display Property");


subproperty_displayname.png

Definition at line 567 of file adtf_constants.h.

#define NSSUBPROP_DONTEXPORT   ".DontExport"

Set this Sub Property to True to prevent this property to be stored in the configuration file.

internal use


Example:

1 SetPropertyBool("MyProperty" NSSUBPROP_DONTEXPORT, tTrue);

Definition at line 583 of file adtf_constants.h.

#define NSSUBPROP_FILENAME   ".IsFilename"

Set this Sub Property to True to mark the property as a filename property.

The property view will provide a file-selection-dialog button for this property.
Example:

1 SetPropertyBool("MyProperty" NSSUBPROP_FILENAME, tTrue);

Definition at line 550 of file adtf_constants.h.

#define NSSUBPROP_FILENAME_LIST   ".IsFilenameList"

Set this Sub Property to True to mark the property as a filename list property.

The property view will provide a file-selection-dialog button for this property. One or more files can be selected.
Example:

1 SetPropertyBool("MyProperty" NSSUBPROP_FILENAME_LIST, tTrue);

Definition at line 552 of file adtf_constants.h.

#define NSSUBPROP_GLOBALCONFIGPROPERTYNAME   NSSUBPROP_REFPROPERTY

Set this Sub Property to mark the parent property as a Property that references a Referenced Configuration Property.

helper definition for NSSUBPROP_REFPROPERTY

Example:

1 SetPropertyStr("MyProperty" NSSUBPROP_GLOBALCONFIGPROPERTYNAME, "ConfigPropertyName");

See Referenced Configuration Properties for further details.

Definition at line 575 of file adtf_constants.h.

#define NSSUBPROP_HIDDEN   ".IsHidden"

Set this Sub Property to True to hide the property in the property view.


Example:

1 SetPropertyBool("MyProperty" NSSUBPROP_HIDDEN, tTrue);

Definition at line 544 of file adtf_constants.h.

#define NSSUBPROP_ISCHANGEABLE   ".IsChangeable"

Set this Sub Property to define if this property can be changed at runtime.

Changes to this property is either not possible or will have no effect if changed during runtime if this property is set to False. By overwriting the adtf::cConfiguration::PropertyChanged method you can react to changeds made to a property during runtime.
Example:

1  SetPropertyInt("MyPropertyChange", 999);
2 SetPropertyBool("MyPropertyChange" NSSUBPROP_ISCHANGEABLE, tTrue);

Definition at line 565 of file adtf_constants.h.

#define NSSUBPROP_ISINACTIVE   ".IsInactive"

If true , the property is shown with a gray background in the Property Browser, indicating that the user cannot change the property.

Changes to the property via Property Browser can only be made before initialization (in contrast to NSSUBPROP_READONLY) . This sub property can be used to restrict changes via Property Browser of certain properties which should not be editable during runlevel RL_Application or RL_Running, for example in dependency of other property states. Changes to this property is possible during runtime. Example:

1 SetPropertyInt("MyPropertyInactive", 999);
2 SetPropertyBool("MyPropertyInactive" NSSUBPROP_ISINACTIVE, tTrue);

Definition at line 566 of file adtf_constants.h.

#define NSSUBPROP_MAX   ".max"

Set this Sub Property to define the maximum value for the property.

The user will not be able to set the property above the maximum value. Otherwise a error message will be shown "The value is outside the specified range!". The specified range is shown as an balloon popup in the property view.
Example:

1 SetPropertyInt("MyProperty" NSSUBPROP_MAX, 42);
subproperty_minmax.png

Definition at line 563 of file adtf_constants.h.

#define NSSUBPROP_MIN   ".min"

Set this Sub Property to define the minimum value for the property.

The user will not be able to set the property below the minimum value. Otherwise a error message will be shown "The value is outside the specified range!". The specified range is shown as an balloon popup in the property view.
Example:

1 SetPropertyInt("MyProperty" NSSUBPROP_MIN, -42);
subproperty_minmax.png

Definition at line 561 of file adtf_constants.h.

#define NSSUBPROP_MULTI_LINE_TEXT_EDIT   ".IsMultiTextEdit"

Set this Sub Property to True to mark the property as a multi line text edit property.

The property view will provide a multi-line-text-edit-dialog button for this property. This is useful for longer descriptions or comments.
Example:

1 SetPropertyBool("MyProperty" NSSUBPROP_MULTI_LINE_TEXT_EDIT, tTrue);

Definition at line 568 of file adtf_constants.h.

#define NSSUBPROP_ORGINALVALUE   ".OriginalValue"

Internal use only.

internal use

This Sub Property will be set to the original value read from the configuration file.
Example:

1 GetPropertyInt("MyProperty" NSSUBPROP_ORGINALVALUE);

Definition at line 581 of file adtf_constants.h.

#define NSSUBPROP_READONLY   ".IsReadOnly"

If this Sub Property is set to True, the property value cannot be changed within the property view.


Example:

1 SetPropertyInt("MyPropertyRedOnly", 999);
2 SetPropertyBool("MyPropertyRedOnly" NSSUBPROP_READONLY, tTrue);

Definition at line 557 of file adtf_constants.h.

#define NSSUBPROP_REQUIRED   ".IsRequired"

If this Sub Property is set to True the property is marked as mandatory.


ADTF will make this Property available to the user in the Dialog that is used to determine the Pins and Properties based on the Configuration. Example:

1 SetPropertyBool("MyProperty" NSSUBPROP_REQUIRED, tTrue);

Definition at line 546 of file adtf_constants.h.

#define NSSUBPROP_VALUELIST   ".ValueList"

With this Sub Property a value list can be defined for the property.

The list items are separated by the character '|'. Each item consists of the value and its description separated by the character '@'. In the GUI a editable combo box will be shown.
Notize: NSSUBPROP_VALUELIST is only supported by String Properties. For all other types this Sub Property will be converted into NSSUBPROP_VALUELISTNOEDIT. Example:

1  SetPropertyInt("MyPropertyValueList", 1);
2 SetPropertyStr("MyPropertyValueList" NSSUBPROP_VALUELIST, "1@One|2@Two|3@Three");


subproperty_valuelist.png

Definition at line 559 of file adtf_constants.h.

#define NSSUBPROP_VALUELISTNOEDIT   ".ValueListNoEdit"

This Sub Property is the same as the Sub Property NSSUBPROP_VALUELIST.

The only difference is that the combo box is not editable. This means, you cannot type other values, only select the predefined ones.
Example:

1  SetPropertyInt("MyPropertyValueList", 1);
2 SetPropertyStr("MyPropertyValueList" NSSUBPROP_VALUELISTNOEDIT, 1@One|2@Two|3@Three");

Definition at line 560 of file adtf_constants.h.

#define NSSUBSUBPROP_EXTENSIONFILTER   ".ExtensionFilter"

This sub-Sub Property can be used to set the extension filter for the file-selection-dialog of the associated filename property.

Currently this string is passed directly to Qt. So see the QFileDialog documentation for further details.
It can only be used in association with NSSUBPROP_FILENAME or NSSUBPROP_FILENAME_LIST.
Example:

1 SetPropertyStr("MyProperty" NSSUBPROP_FILENAME NSSUBSUBPROP_EXTENSIONFILTER, "Dat Files (*.dat)");
subproperty_extension.png

Definition at line 556 of file adtf_constants.h.

#define NSSUBSUBPROP_FILENAME_LIST_SEPARATOR   ".FilenameListSeparator"

This Sub-Sub Property is used to separate the selected filenames.

It can only be used in association with NSSUBPROP_FILENAME_LIST.
Example:

1  SetPropertyStr("MyPropertyFilenames", "C:\example.dat;C:\example2.dat");
2 SetPropertyBool("MyPropertyFilenames" NSSUBPROP_FILENAME_LIST, tTrue);
3 SetPropertyStr("MyPropertyFilenames" NSSUBPROP_FILENAME_LIST NSSUBSUBPROP_FILENAME_LIST_SEPARATOR, ";");

Definition at line 554 of file adtf_constants.h.


Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Fri Mar 22 2019 by doxygen 1.8.10)