DDL Mapping Filter Plugin

Table of Contents

• DDL Mapping Filter
  • Sources and Targets
  • DDL Mapping Triggers

DDL Mapping Filter

Plugin Information

Plugin Filename	adtf_ddl_mapping_filter.adtfplugin
Plugin Description	adtf_ddl_mapping_filter.plugindescription
Plugin Name	DDL Mapping Filter Plugin
License	ADTF
Support Mail	support@digitalwerk.net
Homepage URL	https://support.digitalwerk.net/

Plugin Versions

Plugin Version	3.18.2
Plugin File Version	1.0
adtf	3.18.2
adtf::ucom	3.1.0

Component Information

Name	DDL Mapping Filter
CID	ddl_mapping.filter.adtf.cid
Description	Use this Filter to convert the content of DDL based samples from one or more incoming structured memory or plain type values to one or more outgoing structured memory or plain type value.
Type	Filter

Properties

Name	Value	Type	Description	Subproperties
description_files		cFilenameList	List of filenames for description files to use.	Filename Extension Filter: Description files (*.description)
mapping_file		cFilename	Filename for a *.map file that contains source and targets which can than be mapped to dynamic input/output pin.s	Filename Extension Filter: Map files (*.map)
output_sample_time	0	tUInt8	Option to use whether the current timestamp of the trigger or the current clock timestamp for the output sample time.	Value List: While writing the output use the time of the current trigger. = 0 While writing the output use the current stream time. = 1

Runner

Name	Activation Type	Data Triggered	Data Input	Thread Triggered	Thread Cyclic	Timer Triggered	Timer Interval	Description
periodic_trigger	1	0		0	0	1	100	Runner to periodically trigger the function which generates the output data for periodic triggers within mapping file.

Dynamic Pins

Dynamic Input Pins	true
Dynamic Output Pins	true
Dynamic Input Binding Pins	false
Dynamic Output Binding Pins	false

Sources and Targets

The DDL Mapping Filter is to convert the content of DDL based samples from one or more incoming structured memory or plain type values to one or more outgoing structured memory or plain type value.

To do so, the filter reads and interprets a DDL mapping file. The mapping file will describe a mapping prescription what content to read and where to write it. For a detailed description of the content please see https://github.com/cariad-tech/dev_essential/blob/main/doc/extern/ddl/mapping_specification.md.

The file contains so called sources with a name and a set DDL type or plain type. Also, it contains targets with a name and a set DDL type or plain type. Targets will transcribed into outpin, sources are corresponding input pins. Within targets it is possible to assign from source values to target values.

Note

There are some limitations on the DDL struct name that might be used. Other than using self-contained ADTF Default Stream Types this Filter uses one or more DDL Description File for the mapping definitions. Within these files it is only allowed to use one struct name for one single struct definition.

Following names and types are possible for targets and sources:

Source Table

example of mapping file content	resulting input pin	possible assignment
<source name="NestedStruct" type="tNestedStruct" />	Pin: input pin name: NestedStruct type: adtf/default with a set md_struct="tNestedStruct" Notice: The tNestedStruct must be described in one of the given description_files or the Media Description Service.	On the targets mapping assignment, you can access the content with following statement: <assignment to="my_new_x" from="NestedStruct.sSimpleStruct.ui8Val"/>
<source name="x" type="INT64" />	Pin: input pin name: x type: adtf/plaintype with set c-type="INT64" and ddl type description set with md_struct="INT64" where only one element with the name value exists in the corresponding type. Notice: Following types are possible: BOOL, INT8, UINT8, INT16, UINT16, INT32, UINT32, INT64, UINT64, FLOAT32, FLOAT64.	<assignment to="my_new_x" from="x.value"/>
<source name="my_source_pin/NestedStruct" type="tNestedStruct" />	Pin: input pin name: my_source_pin type: adtf/substreams substream name: NestedStruct substream type: adtf/default with a set md_struct="tNestedStruct" Notice: The tNestedStruct must be described in one of the given description_files or the Media Description Service, otherwise initialisation will fail. Additionally, the NestedStruct substream name must exists within the connected sample stream, the filter will request and strongly expect it.	<assignment to="my_new_x" from="my_source_pin/NestedStruct.sSimpleStruct.ui8Val"/>
<source name="my_source_pin/x" type="INT64" />	Pin: input pin name: my_source_pin type: adtf/substreams substream name: x substream type: adtf/plaintype with set c-type="INT64" and ddl type description set with md_struct="INT64" where only one element with the name value exists in the corresponding type. Notice: Following substream types are possible: BOOL, INT8, UINT8, INT16, UINT16, INT32, UINT32, INT64, UINT64, FLOAT32, FLOAT64	<assignment to="my_new_x" from="my_source_pin/x.value"/>

Target Table

example of mapping file content	resulting output pin	possible assignment
<target name="NestedStruct" type="tNestedStruct" />	Pin: output pin name: NestedStruct type: adtf/default with a set md_struct="tNestedStruct" Notice: The tNestedStruct must be described in one of the given description_files or the Media Description Service.	On the targets mapping assignment, you can access the content with following statement if the source is a substream: <assignment to="NestedStruct.sSimpleStruct.ui8Val" from="my_source_pin/x.value"/> , or if the source is a ddl type: <assignment to="NestedStruct.sSimpleStruct.ui8Val" from="my_source_pin.sSimpleStruct.ui8Val"/> , or if the source is a plain type: <assignment to="NestedStruct.sSimpleStruct.ui8Val" from="my_source_pin.value"/> .
<target name="result" type="INT64" />	Pin: output pin name: result type: adtf/plaintype with set c-type="INT64" and ddl type description set with md_struct="INT64" where only one element with the name value exists in the corresponding type. Notice: Following types are possible: BOOL, INT8, UINT8, INT16, UINT16, INT32, UINT32, INT64, UINT64, FLOAT32, FLOAT64.	<assignment to="value" from="my_source_pin/x.value"/> or <assignment to="value" from="my_source_pin.sSimpleStruct.ui8Val"/> or <assignment to="value" from="my_source_pin.value"/>
<target name="my_target_pin/NestedStruct" type="tNestedStruct" />	Pin: input pin name: my_target_pin type: adtf/substreams substream name: NestedStruct substream type: adtf/default with a set md_struct="tNestedStruct" Notice: The tNestedStruct must be described in one of the given description_files or the Media Description Service, otherwise initialisation will fail.	<assignment to="sSimpleStruct.ui8Val" from="my_source_pin/x.value"/> or <assignment to="sSimpleStruct.ui8Val" from="my_source_pin.sSimpleStruct.ui8Val"/> or <assignment to="sSimpleStruct.ui8Val" from="my_source_pin.value"/>
<source name="my_target_pin/x" type="INT64" />	Pin: input pin name: my_target_pin type: adtf/substreams substream name: x substream type: adtf/plaintype with set c-type="INT64" and ddl type description set with md_struct="INT64" where only one element with the name value exists in the corresponding type. Notice: Following substream types are possible: BOOL, INT8, UINT8, INT16, UINT16, INT32, UINT32, INT64, UINT64, FLOAT32, FLOAT64	<assignment to="value" from="my_source_pin/x.value"/> or <assignment to="value" from="my_source_pin.sSimpleStruct.ui8Val"/> or <assignment to="value" from="my_source_pin.value"/>

Each target my have one or more triggers defined.

DDL Mapping Triggers

The DDL Mapping Filter will work data triggered on each configured source. For each target within the mapping file it is possible to congure it data triggered or time triggered:

Data Triggered:

• <trigger type="signal" variable="my_source_pin"/> 

  The targets sample is transmitted, if data were received on my_source_pin

• <trigger type="data" variable="my_source_pin.value" operator="greater_than" value="2"/> 

  The targets sample is transmitted, if data were received on my_source_pin AND the content of value is greater than 2.
• See https://github.com/cariad-tech/dev_essential/blob/main/doc/extern/ddl/mapping_specification.md for a full specification on that.

Time Triggered:

• <trigger type="periodic" period="5" unit="s"/> 

  The targets sample is transmitted, if the time trigger on periodic_trigger is called and the last call time is more than 5 seconds ago.
• See https://github.com/cariad-tech/dev_essential/blob/main/doc/extern/ddl/mapping_specification.md for a full specification on that.
• If no trigger is configured within a target, the corresponding targets sample is transmitted each time the connected Active Runner triggers.

Remarks

It is not possible to set up the connections to the input pins of this filter as asynchronous connections.