cariad-tech / adtf_file

ADTF File Library - famous, streaming-based file format for high performance data measurement

ADTF File Library {#mainpage}

Description

The ADTF File Library will enable you to read and write an .adtfdat file.

• basic serialisations for samples (container for timestamped streamed data)
• basic deserialisations for samples
• the file format IFHD itself (Indexed File Format)

---

ADTF File Library Packages

This library contains following internal packages:

adtf_file (see src/libraries/adtf_file)

The ADTF File Package with adtf_file::Writer and adtf_file::Reader. Depending on the ADTF File Version you may create and read Indexed Files with samples.

ifhd_file (see src/libraries/ifhd_file)

The IFHD File Package with the 'cIndexedFileWriter' and 'cIndexedFileReader'. Depending on the File Version you may create and read Indexed Files. This will not contain sample. The organisation type of data is chunk.

• ifhd::v400 is for ADTF 3.
• ifhd::v201_v301 is for ADTF 2.

utils5extension (see src/libraries/utils5extension)

This Package will provide some further helper classes needed to create an Indexed File.

adtfdat_processing (see src/libraries/adtfdat_processing)

This package will provide interfaces to export adtf::dat::ant::Processor and import adtf::dat::ant::Reader data from/to a adtf_file::Stream of an .adtfdat file.

ADTF File Library Tools

adtf_dattool (see src/tools/adtf_dattool)

Command line application to export/import data from/to .adtfdat files by using delivered or customized adtf::dat::ant::Processor and adtf::dat::ant::Reader. For more information please launch the tool with command --help.

Further Documentation

See ADTF File Library Documentation([link](@ref page_adtf_file_documentation))

License Information

Have also a look at MPL License. and see License Information([link](@ref page_license))

---

Dependencies

a_util library

The libraries above depend on the a_util library See a_util repository at https://github.com/AEV/a_util

DDL library

The libraries above depend on the DDL library See ddl repository at https://github.com/AEV/ddl

How to build

Build Environment

The libraries are build and tested only under following compilers and operating systems:

Windows 7 64 Bit

• Visual Studio C++ 2015 Update 3.1 (Update 3 and KB3165756)

Linux Ubuntu 16.04 LTS

• On other distributions make at least sure that libc has version >= 2.23 and libstdc++ >= 6.0.21.
• gcc 5.4

How to build

If you can not reach the above online repositories the bundle of it is delivered within a separate download area or installation. See Versions([link](@ref page_delivered_versions)).

Build a_util first

The ADTF File Library will only build if an installation of a_util library is provided. Following libraries of the a_utils are necessary:

• a_util_concurrency
• a_util_memory
• a_util_regex
• a_util_strings
• a_util_datetime
• a_util_filesystem
• a_util_xml

• Use CMAKE at least in version 3.5.1.
• Use the tag "va_util-version" see Versions
• Use CMakeLists.txt within the main directory as Source Directory
• Do not forget to set a CMAKE_INSTALL_PREFIX
• Build and install for Debug and RelWithDebInfo

Build ddl as second step

The ADTF File Library will only build if a installation of ddl library is provided.

• Use CMAKE at least in version 3.5.1.
• Use the tag "vddl-version". see Versions
• Use CMakeLists.txt within the main directory as Source Directory
• Do not forget to set a CMAKE_INSTALL_PREFIX
• Build and install for Debug and RelWithDebInfo

Build adtf_file

• Use CMAKE at least in version 3.5.
• Use the tag \p "vadtf-file-version-branch*" See Versions
• Use CMakeLists.txt within the main directory as Source Directory
• Set the a_util_DIR to your a_util install "lib/cmake/a_util"
• Do not forget to set a CMAKE_INSTALL_PREFIX
• Build and install for Debug and RelWithDebInfo

CMake options and dependencies

a_util_DIR	must be set to *a_util_install*/lib/cmake/a_util	See a_util repository at https://github.com/AEV/a_util
ddl_DIR	must be set to *ddl_install*/cmake	See ddl repository at https://github.com/AEV/ddl
ifhd_cmake_enable_documentation ON/OFF	choose wether a documentation is created or not	dependency to a valid doxygen executable needed (see http://www.doxygen.nl/)
ifhd_cmake_enable_integrated_tests ON/OFF	choose wether the tests where build while building the libraries or not	dependency to a valid gtest package needed (see https://github.com/google/googletest)