|
ADTF
|
The ADTFDAT File Recorder is a delivered Streaming Service plugin to store the measurement data in an .adtfdat file on hard disk.
| Plugin Filename | adtf_recorder.adtfplugin |
|---|---|
| Plugin Description | adtf_recorder.plugindescription |
| Plugin Name | Recording Output Streaming Service |
| License | ADTF |
| Support Mail | support@digitalwerk.net |
| Homepage URL | support.digitalwerk.net |
| Plugin Version | 3.99.99 |
|---|---|
| Plugin File Version | 1.0 |
| adtf | 3.99.99 |
| adtf::ucom | 3.1.0 |
| Name | ADTFDAT File Recorder |
|---|---|
| CID | adtfdat_file_recorder.streaming_sink.adtf.cid |
| Description | Use this Streaming Sink to store the measurement data on the hard disk in .adtfdat files. |
| Type | Filter |
| Name | Value | Type | Description | Subproperties |
|---|---|---|---|---|
| attach_report | true | tBool | Whether or not to store a system report extension in each generated file. | |
| attachment_configuration_file | cFilename | A configuration file that defines which files should be attached to the recordings. Please see the documentation for further information. | ||
| attachment_resolve_macros | false | tBool | Whether or not to resolve macros in the attached file configuration file (specified in attachment_configuration_file). Default is not to. | |
| automatic_split_interval_seconds | 0 | tUInt32 | When not equal to zero, split recordings after the given amount of seconds after a recording has been started. | |
| cache_attachment_archive | true | tBool | Whether or not to cache the archive of attached file or recreate it each time a recording is closed. Default is to cache the archive. | |
| default_description | cString | This description is stored in the file header. | ||
| diskspace_check_size | 0 | tUInt64 | If less than the specified value of disk space [MB] remains, then the recording is stopped and the file is closed correctly. | |
| file_format | 4 | tUInt32 | Choose the ADTF DAT File format version:
Mind that you need to choose appropriate serializations for each stream if you select 'adtf3'. | Value List: adtf3ns = 4 adtf3 = 3 |
| filename | $(ADTF_SESSION_DIR)/record_$(DATE)_$(TIME).adtfdat | cFilename | Filename of the measurement adtfdat file to be saved. If the file extension is not .adtfdat, the recorder will append this extension. | Filename Extension Filter: ADTF DAT file (*.adtfdat) |
| filename_suffix_on_collision | _%03d | cString | The format of the suffix used when there is a filename collision with an existing file. Default is '_%03d'. | |
| filename_suffix_on_split | _split_%03d | cString | The format of the suffix used for filename generation when a recording is split. Default is '_split_%03d'. | |
| follow_seconds | 0 | tUInt32 | Recording time [sec] after the start (non-continuous)/stop (continuous) trigger (posttrigger). | |
| history_seconds | 0 | tUInt32 | Recording time [sec] before the start trigger (pretrigger). | |
| keep_base_name_on_split | true | tBool | Use the name of the first file with the applied suffix when splitting files, without re-evaluating any macros. | |
| memory_check_ratio | 90 | tUInt32 | The percentage limit of physical memory used by the whole system which will be checked by ADTF. If the ratio will be exceeded, ADTFDAT File Recorder will not initialize or decrease the queues while running. | |
| recording_mode | 0 | tInt32 | The mode of operation, please have a look at the entire ADTFDAT File Recorder documentation page for an in depth explanation of the different recording modes. | Value List: Continuous Mode with File Based History = 0 Queue Mode with File Based Queue = 1 Queue Mode with Memory Based Queue = 2 |
| request_substreams | true | tBool | If activated, the recorder will request all substreams from all inputs. This will ensure, that all available data will be recorded. Mind that this can be millions of signals! To record only a subset of the available substreams use the "Substream Reducer" filter. If you want to selectively request substreams of a single input sample stream, deactivate this property and connect a "Substream Requestor" filter to the sample streams in parallel to the 'ADTFDAT File Recorder'. Please also keep in mind, that each parallel consumer which requests substreams will take effect and this content will be recorded as well. | |
| start_recording_on_startup | false | tBool | Starts the recording when Runlevel Running is reached. | |
| trace_clocks | false | tBool | When true, clock offsets will be recorded in file extensions. |
| Name | Activation Type | Data Triggered | Data Input | Thread Triggered | Thread Cyclic | Timer Triggered | Timer Interval | Description |
|---|---|---|---|---|---|---|---|---|
| process_recording_data | 6 | 0 | 1 | 1 | 0 | 0 | Connect a Thread Runner that will provide the context for writing all recording data to disk. If this is not connected, the recorder will create a thread on its own. |
| Name | IID | Proxy OID | Description |
|---|---|---|---|
| control | recorder.ant.services.adtf.iid | Interface server for recording access |
| Dynamic Input Pins | true |
|---|---|
| Dynamic Output Pins | false |
| Dynamic Input Binding Pins | false |
| Dynamic Output Binding Pins | false |
| IID |
|---|
| kernel.penguin.services.adtf.iid |
| reference_clock.riddler.streaming.adtf.iid |
| adtf_file_objects.devil.services.adtf.iid |
For recording all required data sources the related sample streams have to be connected to the ADTFDAT File Recorder. The ADTFDAT File Recorder works with dynamic data binding which means that it generates a new Pin when it is requested and uses it exclusively for one connection. This information is stored as streaming information in the resulting file (filename).
The ADTFDAT File Recorder has the following operation modes that can be activated via the recording_mode property: