Provide possibility to add meta information
synCRON:
legacy references: CDIFHD-116
affected version:
User story
As a developer I want to set a description for properties, its content (Reader, Processor, Serializer, ...) and - especially - the properties.
Additional information
As a possible solution, pair the existing properties with special properties following a naming convention to carry their meta data.
E.g. for a property property_name
, add the property property_name/#__description
with type "string"
and the actual value encoded in the default value.
Properties starting with #__
are attributed to the filter itself (e.g. #__description
).
Given that adtf_file::Configuration
is simply an std::unordered_map<std::string, PropertyValue>
constructed within the file plugin, simply provide C macros to define the initializer list elements corresponding to a fully annotated property.
Benefit for customer
We can reuse these descriptions within ADTF Configuration Editor (Property Editor):
- Reader properties for ADTFDAT File Player
- Processor properties for ADTF File Plugin Processor
Definition of done
-
SDK for setting a version to an adtffileplugin -
SDK for setting description for file components exists -
SDK for setting description to properties exists -
SDK for setting value range (min/max) to properties exists -
SDK for setting value lists to properties exists -
Use the exact same naming conventions as in ADTF: https://gitlab.com/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/-/blob/main/src/libraries/base/include/adtfbase/configuration.h?ref_type=heads#L424 -
adapt inspect call to show these information