comply with PEP 625: lower case distribution filenames; bump version 2.1.3

* windows-2019 to windows-2022
     * actions/setup-python to v5
     * actions/checkout to v5        in /.github/workflows

.github/workflows/pypi-deploy.yml

@@ -0,0 +1,100 @@
+
+name: CI Build Wheel
+
+on:
+  push:
+    tags: ["v[0-9]+.[0-9]+.[0-9]+"]
+
+jobs:
+
+  build_setup:
+    name: Prepare environment for wheel builds
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v2
+      - name: Prepare wheel build
+        run: make -C python/ setup
+      - name: Store wheel configuration files
+        uses: actions/upload-artifact@v4.6.0
+        with:
+          name: wheel-config
+          path: python/
+      - name: Display files
+        run: ls -lR
+
+  build_wheels:
+    name: Build binary wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    needs: [build_setup]
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - name: Install cibuildwheel
+        run: python -m pip install cibuildwheel==2.1.2
+      - name: Get wheel configuration files
+        uses: actions/download-artifact@v4.1.7
+        with:
+          name: wheel-config
+          path: python/
+      - name: Build wheels
+        run: python -m cibuildwheel --output-dir wheelhouse
+        working-directory: python/
+      - name: Store binary wheels
+        uses: actions/upload-artifact@v4.6.0
+        with:
+          name: binary-wheels-${{matrix.os}}-${{ strategy.job-index }}
+          path: python/wheelhouse/*.whl
+
+  build_sdist:
+    name: Build source distribution
+    runs-on: ubuntu-24.04
+    needs: [build_setup]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install cython
+        run: python -m pip install cython==0.29.24
+      - name: Get wheel configuration files
+        uses: actions/download-artifact@v4.1.7
+        with:
+          name: wheel-config
+          path: python/
+      - name: Build sdist
+        run: python setup.py sdist
+        working-directory: python/
+      - name: Store source wheels
+        uses: actions/upload-artifact@v4.6.0
+        with:
+          name: source-wheels
+          path: python/dist/*.tar.gz
+      - name: Display files
+        run: ls -lR
+
+
+  upload_pypi:
+    name: Upload wheels to PyPI
+    runs-on: ubuntu-24.04
+    needs: [build_wheels, build_sdist]
+
+    steps:
+      - name: Get source wheels
+        uses: actions/download-artifact@v4.1.7
+        with:
+          name: source-wheels
+          path: dist/
+      - name: Get binary wheels
+        uses: actions/download-artifact@v4.1.7
+        with:
+          path: dist/
+          pattern: binary-wheels-*
+          merge-multiple: true
+      - name: Display files
+        run: ls -lR
+
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.TDMTERMITE_GITHUB_WORKFLOW_PYPI_API_TOKEN }}

.gitignore

@@ -12,3 +12,21 @@ tdmripper
 tdmreaper
 cython/*.cpp
 tdmtermite
+dist/
+*.egg-info/
+output/
+monitor-process.sh
+tdmtest
+pip/*.hpp
+pip/*.md
+pip/*.cpp
+pip/*.pyx
+pip/*.pxd
+pip/LICENSE
+
+python/3rdparty/
+python/LICENSE
+python/README.md
+python/TDMtermite.cpp
+python/lib/
+

Dockerfile

@@ -1,20 +1,30 @@
 
-FROM debian:bullseye-20210111
+FROM debian:bullseye 
 
-USER root
+# install requirements
-
+RUN apt-get update && apt-get upgrade -y && apt-get install -y \
-RUN apt-get update && apt-get install -y \
+    build-essential \
-    build-essential git \
+    g++ make git \
     python3 python3-pip
 
-RUN g++ -v
+# check compiler and current user
+RUN g++ -v && whoami
 
-COPY ./ /tdm_ripper/
+# use /home as working directory
+WORKDIR /home
+
+# get the public TDMtermite repository
+RUN git clone https://github.com/RecordEvolution/TDMtermite.git
 
 # install CLI tool
-RUN cd /tdm_ripper && ls -lh && make install && ls -lh /usr/local/bin/tdmreaper
+RUN cd ./TDMtermite && ls -lh && make install && ls -lh /usr/local/bin/tdmtermite
 
 # install Python module
-RUN cd /tdm_ripper && ls -lh && make cython-requirements && make cython-install
+RUN cd ./TDMtermite && ls -lh && make cython-requirements && make cython-list && make cython-install
+
+# create directory for data exchange
+#RUN [ "/bin/bash", "-c", "mkdir -pv data/{input,output}" ]
+RUN mkdir -pv data
+
+CMD ["sleep","infinity"]
 
-CMD ["sleep","inifity"]

README.md

@@ -1,21 +1,20 @@
 
-<p align="center">
+[![LICENSE](https://img.shields.io/github/license/RecordEvolution/TDMtermite)](https://img.shields.io/github/license/RecordEvolution/TDMtermite)
-  <a href="https://github.com/RecordEvolution/tdm_ripper.git">
+[![STARS](https://img.shields.io/github/stars/RecordEvolution/TDMtermite)](https://img.shields.io/github/stars/RecordEvolution/TDMtermite)
-    <img
+![CI Build Wheel](https://github.com/RecordEvolution/TDMtermite/actions/workflows/pypi-deploy.yml/badge.svg?branch=&event=push)
-      alt="tdmtermite.svg"
+[![PYPI](https://img.shields.io/pypi/v/TDMtermite.svg)](https://pypi.org/project/tdmtermite/)
-      src="assets/tdmtermite.svg"
-      width="400"
-    />
-  </a>
-</p>
 
-_TDMtermite_ is a C++ based library that decodes (encodes) the proprietary
+# TDMtermite
-file format _TDM/TDX_ for measurement data, which relies upon the
+
-_technical data management_ data model. The TDM format was introduced by
+_TDMtermite_ is a C++ based library that decodes the proprietary
-[National Instruments](https://www.ni.com) and is employed by
+file format _TDM/TDX_ for measurement data. First introduced by
+[National Instruments](https://www.ni.com), the TDM format relies on the
+_technical data management_ data model and is employed by
 [LabVIEW](https://www.ni.com/de-de/shop/labview.html), LabWindows™/CVI™,
 Measurement Studio, SignalExpress, and [DIAdem](https://www.ni.com/de-de/shop/data-acquisition-and-control/application-software-for-data-acquisition-and-control-category/what-is-diadem.html).
 
+The [Record Evolution Platform](https://www.record-evolution.de/en/home-en/) uses TDMtermite to integrate measurement data into ETL processes. The TDMtermite library is available both as a command line tool and as a Python module. The Python module of TDMtermite enables data scientists to conveniently include TDM formats in their existing data pipelines by providing access to both raw data and metadata in terms of native Python objects.    
+
 ## Overview
 
 * [TDM file format](#Dataformat)
@@ -25,18 +24,18 @@ Measurement Studio, SignalExpress, and [DIAdem](https://www.ni.com/de-de/shop/da
 
 ## Dataformat
 
-Datasets encoded in the TDM/TDX format come along in pairs comprised of a
+Datasets encoded in the TDM/TDX format come in pairs comprised of a
-.tdm (header) and a .tdx (data) file. While the .tdm file is a human-readable
+.tdm (header) file and a .tdx (data) file. While the .tdm file is a human-readable
-file providing meta information about the data set, the .tdx is a binary
+file providing meta information about the dataset, the .tdx file is a binary file
 containing the actual data. The .tdm based on the _technical data management_
-model is an XML file and basically describes what data the .tdx contains and how
+model is an XML file. It describes what data the .tdx file contains and how
 to read it. The
 [TDM data model](https://www.ni.com/de-de/support/documentation/supplemental/10/ni-tdm-data-model.html)
-structures the data hierarchically with respect to _file_, (channel) _groups_ and
+structures the data hierarchically with respect to _file_, _(channel)_ _groups_ and
-_channels_. The file level XML may contain any number of (channel) groups each
+_channels_. The file-level XML may contain any number of (channel) groups, each
 of which is made up of an arbitrary number of channels. Thus, the XML tree in
 the [TDM header file](https://zone.ni.com/reference/de-XX/help/370858P-0113/tdmdatamodel/tdmdatamodel/tdm_headerfile/)
-looks basically like this:
+looks like this:
 
 ```xml
 <?xml version="1.0" encoding="UTF-8" standalone="no" ?>
@@ -67,14 +66,14 @@ looks basically like this:
 </usi:tdm>
 ```
 
-and is comprised of _four_ main XML elements: `usi:documentation`, `usi:model`,
+The XML tree is comprised of _four_ main XML elements: `usi:documentation`, `usi:model`,
 `usi:include` and `usi:data`. The element `usi:include` references the data file
 `example.tdx` and reveals one of _two_ possible orderings of the mass data (.tdx):
 
-1. either _channel wise_ (`<block>`) - all values of a specific channel follow subsequently -
+1. either _channel-wise_ (`<block>`) - all values of a specific channel follow subsequently
-1. or _block wise_ (`<block_bm>`) - all values of a specific measurement time follow subsequently -
+1. or _block-wise_ (`<block_bm>`) - all values of a specific measurement time follow subsequently.
 
-ordering. The supported _numerical data types_ are
+The supported _numerical data types_ are:
 
 | datatype    | channel datatype | numeric | value sequence  | size  | description             |
 |-------------|------------------|---------|-----------------|-------|-------------------------|
@@ -87,10 +86,10 @@ ordering. The supported _numerical data types_ are
 | eFloat64Usi | DT_DOUBLE        | 7       | double_sequence | 8byte | 64 Bit double           |
 | eStringUsi  | DT_STRING        | 1       | string_sequence |       | text                    |
 
-The XML element `<usi:data>` is basically comprised of _five_ different types of
+The XML element `<usi:data>` is comprised of _five_ different types of
 elements that are `<tdm_root>`, `<tdm_channelgroup>`, `<tdm_channel>`, `<localcolumn>`
 and `<submatrix>`. The root element `<tdm_root>` describes the general properties
-of the dataset and lists the _id's_ of all channel groups that belong to
+of the dataset and lists the _ids_ of all channel groups that belong to
 the dataset. The element `<tdm_channelgroup>` divides the _channels_ into groups
 and has a unique _id_ that is referenced by its root element. The `<channels>`
 element in `<tdm_channelgroup>` lists the unique ids of all channels that belong
@@ -110,7 +109,7 @@ actual data including its datatype. The remaining element types are
 </localcolumn>
 ```
 
-with a unique id, the `<measurement_quantity>` refering to one specific channel,
+with a unique id, the `<measurement_quantity>` referring to one specific channel,
 the `<submatrix>` and its id respectively, the type of representation in
 `<sequence_representation>` - being one of _explicit_, _implicit linear_ or
 _rawlinear_ - and the `<values>` element, which refers to one _value sequence_,
@@ -125,49 +124,63 @@ and the element `<submatrix>`
 </submatrix>
 ```
 
-that references the channel group in `<measurement>` it belongs to and provides
+that references the channel group in `<measurement>` to which it belongs and provides
 the _number of rows_ in the channels listed in `<local_columns>`.
 
 ## Installation
 
-The library can be used both as a _CLI_ based tool and as a _Python_ module.
+The library can be used both as a _CLI_-based tool and as a _Python_ module.
 
 ### CLI tool
 
-To install the CLI tool _tdmtermite_ do
+To install the CLI tool _TDMtermite_, do
 
 ```Shell
 make install
 ```
 
-which uses `/usr/local/bin` as installation directory. On _macOSX_ please first
+which uses `/usr/local/bin` as an installation directory. On _macOSX_, please first
 build the binary locally with `make` and install it in your preferred location.
 
 ### Python
 
-In order to build a _Python module_ from the _C++_ code base the
+In order to build a _Python module_ from the _C++_ code base, the
 [Cython](https://cython.readthedocs.io/en/latest/index.html) package must be
-available, which may be installed via `python3 -m pip install cython` .
+available. It may be installed via `python3 -m pip install cython` .
-Furthermore, the [Numpy](https://numpy.org) package is recommended to be able
+The [Numpy](https://numpy.org) package is recommended
 to pass arrays of data from the C++ kernel to Python. The _makefile_ provides
 the target `make cython-requirements` to install all required Python modules.
-Finally, to build the Python extension _tdm_termite_ either locally or install
+Finally, to build the Python extension _tdm_termite_ locally or install
-it the targets `make cython-build` and `make cython-install` are provided.
+it, the targets `make cython-build` and `make cython-install` are provided.
-Hence, to install the Python module on the system simply do
+To install the Python module on the system, simply do
 
 ```Shell
 make cython-requirements
 make cython-install
 ```
 
-that makes the module available to be imported as `import tdm_termite` .
+which makes the module available for import by `import tdm_termite` .
+
+#### Installation with pip
+
+The package is also available via the [Python Package Index](https://pypi.org) at
+[TDMtermite](https://pypi.org/project/tdmtermite/). To install the latest version simply do
+
+```Shell
+python3 -m pip install tdmtermite
+```
+
+##### Unix
+
+Note, that _python3_setuptools_ and _gcc version >= 10.2.0_ are required to
+successfully install and use it.
 
 ## Usage
 
 ### CLI tool
 
 The usage of the CLI tool is sufficiently clarified by its help message displayed
-by `tdmtermite --help`. For instance, to extract the data decoded in the pair of
+by `tdmtermite --help`. To extract the data decoded in the pair of
 files `samples/SineData.tdm` and `samples/SineData.tdx` into the directory
 `/home/jack/data/`:
 
@@ -176,7 +189,7 @@ tdmtermite samples/SineData.tdm samples/SineData.tdx --output /home/jack/data
 ```
 
 The tool can also be used to list the available objects in the TDM dataset, which
-are i.a. _channels_, _channelgroups_ and TDX _blocks_. For instance, to list
+are i.a. _channels_, _channelgroups_ and TDX _blocks_. To list
 all channels and channelgroups (without writing any file output):
 
 ```Shell
@@ -184,48 +197,48 @@ tdmtermite samples/SineData.tdm samples/SineData.tdx --listgroups --listchannels
 ```
 
 The user may also submit a _filenaming rule_ to control the names of the files the
-channel(-group)s are written to. To this end, the _magic flags_ `%G` `%g`, `%C`
+channel(group)s are written to. To this end, the _magic flags_ `%G` `%g`, `%C`
 and `%c` representing the group id, group name, channel index and channel name
-are defined. The default filenaming option is
+are defined. The default filenaming option is:
 
 ```Shell
 tdmtermite samples/SineData.tdm samples/SineData.tdx --output /home/jack/data --filenames channelgroup_%G.csv
 ```
 
-which makes the tool write _all channels_ grouped into files according to their
+This makes the tool write _all channels_ grouped into files according to their
-group association, while all channelgroup filenames obey the pattern `channelgroup_%G.csv`
+group association, while all channelgroup filenames obey the pattern `channelgroup_%G.csv`,
 with `%G` being replaced by the group id. The filenaming rule also enables the user
-to extract only a single channel(group) by providing a particular channel(-group)
+to extract only a single channel(group) by providing a particular channel(group)
 id in the filenaming flag. For example,
 
 ```Shell
 tdmtermite samples/SineData.tdm samples/SineData.tdx --output /home/jack/data -f channel_usi16_%c.csv --includemeta
 ```
 
-will write the single channel with id `usi16` to the file
+This will write the single channel with the id `usi16` to the file
-`/home/jack/data/channel_usi16_A4.csv` including its meta-data as a file header.
+`/home/jack/data/channel_usi16_A4.csv`, including its meta-data as a file header.
 
 ### Python
 
-To be able to use the Python module _tdm_termite_ it first has to be build locally
+To be able to use the Python module _tdm_termite_, it first has to be built locally
-or installed on the system. In the Python interpreter simply do:
+or installed on the system. In the Python interpreter, simply do:
 
 ```Python
-import tdm_termite
+import tdmtermite
 ```
 
-to import the module. The TDM files are provided by creating an instance of
+This will import the module. The TDM files are provided by creating an instance of
-the _tdm_termite_ class:
+the _tdmtermite_ class:
 
 ```Python
-# create 'tdm_termite' instance object
+# create 'tdmtermite' instance object
 try :
-    jack = tdm_termite.tdmtermite(b'samples/SineData.tdm',b'samples/SineData.tdx')
+    jack = tdmtermite.tdmtermite(b'samples/SineData.tdm',b'samples/SineData.tdx')
 except RuntimeError as e:
     print("failed to load/decode TDM files: " + str(e))
 ```
 
-After initializing the _tdm_termite_ object it can be used to extract any of the
+After initializing the _tdmtermite_ object, it can be used to extract any of the
 available data. For instance, to list the included channelgroups and channels:
 
 ```Python
@@ -237,16 +250,16 @@ grpids = jack.get_channelgroup_ids()
 chnids = jack.get_channel_ids()
 ```
 
-As a use case, we have look at listing the ids of all channelgroups and printing
+As a use case, we have a look at listing the ids of all channelgroups and printing
 their data to separate files:
 
 ```Python
-import tdm_termite
+import tdmtermite
 import re
 
-# create 'tdm_termite' instance object
+# create 'tdmtermite' instance object
 try :
-    jack = tdm_termite.tdmtermite(b'samples/SineData.tdm',b'samples/SineData.tdx')
+    jack = tdmtermite.tdmtermite(b'samples/SineData.tdm',b'samples/SineData.tdx')
 except RuntimeError as e :
     print("failed to load/decode TDM files: " + str(e))
 
@@ -274,19 +287,19 @@ for grp in grpids :
         print("failed to print channelgroup: " + str(grp) + " : " + str(e))
 ```
 
-For a full example including more details see the [extensive example](python/usage.py)
+For details, see this [extensive example](python/usage.py)
 and the absolute minimal example [minimal usage](python/minimal.py). In order
 to simply extract all data of the TDM datatset and dump it to files in a given
 (existing!) directory, do
 
 ```Python
-import tdm_termite
+import tdmtermite
-jack = tdm_termite.tdmtermite(b'samples/SineData.tdm',b'samples/SineData.tdx')
+jack = tdmtermite.tdmtermite(b'samples/SineData.tdm',b'samples/SineData.tdx')
 jack.write_all(b"./my_tdm_data_directory/")
 ```
 
-The interface allows to construct customized file/column headers from any
+The interface allows you to construct customized file/column headers from any
-meta-data and provide these headers for usage in file output (see the
+meta-data and provide these headers for usage in file output (see this
 [example](python/custom.py)).
 
 ## References
@@ -308,6 +321,30 @@ meta-data and provide these headers for usage in file output (see the
 
 ### Implementation
 
+- https://en.cppreference.com/w/
 - https://pugixml.org/
 - https://github.com/zeux/pugixml
 - https://cython.readthedocs.io/en/latest/src/userguide/wrapping_CPlusPlus.html
+
+### Packaging
+
+#### Documentation
+
+- https://packaging.python.org/tutorials/packaging-projects/
+- https://setuptools.readthedocs.io/en/latest/userguide/declarative_config.html
+- https://test.pypi.org/account/register/
+- https://github.com/pypa/auditwheel
+- https://github.com/pypa/python-manylinux-demo
+- https://github.com/pypa/manylinux
+
+#### C/C++ Extensions
+
+- https://docs.python.org/3/extending/building.html
+
+#### Articles
+
+- https://martinsosic.com/development/2016/02/08/wrapping-c-library-as-python-module.html
+- https://malramsay.com/post/perils-of-packaging/
+- https://github.com/neuronsimulator/nrn/issues/329
+- https://levelup.gitconnected.com/how-to-deploy-a-cython-package-to-pypi-8217a6581f09
+- https://medium.com/swlh/distributing-python-packages-protected-with-cython-40fc29d84caf

assets/index.html

@@ -0,0 +1,55 @@
+
+<html>
+
+<head>
+
+  <title>TDMtermite</title>
+  <style>
+  </style>
+
+</head>
+
+<body>
+
+  <p align="center">
+    <a href="https://github.com/RecordEvolution/TDMtermite.git">
+      <img alt="tdmtermite.svg"
+           src="assets/tdmtermite.svg"
+           width="400"
+      />
+    </a>
+  </p>
+
+  <div style="width: 100%; display: block; margin-left: 28%; margin-right: 28%;">
+
+  <div style="width: 100%; overflow: hidden;">
+
+    <div style="margin: 5px; float: left;">
+      <a href="https://lgtm.com/projects/g/RecordEvolution/TDMtermite/alerts/">
+        <img alt="Total alerts" 
+             src="https://img.shields.io/lgtm/alerts/g/RecordEvolution/TDMtermite.svg?logo=lgtm&logoWidth=18"/>
+      </a>
+    </div>
+
+    <div style="margin: 5px; float: left;">
+      <a href="https://lgtm.com/projects/g/RecordEvolution/TDMtermite/context:cpp">
+        <img alt="Language grade: C/C++" 
+             src="https://img.shields.io/lgtm/grade/cpp/g/RecordEvolution/TDMtermite.svg?logo=lgtm&logoWidth=18"/>
+      </a>
+    </div>
+
+    <div style="margin: 5px; float: left;">
+      <a href="https://lgtm.com/projects/g/RecordEvolution/TDMtermite/context:python">
+        <img alt="Language grade: Python" 
+             src="https://img.shields.io/lgtm/grade/python/g/RecordEvolution/TDMtermite.svg?logo=lgtm&logoWidth=18"/>
+      </a>
+    </div>
+
+  </div>
+  
+  </div>
+
+</body>
+
+</html>
+

cython/requirements.txt

@@ -1 +0,0 @@
-Cython==0.29.21

cython/setup.py

@@ -1,24 +0,0 @@
-from distutils.core import setup
-from distutils.extension import Extension
-from Cython.Build import cythonize
-
-extensions = Extension(
-    name="tdm_termite",
-    sources=["cython/py_tdm_termite.pyx"],
-    # libraries=[""],
-    # library_dirs=["lib"],
-    include_dirs=["lib","pugixml"],
-    language='c++',
-    extra_compile_args=['-std=c++17','-Wno-unused-variable'],
-    extra_link_args=['-std=c++17'],
-)
-
-setup(
-    version='0.1',
-    description='TDMtermite cython extension',
-    author='Record Evolution GmbH',
-    author_email='mario.fink@record-evolution.de',
-    url='https://github.com/RecordEvolution/tdm_ripper.git',
-    name="tdm_termite",
-    ext_modules=cythonize(extensions)
-)

lib/tdm_datatype.hpp

@@ -14,9 +14,11 @@ typedef unsigned short int eUInt16Usi;
 typedef unsigned int eUInt32Usi;
 typedef float eFloat32Usi;
 typedef double eFloat64Usi;
+typedef char eStringUsi;
 
 class tdmdatatype
 {
+
 protected:
   eInt16Usi sint16_;    // 0
   eInt32Usi sint32_;    // 1
@@ -25,11 +27,13 @@ protected:
   eUInt32Usi uint32_;   // 4
   eFloat32Usi float32_; // 5
   eFloat64Usi float64_; // 6
-  short int dtidx_;     // \in \{0,...,6\}
+  eStringUsi string_;   // 7
+  short int dtidx_;     // \in \{0,...,7\}
+
 public:
   tdmdatatype(): sint16_(0), sint32_(0),
                  uint8_(0), uint16_(0), uint32_(0),
-                 float32_(0.0), float64_(0.0),
+                 float32_(0.0), float64_(0.0), string_(0),
                  dtidx_(0) { };
   // every supported datatype gets its own constructor
   tdmdatatype(eInt16Usi num): sint16_(num), dtidx_(0) {};
@@ -39,10 +43,25 @@ public:
   tdmdatatype(eUInt32Usi num): uint32_(num), dtidx_(4) {};
   tdmdatatype(eFloat32Usi num): float32_(num), dtidx_(5) {};
   tdmdatatype(eFloat64Usi num): float64_(num), dtidx_(6) {};
+  tdmdatatype(eStringUsi num): string_(num), dtidx_(7) {};
 
   // identify type
   short int& dtype() { return dtidx_; }
 
+  // copy constructor
+  tdmdatatype(const tdmdatatype &num)
+  {
+    this->sint16_ = num.sint16_;
+    this->sint32_ = num.sint32_;
+    this->uint8_ = num.uint8_;
+    this->uint16_ = num.uint16_;
+    this->uint32_ = num.uint32_;
+    this->float32_ = num.float32_;
+    this->float64_ = num.float64_;
+    this->string_ = num.string_;
+    this->dtidx_ = num.dtidx_;
+  }
+
   // overall assignment operator
   tdmdatatype& operator=(const tdmdatatype &num)
   {
@@ -55,9 +74,11 @@ public:
       this->uint32_ = num.uint32_;
       this->float32_ = num.float32_;
       this->float64_ = num.float64_;
+      this->string_ = num.string_;
+      this->dtidx_ = num.dtidx_;
     }
 
-		return *this;
+    return *this;
   }
 
   // implement assignment operator for individual datatypes
@@ -103,6 +124,12 @@ public:
     this->dtidx_ = 6;
     return *this;
   }
+  tdmdatatype& operator=(const eStringUsi &num)
+  {
+    this->string_ = num;
+    this->dtidx_ = 7;
+    return *this;
+  }
 
   // obtain number as double
   double as_double()
@@ -115,6 +142,7 @@ public:
     else if ( dtidx_ == 4 ) num = (double)uint32_;
     else if ( dtidx_ == 5 ) num = (double)float32_;
     else if ( dtidx_ == 6 ) num = (double)float64_;
+    else if ( dtidx_ == 7 ) num = (double)(int)string_;
     return num;
   }
 
@@ -128,6 +156,7 @@ public:
     else if ( num.dtidx_ == 4 ) out<<num.uint32_;
     else if ( num.dtidx_ == 5 ) out<<num.float32_;
     else if ( num.dtidx_ == 6 ) out<<num.float64_;
+    else if ( num.dtidx_ == 7 ) out<<num.string_;
     return out;
   }
 
@@ -316,7 +345,7 @@ const std::vector<tdm_datatype> tdm_datatypes = {
   {"eFloat32Usi","DT_FLOAT",3,"float_sequence",4,"32 bit float"},
   {"eFloat64Usi","DT_DOUBLE",7,"double_sequence",8,"64 bit double"},
 
-  // {"eStringUsi","DT_STRING",1,"string_sequence",0,"text"}
+  {"eStringUsi","DT_STRING",1,"string_sequence",1,"text"}
 
 };
 

lib/tdm_termite.cpp

@@ -6,16 +6,73 @@
 
 tdm_termite::tdm_termite()
 {
-
+  tdx_ifstream_ = new std::ifstream;
 }
 
 tdm_termite::tdm_termite(std::string tdmfile, std::string tdxfile, bool showlog):
   tdmfile_(tdmfile), tdxfile_(tdxfile)
 {
+  tdx_ifstream_ = new std::ifstream;
+
   // start processing tdm data model
   this->process_tdm(showlog);
 }
 
+tdm_termite::~tdm_termite()
+{
+  // close tdx-file stream and free memory
+  if ( tdx_ifstream_->is_open() ) tdx_ifstream_->close();
+  delete tdx_ifstream_;
+}
+
+tdm_termite::tdm_termite(const tdm_termite& other):
+  tdmfile_(other.tdmfile_), tdxfile_(other.tdxfile_), csvfile_(other.csvfile_),
+  endianness_(other.endianness_), machine_endianness_(other.machine_endianness_),
+  meta_data_(other.meta_data_), tdmdt_name_(other.tdmdt_name_),
+  tdmdt_chan_(other.tdmdt_chan_),
+  tdx_blocks_(other.tdx_blocks_), tdmroot_(other.tdmroot_),
+  tdmchannelgroups_(other.tdmchannelgroups_), tdmchannels_(other.tdmchannels_),
+  tdmchannels_data_(other.tdmchannels_data_), submatrices_(other.submatrices_),
+  localcolumns_(other.localcolumns_), tdxbuffer_(other.tdxbuffer_)
+{
+  tdx_ifstream_ = new std::ifstream;
+  if ( other.tdx_ifstream_->is_open() )
+  {
+    tdx_ifstream_->open(tdxfile_.c_str(),std::ifstream::binary);
+    tdx_ifstream_->seekg(other.tdx_ifstream_->tellg());
+  }
+}
+
+tdm_termite& tdm_termite::operator=(const tdm_termite& other)
+{
+  if ( this != &other )
+  {
+    tdmfile_ = other.tdmfile_;
+    tdxfile_ = other.tdxfile_;
+    csvfile_ = other.csvfile_;
+    endianness_ = other.endianness_;
+    machine_endianness_ = other.machine_endianness_;
+    meta_data_ = other.meta_data_;
+    tdmdt_name_ = other.tdmdt_name_;
+    tdmdt_chan_= other.tdmdt_chan_;
+    tdx_blocks_ = other.tdx_blocks_;
+    tdmroot_ = other.tdmroot_;
+    tdmchannelgroups_ = other.tdmchannelgroups_;
+    tdmchannels_ = other.tdmchannels_;
+    tdmchannels_data_ = other.tdmchannels_data_;
+    submatrices_ = other.submatrices_;
+    localcolumns_ = other.localcolumns_;
+    tdxbuffer_ = other.tdxbuffer_;
+    if ( other.tdx_ifstream_->is_open() )
+    {
+      tdx_ifstream_->open(tdxfile_.c_str(),std::ifstream::binary);
+      tdx_ifstream_->seekg(other.tdx_ifstream_->tellg());
+    }
+  }
+
+  return *this;
+}
+
 void tdm_termite::submit_files(std::string tdmfile, std::string tdxfile, bool showlog)
 {
   // save files
@@ -106,20 +163,26 @@ void tdm_termite::process_tdm(bool showlog)
   this->process_localcolumns(showlog,xml_doc);
 
   // open .tdx and stream all binary data into buffer
+  // try {
+  //   std::ifstream fin(tdxfile_.c_str(),std::ifstream::binary);
+  //   // if ( !fin.good() ) std::cerr<<"failed to open .tdx-file\n";
+  //
+  //   std::vector<unsigned char> tdxbuf((std::istreambuf_iterator<char>(fin)),
+  //                                     (std::istreambuf_iterator<char>()));
+  //   tdxbuffer_ = tdxbuf;
+  //
+  //   if ( showlog ) std::cout<<"size of .tdx buffer (bytes): "<<tdxbuffer_.size()<<"\n\n";
+  //
+  //   // close .tdx file
+  //   fin.close();
+  // } catch (const std::exception& e ) {
+  //   throw std::runtime_error( std::string("failed to open .tdx and stream data to buffer: ")
+  //                             + e.what() );
+  // }
   try {
-    std::ifstream fin(tdxfile_.c_str(),std::ifstream::binary);
+    tdx_ifstream_->open(tdxfile_.c_str(),std::ifstream::binary);
-    // if ( !fin.good() ) std::cerr<<"failed to open .tdx-file\n";
+  } catch (const std::exception& e) {
-
+    throw std::runtime_error( std::string("failed to open .tdx file in ifstream: ")
-    std::vector<unsigned char> tdxbuf((std::istreambuf_iterator<char>(fin)),
-                                      (std::istreambuf_iterator<char>()));
-    tdxbuffer_ = tdxbuf;
-
-    if ( showlog ) std::cout<<"size of .tdx buffer (bytes): "<<tdxbuffer_.size()<<"\n\n";
-
-    // close .tdx file
-    fin.close();
-  } catch (const std::exception& e ) {
-    throw std::runtime_error( std::string("failed to open .tdx and stream data to buffer: ")
                               + e.what() );
   }
 }
@@ -131,12 +194,31 @@ void tdm_termite::process_include(bool showlog, pugi::xml_document& xml_doc)
 
   // check endianness
   std::string endianness(tdmincl.child("file").attribute("byteOrder").value());
-  endianness_ = endianness.compare("littleEndian") == 0 ? true : false;
+  // endianness_ = endianness.compare("littleEndian") == 0 ? true : false;
+  if ( endianness.compare("littleEndian") == 0 )
+  {
+    endianness_ = true;
+  }
+  else if ( endianness.compare("bigEndian") == 0 )
+  {
+    endianness_ = false;
+  }
+  else
+  {
+    throw std::runtime_error(std::string("unsupported endianness: ") + endianness);
+  }
 
   // obtain machine's endianness
-  int num = 1;
+  machine_endianness_ = this->detect_endianness();
-  machine_endianness_ = ( *(char*)&num == 1 );
+  // if ( machine_endianness_ != endianness_ )
-  if ( machine_endianness_ != endianness_ ) throw std::runtime_error("endianness mismatch");
+  // {
+  //   std::stringstream ss;
+  //   ss<<"endianness mismatch: "<<"TDM = "<<(endianness_?"little":"big")
+  //                              <<" , "
+  //                              <<"Arch = "<<(machine_endianness_?"little":"big");
+  //   // std::cout<<ss.str()<<"\n";
+  //   // throw std::runtime_error(ss.str());
+  // }
 
   // list block of massdata
   for (pugi::xml_node anode: tdmincl.child("file").children())
@@ -382,9 +464,14 @@ void tdm_termite::process_localcolumns(bool showlog, pugi::xml_document& xml_doc
     {
       locc.values_ = vl.at(0);
     }
+    else if ( vl.size() == 0 )
+    {
+      //std::cerr<<"localcolumn ("<<locc.id_<<","<<locc.name_<<") misses any value-ids"<<"\n";
+      locc.values_ = "none";
+    }
     else
     {
-      throw std::logic_error("localcolumn with out/multiple values id(s)");
+      throw std::logic_error("localcolumn with multiple values id(s)");
     }
 
     // add external id referring to block in <usi:include>
@@ -397,7 +484,7 @@ void tdm_termite::process_localcolumns(bool showlog, pugi::xml_document& xml_doc
       {
         throw std::runtime_error(std::string("measurement_quantity: ")
                                  + locc.measurement_quantity_
-                                 + std::string(" is ambiguous") );
+                                 + std::string(" is missing/ambiguous") );
       }
       std::string dt = tdmchannels_.at(locc.measurement_quantity_).datatype_;
       std::string sequence_type;
@@ -419,8 +506,10 @@ void tdm_termite::process_localcolumns(bool showlog, pugi::xml_document& xml_doc
 
       if ( locc.external_id_.empty() )
       {
-        throw std::logic_error( std::string("no external id found for ")
+        //throw std::logic_error( std::string("no external id found for ")
-                              + sequence_type + std::string(" with ") + locc.values_ );
+        //                      + sequence_type + std::string(" with ") + locc.values_ );
+        //std::cerr<<"no external id found for "<<sequence_type<<" with "<<locc.values_<<"\n";
+        locc.external_id_ = "none";
       }
     }
 
@@ -445,8 +534,8 @@ std::string tdm_termite::get_channel_overview(format chformatter)
 
   // compose header
   chformatter.set_header(true);
-  tdm_channelgroup grp;
+  //tdm_channelgroup grp;
-  channels_summary += grp.get_info(chformatter);
+  //channels_summary += grp.get_info(chformatter);
   tdm_channel chn;
   channels_summary += chn.get_info(chformatter);
   std::string rule; // = std::string("#");
@@ -463,8 +552,9 @@ std::string tdm_termite::get_channel_overview(format chformatter)
                                                    it!=tdmchannels_.end(); ++it)
   {
     // get corresponding group
-    tdm_channelgroup grp = tdmchannelgroups_.at(it->second.group_);
+    // tdm_channelgroup grp = tdmchannelgroups_.at(it->second.group_);
-    channels_summary += grp.get_info(chformatter);
+    // channels_summary += grp.get_info(chformatter);
+
     // ...and actual channel
     channels_summary += it->second.get_info(chformatter);
     channels_summary += std::string("\n");
@@ -505,7 +595,7 @@ template std::string tdm_termite::get_overview<submatrix>(format formatter);
 template std::string tdm_termite::get_overview<localcolumn>(format formatter);
 template std::string tdm_termite::get_overview<block>(format formatter);
 
-void tdm_termite::summarize_member(tdm_channelgroup chp, std::string& summary, format& formatter)
+void tdm_termite::summarize_member(tdm_channelgroup &chp, std::string& summary, format& formatter)
 {
   for ( std::map<std::string,tdm_channelgroup>::iterator it=this->tdmchannelgroups_.begin();
                                                          it!=this->tdmchannelgroups_.end(); ++it)
@@ -515,7 +605,7 @@ void tdm_termite::summarize_member(tdm_channelgroup chp, std::string& summary, f
   }
 }
 
-void tdm_termite::summarize_member(submatrix sbm, std::string& summary, format& formatter)
+void tdm_termite::summarize_member(submatrix &sbm, std::string& summary, format& formatter)
 {
   for ( std::map<std::string,submatrix>::iterator it=this->submatrices_.begin();
                                                   it!=this->submatrices_.end(); ++it)
@@ -525,7 +615,7 @@ void tdm_termite::summarize_member(submatrix sbm, std::string& summary, format&
   }
 }
 
-void tdm_termite::summarize_member(localcolumn lcc, std::string& summary, format& formatter)
+void tdm_termite::summarize_member(localcolumn &lcc, std::string& summary, format& formatter)
 {
   for ( std::map<std::string,localcolumn>::iterator it=this->localcolumns_.begin();
                                                     it!=this->localcolumns_.end(); ++it)
@@ -535,7 +625,7 @@ void tdm_termite::summarize_member(localcolumn lcc, std::string& summary, format
   }
 }
 
-void tdm_termite::summarize_member(block blk, std::string& summary, format& formatter)
+void tdm_termite::summarize_member(block &blk, std::string& summary, format& formatter)
 {
   for ( std::map<std::string,block>::iterator it=this->tdx_blocks_.begin();
                                               it!=this->tdx_blocks_.end(); ++it)
@@ -556,7 +646,7 @@ std::vector<tdmdatatype> tdm_termite::get_channel(std::string& id)
     // retrieve full channel info
     tdm_channel chn = tdmchannels_.at(id);
 
-    // extract (first) "localcolumn" for channel
+    // extract (first) "localcolumn" for channel TODO there should only be a single!! local_column!!
     if ( chn.local_columns_.size() != 1 )
     {
       throw std::runtime_error(std::string("invalid local_columns_ of channel: ") + id);
@@ -573,8 +663,28 @@ std::vector<tdmdatatype> tdm_termite::get_channel(std::string& id)
     }
 
     // use "values" id to map to external block
+    if ( loccol.external_id_ == "none" )
+    {
+      //throw std::runtime_error(std::string("missing external_id in local_column ")+loccol.id_);
+      //std::cerr<<"missing external_id in local_column "<<loccol.id_<<"\n";
+      return std::vector<tdmdatatype>(0);
+    }
     block blk = tdx_blocks_.at(loccol.external_id_);
 
+    // find corresponding submatrix
+    if ( submatrices_.count(loccol.submatrix_) != 1 )
+    {
+      throw std::runtime_error(std::string("no associated submatrix for localcolumn found: ") + loccol.id_);
+    }
+    submatrix subm = submatrices_.at(loccol.submatrix_);
+    if ( subm.number_of_rows_ != blk.length_ )
+    {
+      std::stringstream ss;
+      ss<<"number of rows in submatrix "<<subm.id_<<" ("<<subm.number_of_rows_<<") "
+        <<" does not agree with length of associated block "<<blk.id_<<" ("<<blk.length_<<")";
+      throw std::runtime_error(ss.str());
+    }
+
     // declare vector of appropriate length
     std::vector<tdmdatatype> datavec(blk.length_);
 
@@ -584,10 +694,20 @@ std::vector<tdmdatatype> tdm_termite::get_channel(std::string& id)
     // declare buffer covering the required range of "tdxbuffer_"
     // (consider both channel-wise and block-wise ordering)
     unsigned long int strtidx = blk.block_offset_*blk.block_size_
-                              + blk.byte_offset_,
+                              + blk.byte_offset_;
-                      fnshidx = strtidx + blk.length_*dtyp.size_;
+                      // fnshidx = strtidx + blk.length_*dtyp.size_;
-    std::vector<unsigned char> tdxblk( tdxbuffer_.begin()+strtidx,
+    // std::vector<unsigned char> tdxblk( tdxbuffer_.begin()+strtidx,
-                                       tdxbuffer_.begin()+fnshidx );
+    //                                    tdxbuffer_.begin()+fnshidx );
+    char* blkbuf = new char[blk.length_*dtyp.size_];
+    try {
+      tdx_ifstream_->seekg(strtidx);
+      tdx_ifstream_->read(blkbuf,blk.length_*dtyp.size_);
+    } catch (const std::exception& e) {
+      throw std::runtime_error( std::string("failed to read block from tdx_ifstream_: ")
+                                + e.what() );
+    }
+    std::vector<unsigned char> tdxblk(blkbuf,blkbuf+blk.length_*dtyp.size_);
+    delete []blkbuf;
 
     // distinguish numeric datatypes included in "tdmdatatype"
     if ( blk.value_type_ == std::string("eInt16Usi") )
@@ -618,6 +738,10 @@ std::vector<tdmdatatype> tdm_termite::get_channel(std::string& id)
     {
       this->convert_data_to_type<eFloat64Usi>(tdxblk,datavec);
     }
+    else if ( blk.value_type_ == std::string("eStringUsi") )
+    {
+      this->convert_data_to_type<eStringUsi>(tdxblk,datavec);
+    }
     else
     {
       throw std::runtime_error(std::string("unsupported/unknown datatype") + blk.value_type_);
@@ -779,7 +903,7 @@ void tdm_termite::print_group(std::string &id, const char* filename, bool includ
     for ( std::string chn: chngrp.channels_ )
     {
       std::vector<tdmdatatype> chndat = this->get_channel(chn);
-      if ( chndat.size() > maxrows ) maxrows = chndat.size();
+      if ( chndat.size() > maxrows ) maxrows = (unsigned int)chndat.size();
       allchns.push_back(chndat);
     }
 
@@ -844,7 +968,7 @@ void tdm_termite::check_filename_path(const char* filename)
 
   if ( !std::filesystem::is_directory(pt) )
   {
-    throw std::runtime_error(std::string("directory does not exist: ") + pt.c_str() );
+    throw std::runtime_error( std::string("directory does not exist: ") + pt.u8string() );
   }
 }
 
@@ -914,6 +1038,10 @@ void tdm_termite::check_datatype_consistency()
     {
       if ( el.size_ != sizeof(eFloat64Usi) ) throw std::logic_error("invalid representation of eFloat64Usi");
     }
+    else if ( el.name_ == "eStringUsi" )
+    {
+      if ( el.size_ != sizeof(eStringUsi) ) throw std::logic_error("invalid representation of eStringUsi");
+    }
     else
     {
       throw std::logic_error("missing datatype validation");
@@ -943,7 +1071,15 @@ void tdm_termite::convert_data_to_type(std::vector<unsigned char> &buffer,
 
     for ( unsigned long int j = 0; j < sizeof(datatype); j++ )
     {
-      dfcast[j] = (int)buffer[i*sizeof(datatype)+j];
+      // matching byte order between TDM/TDX and machine's architecture ?
+      if ( machine_endianness_ == endianness_ )
+      {
+        dfcast[j] = (int)buffer[i*sizeof(datatype)+j];
+      }
+      else
+      {
+        dfcast[j] = (int)buffer[(i+1)*sizeof(datatype)-(j+1)];
+      }
     }
 
     // save number in channel

lib/tdm_termite.hpp

@@ -60,8 +60,32 @@ class tdm_termite
   std::map<std::string,submatrix> submatrices_;
   std::map<std::string,localcolumn> localcolumns_;
 
-  // binary data container
+  // binary data container/file stream
   std::vector<unsigned char> tdxbuffer_;
+  std::ifstream *tdx_ifstream_;
+
+  // find machine's endianness at runtime
+  // detect machine endianness (C++20 !!)
+  // if ( std::endian::native == std::endian::little )
+  // {
+  //   machine_endianness_ = true;
+  // }
+  // else if ( std::endian::native == std::endian::big )
+  // {
+  //   machine_endianness_ = false;
+  // }
+  // else
+  // {
+  //   throw std::runtime_error("mixed endianness architecture is not supported");
+  // }
+  bool detect_endianness()
+  {
+    // int num = 1;
+    // machine_endianness_ = ( *(char*)&num == 1 );
+    std::uint32_t num = 0x11223344;
+    uint8_t* dfc = reinterpret_cast<uint8_t*>(&num);
+    return ( dfc[0] == 0x44 );
+  }
 
   // extract list of identifiers from e.g. "#xpointer(id("usi12") id("usi13"))"
   std::vector<std::string> extract_ids(std::string idstring)
@@ -121,6 +145,9 @@ public:
   tdm_termite();
   tdm_termite(std::string tdmfile, std::string tdxfile = std::string(""),
              bool showlog = false);
+  ~tdm_termite();
+  tdm_termite(const tdm_termite& other);
+  tdm_termite& operator=(const tdm_termite& other);
 
   // provide (tdm,tdx) files
   void submit_files(std::string tdmfile, std::string tdxfile = std::string(""),
@@ -180,10 +207,10 @@ public:
   template<typename tdmelement>
   std::string get_overview(format formatter);
 private:
-  void summarize_member(tdm_channelgroup chp, std::string& summary, format& formatter);
+  void summarize_member(tdm_channelgroup &chp, std::string& summary, format& formatter);
-  void summarize_member(submatrix sbm, std::string& summary, format& formatter);
+  void summarize_member(submatrix &sbm, std::string& summary, format& formatter);
-  void summarize_member(localcolumn lcc, std::string& summary, format& formatter);
+  void summarize_member(localcolumn &lcc, std::string& summary, format& formatter);
-  void summarize_member(block blk, std::string& summary, format& formatter);
+  void summarize_member(block &blk, std::string& summary, format& formatter);
 public:
 
   // get list of channelgroup ids

makefile

@@ -1,5 +1,7 @@
 # --------------------------------------------------------------------------- #
 
+SHELL := /bin/bash
+
 # declare name of executable
 EXE = tdmtermite
 
@@ -11,52 +13,96 @@ HPP = $(wildcard lib/*.hpp)
 CC = g++ -std=c++17
 
 # compiler options and optimization flags
-OPT = -O3 -Wall -Werror -Wunused-variable -Wsign-compare
+OPT = -O3 -Wall -Wconversion -Wpedantic -Wunused-variable -Wsign-compare
 
-# include library path
+# include 3rd party libraries paths
-LIB = pugixml/
+LIBB := 3rdparty/
+LIB := $(foreach dir,$(shell ls $(LIBB)),-I $(LIBB)$(dir))
 
 # determine git version/commit tag
-GTAG := $(shell git tag | tail -n1)
+GTAG := $(shell git tag -l --sort=version:refname | tail -n1 | sed "s/$^v//g")
 GHSH := $(shell git rev-parse HEAD | head -c8)
+GVSN := $(shell cat python/VERSION | tr -d ' \n')
+
+# current timestamp
+TMS = $(shell date +%Y%m%dT%H%M%S)
 
 # define install location
 INST := /usr/local/bin
 
-# platform
+# platform and current working directory
 OST := $(shell uname)
+CWD := $(shell pwd)
 
 # --------------------------------------------------------------------------- #
-# CLI tool
+# C++ and CLI tool
 
-$(EXE) : main.o $(SRC).o
+# check tags and build executable
+exec: check-tags $(GVSN) $(EXE)
+
+# build executable
+$(EXE): $(SRC).o main.o
 	$(CC) $(OPT) $^ -o $@
 
-install : $(EXE)
+$(SRC).o : lib/$(SRC).cpp lib/$(SRC).hpp $(HPP)
+	$(CC) -c $(OPT) $(LIB) $< -o $@
+
+# build main.cpp object file and include git version/commit tag
+main.o: src/main.cpp lib/$(SRC).hpp $(HPP)
+	@cp $< $<.cpp
+	@if [ $(OST) = "Linux" ]; then\
+		sed -i 's/TAGSTRING/$(GTAG)/g' $<.cpp; \
+		sed -i 's/HASHSTRING/$(GHSH)/g' $<.cpp; \
+		sed -i 's/TIMESTAMPSTRING/$(TMS)/g' $<.cpp; \
+	fi
+	@if [ $(OST) = "Darwin" ]; then\
+		sed -i '' 's/TAGSTRING/$(GTAG)/g' $<.cpp; \
+		sed -i '' 's/HASHSTRING/$(GHSH)/g' $<.cpp; \
+		sed -i '' 's/TIMESTAMPSTRING/$(TMS)/g' $<.cpp; \
+	fi
+	$(CC) -c $(OPT) $(LIB) -I lib/ $<.cpp -o $@
+	@rm $<.cpp
+
+install: $(EXE)
 	cp $< $(INST)/
 
 uninstall : $(INST)/$(EXE)
 	rm $<
 
-# build main.cpp object file and include git version/commit tag
+tdmtest : tdmtest.o
-main.o : src/main.cpp lib/$(SRC).hpp $(HPP)
+	$(CC) $(OPT) $^ -o $@
-	@cp $< $<.cpp
-	@if [ $(OST) = "Linux" ]; then\
-		sed -i 's/TAGSTRING/$(GTAG)/g' $<.cpp; \
-		sed -i 's/HASHSTRING/$(GHSH)/g' $<.cpp; \
-	fi
-	@if [ $(OST) = "Darwin" ]; then\
-		sed -i '' 's/TAGSTRING/$(GTAG)/g' $<.cpp; \
-		sed -i '' 's/HASHSTRING/$(GHSH)/g' $<.cpp; \
-	fi
-	$(CC) -c $(OPT) -I $(LIB) -I lib/ $<.cpp -o $@
-	@rm $<.cpp
 
-$(SRC).o : lib/$(SRC).cpp lib/$(SRC).hpp $(HPP)
+tdmtest.o : src/test.cpp lib/$(SRC).hpp $(HPP)
-	$(CC) -c $(OPT) -I $(LIB) $< -o $@
+	$(CC) -c $(OPT) $(LIB) -I lib/ $< -o $@
 
-clean-cpp :
+cpp-clean :
-	rm -f $(EXE) *.o src/main.cpp.cpp
+	rm -vf $(EXE)
+	rm -vf *.o src/main.cpp.cpp tdmtest
+
+#-----------------------------------------------------------------------------#
+# versions
+
+$(GTAG):
+	@echo "consistent versions check successful: building $(GTAG)"
+
+check-tags:
+	@echo "latest git tag:  $(GTAG)"
+	@echo "latest git hash: $(GHSH)"
+	@echo "python version:  $(GVSN)"
+
+# --------------------------------------------------------------------------- #
+# docker
+
+docker-build:
+	docker build . --tag tdmtermite:latest
+
+docker-run:
+	mkdir -pv data/{input,output}
+	docker run -it --rm --volume $(CWD)/data:/home/data tdmtermite:latest /bin/bash
+
+docker-clean:
+	rm -rv data
+	docker image remove tdmtermite
 
 # --------------------------------------------------------------------------- #
 # check process
@@ -66,31 +112,25 @@ checkps :
 	@ps aux | grep $(EXE) | grep -v "grep"
 
 # --------------------------------------------------------------------------- #
-# python/cython module
+# python
 
-cython-requirements: cython/requirements.txt
+python-build: check-tags $(GVSN)
-	python3 -m pip install -r $<
+	make -C python/ build-inplace
+	cp python/TDMtermite*.so ./ -v
 
-cython-help : cython/setup.py
+python-install: check-tags $(GVSN)
-	python3 $< --help
+	make -C python/ install
 
-cython-list : cython/setup.py
+python-clean:
-	python3 $< --name --description --author --author-email --url
+	make -C python/ clean
+	rm -vf TDMtermite*.so
 
-cython-build : cython/setup.py cython/tdm_termite.pxd cython/py_tdm_termite.pyx $(HPP) lib/tdm_termite.cpp
+python-test:
-	python3 $< build_ext --inplace
+	PYTHONPATH=./ python python/examples/usage.py
-	cp -v tdm_termite.cpython-*.so python/
-
-cython-install : cython/setup.py cython/tdm_termite.pxd cython/py_tdm_termite.pyx $(HPP) lib/tdm_termite.cpp
-	python3 $< install
-
-clean-cython :
-	rm -vf cython/py_tdm_termite.cpp
-	rm -vf tdm_termite.cpython-*.so python/tdm_termite.cpython-*.so
-	rm -rf build
 
 # --------------------------------------------------------------------------- #
+# clean
 
-clean : clean-cpp clean-cython
+clean : cpp-clean python-clean
 
 # --------------------------------------------------------------------------- #

python/MANIFEST.in

@@ -0,0 +1,4 @@
+include lib/*.hpp
+include *.cpp
+include *.pyx
+include *.pxd

python/VERSION

@@ -0,0 +1 @@
+2.1.3

python/examples/custom.py

@@ -1,11 +1,11 @@
 
-import tdm_termite
+import tdmtermite
 import json
 import re
 
 # create 'tdm_termite' instance object
 try :
-    jack = tdm_termite.tdmtermite(b'samples/SineData.tdm',b'samples/SineData.tdx')
+    jack = tdmtermite.tdmtermite(b'samples/SineData.tdm',b'samples/SineData.tdx')
 except RuntimeError as e :
     print("failed to load/decode TDM files: " + str(e))
 

python/examples/minimal.py

@@ -1,9 +1,9 @@
 
-import tdm_termite
+import tdmtermite
 
 # create 'tdm_termite' instance object
 try :
-    jack = tdm_termite.tdmtermite(b'samples/SineData.tdm',b'samples/SineData.tdx')
+    jack = tdmtermite.tdmtermite(b'samples/SineData.tdm',b'samples/SineData.tdx')
     # list ids of channelgroups
     grpids = jack.get_channelgroup_ids()
     # iterate through groups

python/examples/usage.py

@@ -1,12 +1,12 @@
 
-import tdm_termite
+import tdmtermite
 # import numpy as np
 import json
 import re
 
 # create 'tdm_termite' instance object
 try :
-    jack = tdm_termite.tdmtermite(b'samples/SineData.tdm',b'samples/SineData.tdx')
+    jack = tdmtermite.tdmtermite(b'samples/SineData.tdm',b'samples/SineData.tdx')
 except RuntimeError as e :
     print("failed to load/decode TDM files: " + str(e))
 

python/makefile

@@ -0,0 +1,60 @@
+
+setup:
+	cat ../README.md | grep '^# TDMtermite' -A 50000 > ./README.md
+	#pandoc -f markdown -t rst -o README.rst README.md
+	#python -m rstvalidator README.rst
+	cp -r ../lib ./
+	cp -r ../3rdparty ./
+	cp -v ../LICENSE ./
+
+setup-clean:
+	rm -vf README.md README.rst LICENSE
+	rm -rf lib/ 3rdparty/
+
+build: setup
+	python setup.py build
+
+build-inplace: setup
+	python setup.py build_ext --inplace
+
+build-install: setup
+	python setup.py install
+
+build-sdist: setup
+	python setup.py sdist
+	python -m twine check dist/*
+
+build-bdist: setup
+	python setup.py bdist
+	python -m twine check dist/*
+
+build-clean:
+	python setup.py clean --all
+	rm -vf tdmtermite*.so tdmtermite*.cpp
+	rm -rvf dist/ tdmtermite.egg-info/
+
+cibuildwheel-build: setup
+	cibuildwheel --platform linux
+
+cibuildwheel-clean:
+	rm -rvf wheelhouse/
+
+pypi-audit:
+	auditwheel repair $(shell find dist/ -name "*-linux_x86_64.whl")
+
+# username: __token__
+# password: API-token including "pypi-"
+pypi-upload-test:
+	python -m twine upload --repository testpypi dist/$(shell ls -t dist/ | head -n1)
+
+pypi-install-test:
+	python -m pip install --index-url https://test.pypi.org/simple --no-deps TDMtermite-RecordEvolution
+	# python3 -m pip install -i https://test.pypi.org/simple/ TDMtermite-RecordEvolution==0.5
+
+pypi-upload:
+	python -m twine upload dist/$(shell ls -t dist/ | head -n1)
+
+clean: setup build-clean cibuildwheel-clean setup-clean
+
+run-example:
+	PYTHONPATH=$(pwd) python examples/usage.py

python/pyproject.toml

@@ -0,0 +1,6 @@
+[build-system]
+requires = ["setuptools", "wheel","Cython"]
+build-backend = "setuptools.build_meta"
+
+[tool.cibuildwheel]
+before-all = ""

python/setup.cfg

@@ -0,0 +1,23 @@
+
+[metadata]
+name = tdmtermite
+description = Extract and read data from National Instruments LabVIEW tdx/tdm files and export them as csv files
+long_description = file: README.md
+# long_description_content_type = text/x-rst
+long_description_content_type = text/markdown
+version = file: VERSION
+author = Record Evolution GmbH
+author_email = mario.fink@record-evolution.de
+maintainer = Record Evolution GmbH
+url= https://github.com/RecordEvolution/TDMtermite.git
+license = MIT License
+license_files = LICENSE
+keywords = TDM, TDX, National Instruments, DIAdem, LabVIEW, Measurement Studio, SignalExpress
+classifiers =
+  Programming Language :: Python :: 3
+  License :: OSI Approved :: MIT License
+  Operating System :: OS Independent
+  Topic :: Scientific/Engineering
+  Topic :: Software Development :: Libraries :: Python Modules
+
+[options]

python/setup.py

@@ -0,0 +1,23 @@
+from setuptools import Extension, setup
+from Cython.Build import cythonize
+import sys
+
+print("building on platform: "+sys.platform)
+
+cmpArgs = {
+    "linux": ['-std=c++17','-Wno-unused-variable'],
+    "darwin": ['-std=c++17','-Wno-unused-variable'],
+    "win32": ['/EHsc','/std:c++17']
+}
+
+extension = Extension(
+    "tdmtermite",
+    language='c++',
+    sources=["tdmtermite.pyx"],
+    include_dirs=["lib","3rdparty/pugixml"],
+    extra_compile_args=cmpArgs[sys.platform]
+)
+
+setup(
+    ext_modules=cythonize(extension,language_level=3)
+)

python/tdmtermite.pxd

@@ -1,28 +1,34 @@
-# cython: language_level = 3
 
 # use some C++ STL libraries
 from libcpp.string cimport string
 from libcpp.vector cimport vector
 from libcpp cimport bool
 
-cdef extern from "tdm_termite.cpp":
+cdef extern from "lib/tdm_termite.cpp":
   pass
 
-cdef extern from "tdm_termite.hpp":
+cdef extern from "lib/tdm_termite.hpp":
-  cdef cppclass tdm_termite:
+
+  cdef cppclass cpptdmtermite "tdm_termite":
+
     # constructor(s)
-    tdm_termite() except +
+    cpptdmtermite() except +
-    tdm_termite(string tdmfile, string tdxfile) except +
+    cpptdmtermite(string tdmfile, string tdxfile) except +
+
     # provide TDM files
     void submit_files(string tdmfile, string tdxfile) except+
+
     # get list of channel(-group) ids
     vector[string] get_channelgroup_ids() except+
     vector[string] get_channel_ids() except+
+
     # get data of specific channel
     vector[double] get_channel_as_double(string id) except+
+
     # get meta-data
     string get_channelgroup_info(string id) except+
     string get_channel_info(string id) except+
+
     # print a channel(-group)
     void print_group(string id, const char* filename, bool include_meta,
                      char delimiter, string column_header) except+

python/tdmtermite.pyx

@@ -1,51 +1,52 @@
 # distutils: language = c++
+# cython: language_level = 3
+
+from tdmtermite cimport cpptdmtermite
 
-from tdm_termite cimport tdm_termite
 import json as jn
-# import numpy as np
 
 cdef class tdmtermite:
 
   # C++ instance of class => stack allocated (requires nullary constructor!)
-  cdef tdm_termite cpp_tdm
+  cdef cpptdmtermite cpptdm
 
   # constructor
   def __cinit__(self, string tdmfile, string tdxfile):
-    self.cpp_tdm = tdm_termite(tdmfile,tdxfile)
+    self.cpptdm = cpptdmtermite(tdmfile,tdxfile)
 
   # provide TDM files
   def submit_files(self,string tdmfile, string tdxfile):
-    self.cpp_tdm.submit_files(tdmfile,tdxfile)
+    self.cpptdm.submit_files(tdmfile,tdxfile)
 
   # get list of channel(-group) ids
   def get_channelgroup_ids(self):
-    return self.cpp_tdm.get_channelgroup_ids()
+    return self.cpptdm.get_channelgroup_ids()
   def get_channel_ids(self):
-    return self.cpp_tdm.get_channel_ids()
+    return self.cpptdm.get_channel_ids()
 
   # get data of specific channel
   def get_channel(self, string id):
-    return self.cpp_tdm.get_channel_as_double(id)
+    return self.cpptdm.get_channel_as_double(id)
 
   # get meta-data of channel(-group) (as dictionary)
   def get_channelgroup_info(self, string id):
-    grpstr = self.cpp_tdm.get_channelgroup_info(id)
+    grpstr = self.cpptdm.get_channelgroup_info(id)
     return jn.loads(grpstr.decode())
   def get_channel_info(self, string id):
-    chnstr = self.cpp_tdm.get_channel_info(id)
+    chnstr = self.cpptdm.get_channel_info(id)
     return jn.loads(chnstr.decode())
 
   # print a channel(-group)
   def print_channelgroup(self, string id, const char* filename, bool include_meta,
                                char delimiter, string column_header):
-    self.cpp_tdm.print_group(id,filename,include_meta,delimiter,column_header)
+    self.cpptdm.print_group(id,filename,include_meta,delimiter,column_header)
   def print_channel(self, string id, const char* filename,
                           bool include_meta):
-    self.cpp_tdm.print_channel(id,filename,include_meta)
+    self.cpptdm.print_channel(id,filename,include_meta)
 
   # print all data grouped by channelgroups
   def write_all(self, string outputdir) :
-    grpids = self.cpp_tdm.get_channelgroup_ids()
+    grpids = self.cpptdm.get_channelgroup_ids()
     for id in grpids :
       grpfile = outputdir.decode() + "/channelgroup_" + id.decode() + ".csv"
-      self.cpp_tdm.print_group(id,grpfile.encode(),True,ord(','),"".encode())
+      self.cpptdm.print_group(id,grpfile.encode(),True,ord(','),"".encode())

samples/SineData-be.tdm

@@ -0,0 +1,369 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
+<usi:tdm xmlns:usi="http://www.ni.com/Schemas/USI/1_0" version="1.0">
+
+  <usi:documentation>
+    <usi:exporter>National Instruments USI</usi:exporter>
+    <usi:exporterVersion>1.5</usi:exporterVersion>
+  </usi:documentation>
+
+  <usi:model modelName="National Instruments USI generated meta file" modelVersion="1.0">
+    <usi:include nsUri="http://www.ni.com/DataModels/USI/TDM/1_0"/>
+  </usi:model>
+
+  <usi:include>
+    <file byteOrder="bigEndian" url="SineData-be.tdx">
+      <block byteOffset="0" id="inc0" length="1000" valueType="eFloat64Usi"/>
+      <block byteOffset="8000" id="inc1" length="1000" valueType="eFloat64Usi"/>
+      <block byteOffset="16000" id="inc2" length="1000" valueType="eFloat64Usi"/>
+      <block byteOffset="24000" id="inc3" length="1000" valueType="eFloat64Usi"/>
+      <block byteOffset="32000" id="inc4" length="1000" valueType="eFloat64Usi"/>
+      <block byteOffset="40000" id="inc5" length="1000" valueType="eFloat64Usi"/>
+      <block byteOffset="48000" id="inc6" length="1000" valueType="eFloat64Usi"/>
+      <block byteOffset="56000" id="inc7" length="1000" valueType="eFloat64Usi"/>
+      <block byteOffset="64000" id="inc8" length="1000" valueType="eFloat64Usi"/>
+      <block byteOffset="72000" id="inc9" length="1000" valueType="eFloat64Usi"/>
+    </file>
+  </usi:include>
+
+  <usi:data>
+    <double_sequence id="usi1">
+      <values external="inc0"/>
+    </double_sequence>
+    <double_sequence id="usi2">
+      <values external="inc1"/>
+    </double_sequence>
+    <double_sequence id="usi3">
+      <values external="inc2"/>
+    </double_sequence>
+    <double_sequence id="usi4">
+      <values external="inc3"/>
+    </double_sequence>
+    <double_sequence id="usi5">
+      <values external="inc4"/>
+    </double_sequence>
+    <double_sequence id="usi6">
+      <values external="inc5"/>
+    </double_sequence>
+    <double_sequence id="usi7">
+      <values external="inc6"/>
+    </double_sequence>
+    <double_sequence id="usi8">
+      <values external="inc7"/>
+    </double_sequence>
+    <double_sequence id="usi9">
+      <values external="inc8"/>
+    </double_sequence>
+    <double_sequence id="usi10">
+      <values external="inc9"/>
+    </double_sequence>
+    <tdm_root id="usi11">
+      <name>SineData.TDM</name>
+      <description>Sine signals of various amplitudes and frequencies.</description>
+      <title>SineData</title>
+      <author>National Instruments</author>
+      <datetime>2008-05-06T17:20:12.65074539184570313</datetime>
+      <channelgroups>#xpointer(id("usi12") id("usi13"))</channelgroups>
+    </tdm_root>
+    <tdm_channelgroup id="usi12">
+      <name>Amplitudes</name>
+      <description>Sine Signals of various amplitudes.</description>
+      <root>#xpointer(id("usi11"))</root>
+      <instance_attributes>
+        <double_attribute name="Frequency">1</double_attribute>
+      </instance_attributes>
+      <channels>#xpointer(id("usi14") id("usi15") id("usi16") id("usi17") id("usi18"))</channels>
+      <submatrices>#xpointer(id("usi24") id("usi25") id("usi26") id("usi27") id("usi28"))</submatrices>
+    </tdm_channelgroup>
+    <tdm_channelgroup id="usi13">
+      <name>Frequencies</name>
+      <description>Sine signals of various frequencies.</description>
+      <root>#xpointer(id("usi11"))</root>
+      <instance_attributes>
+        <double_attribute name="Amplitude">1</double_attribute>
+      </instance_attributes>
+      <channels>#xpointer(id("usi19") id("usi20") id("usi21") id("usi22") id("usi23"))</channels>
+      <submatrices>#xpointer(id("usi29") id("usi30") id("usi31") id("usi32") id("usi33"))</submatrices>
+    </tdm_channelgroup>
+    <tdm_channel id="usi14">
+      <name>A = 1</name>
+      <group>#xpointer(id("usi12"))</group>
+      <datatype>DT_DOUBLE</datatype>
+      <minimum>-0.999997146387718</minimum>
+      <maximum>0.999999682931835</maximum>
+      <instance_attributes>
+        <long_attribute name="NI_ArrayColumn">0</long_attribute>
+        <long_attribute name="NI_ChannelLength">1000</long_attribute>
+        <long_attribute name="NI_DataType">10</long_attribute>
+      </instance_attributes>
+      <local_columns>#xpointer(id("usi34"))</local_columns>
+    </tdm_channel>
+    <tdm_channel id="usi15">
+      <name>A = 2</name>
+      <group>#xpointer(id("usi12"))</group>
+      <datatype>DT_DOUBLE</datatype>
+      <minimum>-1.99999429277544</minimum>
+      <maximum>1.99999936586367</maximum>
+      <instance_attributes>
+        <long_attribute name="NI_ArrayColumn">1</long_attribute>
+        <long_attribute name="NI_ChannelLength">1000</long_attribute>
+        <long_attribute name="NI_DataType">10</long_attribute>
+      </instance_attributes>
+      <local_columns>#xpointer(id("usi35"))</local_columns>
+    </tdm_channel>
+    <tdm_channel id="usi16">
+      <name>A = 4</name>
+      <group>#xpointer(id("usi12"))</group>
+      <datatype>DT_DOUBLE</datatype>
+      <minimum>-3.99998858555087</minimum>
+      <maximum>3.99999873172734</maximum>
+      <instance_attributes>
+        <long_attribute name="NI_ArrayColumn">2</long_attribute>
+        <long_attribute name="NI_ChannelLength">1000</long_attribute>
+        <long_attribute name="NI_DataType">10</long_attribute>
+      </instance_attributes>
+      <local_columns>#xpointer(id("usi36"))</local_columns>
+    </tdm_channel>
+    <tdm_channel id="usi17">
+      <name>A = 8</name>
+      <group>#xpointer(id("usi12"))</group>
+      <datatype>DT_DOUBLE</datatype>
+      <minimum>-7.99997717110174</minimum>
+      <maximum>7.99999746345468</maximum>
+      <instance_attributes>
+        <long_attribute name="NI_ArrayColumn">3</long_attribute>
+        <long_attribute name="NI_ChannelLength">1000</long_attribute>
+        <long_attribute name="NI_DataType">10</long_attribute>
+      </instance_attributes>
+      <local_columns>#xpointer(id("usi37"))</local_columns>
+    </tdm_channel>
+    <tdm_channel id="usi18">
+      <name>A = 16</name>
+      <group>#xpointer(id("usi12"))</group>
+      <datatype>DT_DOUBLE</datatype>
+      <minimum>-15.9999543422035</minimum>
+      <maximum>15.9999949269094</maximum>
+      <instance_attributes>
+        <long_attribute name="NI_ArrayColumn">4</long_attribute>
+        <long_attribute name="NI_ChannelLength">1000</long_attribute>
+        <long_attribute name="NI_DataType">10</long_attribute>
+      </instance_attributes>
+      <local_columns>#xpointer(id("usi38"))</local_columns>
+    </tdm_channel>
+    <tdm_channel id="usi19">
+      <name>F = 1</name>
+      <group>#xpointer(id("usi13"))</group>
+      <datatype>DT_DOUBLE</datatype>
+      <minimum>-0.999997146387718</minimum>
+      <maximum>0.999999682931835</maximum>
+      <instance_attributes>
+        <long_attribute name="NI_ArrayColumn">0</long_attribute>
+        <long_attribute name="NI_ChannelLength">1000</long_attribute>
+        <long_attribute name="NI_DataType">10</long_attribute>
+      </instance_attributes>
+      <local_columns>#xpointer(id("usi39"))</local_columns>
+    </tdm_channel>
+    <tdm_channel id="usi20">
+      <name>F = 2</name>
+      <group>#xpointer(id("usi13"))</group>
+      <datatype>DT_DOUBLE</datatype>
+      <minimum>-0.999999230697499</minimum>
+      <maximum>0.999995986891472</maximum>
+      <instance_attributes>
+        <long_attribute name="NI_ArrayColumn">1</long_attribute>
+        <long_attribute name="NI_ChannelLength">1000</long_attribute>
+        <long_attribute name="NI_DataType">10</long_attribute>
+      </instance_attributes>
+      <local_columns>#xpointer(id("usi40"))</local_columns>
+    </tdm_channel>
+    <tdm_channel id="usi21">
+      <name>F = 4</name>
+      <group>#xpointer(id("usi13"))</group>
+      <datatype>DT_DOUBLE</datatype>
+      <minimum>-0.999999230697499</minimum>
+      <maximum>0.99994907791452</maximum>
+      <instance_attributes>
+        <long_attribute name="NI_ArrayColumn">2</long_attribute>
+        <long_attribute name="NI_ChannelLength">1000</long_attribute>
+        <long_attribute name="NI_DataType">10</long_attribute>
+      </instance_attributes>
+      <local_columns>#xpointer(id("usi41"))</local_columns>
+    </tdm_channel>
+    <tdm_channel id="usi22">
+      <name>F = 8</name>
+      <group>#xpointer(id("usi13"))</group>
+      <datatype>DT_DOUBLE</datatype>
+      <minimum>-0.999999230697499</minimum>
+      <maximum>0.999996490345607</maximum>
+      <instance_attributes>
+        <long_attribute name="NI_ArrayColumn">3</long_attribute>
+        <long_attribute name="NI_ChannelLength">1000</long_attribute>
+        <long_attribute name="NI_DataType">10</long_attribute>
+      </instance_attributes>
+      <local_columns>#xpointer(id("usi42"))</local_columns>
+    </tdm_channel>
+    <tdm_channel id="usi23">
+      <name>F = 16</name>
+      <group>#xpointer(id("usi13"))</group>
+      <datatype>DT_DOUBLE</datatype>
+      <minimum>-0.999999230697499</minimum>
+      <maximum>0.999993076284592</maximum>
+      <instance_attributes>
+        <long_attribute name="NI_ArrayColumn">4</long_attribute>
+        <long_attribute name="NI_ChannelLength">1000</long_attribute>
+        <long_attribute name="NI_DataType">10</long_attribute>
+      </instance_attributes>
+      <local_columns>#xpointer(id("usi43"))</local_columns>
+    </tdm_channel>
+    <submatrix id="usi24">
+      <name>Untitled</name>
+      <measurement>#xpointer(id("usi12"))</measurement>
+      <number_of_rows>1000</number_of_rows>
+      <local_columns>#xpointer(id("usi34"))</local_columns>
+    </submatrix>
+    <submatrix id="usi25">
+      <name>Untitled</name>
+      <measurement>#xpointer(id("usi12"))</measurement>
+      <number_of_rows>1000</number_of_rows>
+      <local_columns>#xpointer(id("usi35"))</local_columns>
+    </submatrix>
+    <submatrix id="usi26">
+      <name>Untitled</name>
+      <measurement>#xpointer(id("usi12"))</measurement>
+      <number_of_rows>1000</number_of_rows>
+      <local_columns>#xpointer(id("usi36"))</local_columns>
+    </submatrix>
+    <submatrix id="usi27">
+      <name>Untitled</name>
+      <measurement>#xpointer(id("usi12"))</measurement>
+      <number_of_rows>1000</number_of_rows>
+      <local_columns>#xpointer(id("usi37"))</local_columns>
+    </submatrix>
+    <submatrix id="usi28">
+      <name>Untitled</name>
+      <measurement>#xpointer(id("usi12"))</measurement>
+      <number_of_rows>1000</number_of_rows>
+      <local_columns>#xpointer(id("usi38"))</local_columns>
+    </submatrix>
+    <submatrix id="usi29">
+      <name>Untitled</name>
+      <measurement>#xpointer(id("usi13"))</measurement>
+      <number_of_rows>1000</number_of_rows>
+      <local_columns>#xpointer(id("usi39"))</local_columns>
+    </submatrix>
+    <submatrix id="usi30">
+      <name>Untitled</name>
+      <measurement>#xpointer(id("usi13"))</measurement>
+      <number_of_rows>1000</number_of_rows>
+      <local_columns>#xpointer(id("usi40"))</local_columns>
+    </submatrix>
+    <submatrix id="usi31">
+      <name>Untitled</name>
+      <measurement>#xpointer(id("usi13"))</measurement>
+      <number_of_rows>1000</number_of_rows>
+      <local_columns>#xpointer(id("usi41"))</local_columns>
+    </submatrix>
+    <submatrix id="usi32">
+      <name>Untitled</name>
+      <measurement>#xpointer(id("usi13"))</measurement>
+      <number_of_rows>1000</number_of_rows>
+      <local_columns>#xpointer(id("usi42"))</local_columns>
+    </submatrix>
+    <submatrix id="usi33">
+      <name>Untitled</name>
+      <measurement>#xpointer(id("usi13"))</measurement>
+      <number_of_rows>1000</number_of_rows>
+      <local_columns>#xpointer(id("usi43"))</local_columns>
+    </submatrix>
+    <localcolumn id="usi34">
+      <name>Untitled</name>
+      <measurement_quantity>#xpointer(id("usi14"))</measurement_quantity>
+      <submatrix>#xpointer(id("usi24"))</submatrix>
+      <global_flag>15</global_flag>
+      <independent>0</independent>
+      <sequence_representation>explicit</sequence_representation>
+      <values>#xpointer(id("usi1"))</values>
+    </localcolumn>
+    <localcolumn id="usi35">
+      <name>Untitled</name>
+      <measurement_quantity>#xpointer(id("usi15"))</measurement_quantity>
+      <submatrix>#xpointer(id("usi25"))</submatrix>
+      <global_flag>15</global_flag>
+      <independent>0</independent>
+      <sequence_representation>explicit</sequence_representation>
+      <values>#xpointer(id("usi2"))</values>
+    </localcolumn>
+    <localcolumn id="usi36">
+      <name>Untitled</name>
+      <measurement_quantity>#xpointer(id("usi16"))</measurement_quantity>
+      <submatrix>#xpointer(id("usi26"))</submatrix>
+      <global_flag>15</global_flag>
+      <independent>0</independent>
+      <sequence_representation>explicit</sequence_representation>
+      <values>#xpointer(id("usi3"))</values>
+    </localcolumn>
+    <localcolumn id="usi37">
+      <name>Untitled</name>
+      <measurement_quantity>#xpointer(id("usi17"))</measurement_quantity>
+      <submatrix>#xpointer(id("usi27"))</submatrix>
+      <global_flag>15</global_flag>
+      <independent>0</independent>
+      <sequence_representation>explicit</sequence_representation>
+      <values>#xpointer(id("usi4"))</values>
+    </localcolumn>
+    <localcolumn id="usi38">
+      <name>Untitled</name>
+      <measurement_quantity>#xpointer(id("usi18"))</measurement_quantity>
+      <submatrix>#xpointer(id("usi28"))</submatrix>
+      <global_flag>15</global_flag>
+      <independent>0</independent>
+      <sequence_representation>explicit</sequence_representation>
+      <values>#xpointer(id("usi5"))</values>
+    </localcolumn>
+    <localcolumn id="usi39">
+      <name>Untitled</name>
+      <measurement_quantity>#xpointer(id("usi19"))</measurement_quantity>
+      <submatrix>#xpointer(id("usi29"))</submatrix>
+      <global_flag>15</global_flag>
+      <independent>0</independent>
+      <sequence_representation>explicit</sequence_representation>
+      <values>#xpointer(id("usi6"))</values>
+    </localcolumn>
+    <localcolumn id="usi40">
+      <name>Untitled</name>
+      <measurement_quantity>#xpointer(id("usi20"))</measurement_quantity>
+      <submatrix>#xpointer(id("usi30"))</submatrix>
+      <global_flag>15</global_flag>
+      <independent>0</independent>
+      <sequence_representation>explicit</sequence_representation>
+      <values>#xpointer(id("usi7"))</values>
+    </localcolumn>
+    <localcolumn id="usi41">
+      <name>Untitled</name>
+      <measurement_quantity>#xpointer(id("usi21"))</measurement_quantity>
+      <submatrix>#xpointer(id("usi31"))</submatrix>
+      <global_flag>15</global_flag>
+      <independent>0</independent>
+      <sequence_representation>explicit</sequence_representation>
+      <values>#xpointer(id("usi8"))</values>
+    </localcolumn>
+    <localcolumn id="usi42">
+      <name>Untitled</name>
+      <measurement_quantity>#xpointer(id("usi22"))</measurement_quantity>
+      <submatrix>#xpointer(id("usi32"))</submatrix>
+      <global_flag>15</global_flag>
+      <independent>0</independent>
+      <sequence_representation>explicit</sequence_representation>
+      <values>#xpointer(id("usi9"))</values>
+    </localcolumn>
+    <localcolumn id="usi43">
+      <name>Untitled</name>
+      <measurement_quantity>#xpointer(id("usi23"))</measurement_quantity>
+      <submatrix>#xpointer(id("usi33"))</submatrix>
+      <global_flag>15</global_flag>
+      <independent>0</independent>
+      <sequence_representation>explicit</sequence_representation>
+      <values>#xpointer(id("usi10"))</values>
+    </localcolumn>
+  </usi:data>
+
+</usi:tdm>

samples/swapbyteorder.cpp

@@ -0,0 +1,63 @@
+
+#include <iostream>
+#include <fstream>
+#include <iterator>
+#include <vector>
+
+int main(int argc, char* argv[])
+{
+  for ( int i = 0; i < argc; i++ )
+  {
+    std::cout<<argv[i]<<"\n";
+  }
+  if ( argc < 3 )
+  {
+    std::cout<<"missing file argument\n";
+    return 1;
+  }
+
+  std::ifstream fin(argv[1],std::ifstream::binary);
+
+  std::vector<unsigned char> tdxbuf((std::istreambuf_iterator<char>(fin)),
+                                    (std::istreambuf_iterator<char>()));
+
+  fin.close();
+
+  std::cout<<"length of buffer: "<<tdxbuf.size()<<"\n";
+                                      
+
+  unsigned long int dtsize = 8;
+
+  if ( tdxbuf.size()%dtsize != 0 )
+  {
+    std::cout<<"mismatch between datatype size and length of buffer\n";
+    return 1;
+  }
+  
+
+  unsigned long int nums = tdxbuf.size()/dtsize;
+  
+  std::cout<<"number of entities: "<<nums<<"\n";
+
+  std::vector<unsigned char> tdxbufrev(tdxbuf.size());
+
+  for ( unsigned long int i = 0; i < nums; i++ )
+  {
+    for ( unsigned long int j = 0; j < dtsize; j++ )
+    {
+      tdxbufrev[i*dtsize+j] = tdxbuf[(i+1)*dtsize-(j+1)];
+    }
+  }
+
+  std::ofstream fou(argv[2],std::ifstream::binary);
+
+  for ( unsigned char ch: tdxbufrev)
+  {
+    fou<<ch;
+  }
+
+  fou.close();
+
+  return 0;
+}
+

src/main.cpp

@@ -11,11 +11,12 @@
 
 const std::string gittag("TAGSTRING");
 const std::string githash("HASHSTRING");
+const std::string timestamp("TIMESTAMPSTRING");
 
 void show_usage()
 {
   std::cout<<"\n"
-           <<"tdmtermite ["<<gittag<<"-g"<<githash<<"] (github.com/RecordEvolution/TDMtermite.git)"
+           <<"tdmtermite ["<<gittag<<"-g"<<githash<<"-"<<timestamp<<"] (https://github.com/RecordEvolution/TDMtermite.git)"
            <<"\n\n"
            <<"Decode TDM/TDX files and dump data as *.csv"
            <<"\n\n"
@@ -78,7 +79,7 @@ optkeys parse_args(int argc, char* argv[], bool showargs = false)
     else if ( std::string(argv[1]) == std::string("--version")
            || std::string(argv[1]) == std::string("-v") )
     {
-      std::cout<<"tdmtermite "<<gittag<<"-g"<<githash<<"\n";
+      std::cout<<"tdmtermite "<<gittag<<"-g"<<githash<<"-"<<timestamp<<"\n";
     }
     else
     {
@@ -284,13 +285,13 @@ int main(int argc, char* argv[])
     if ( showroot ) std::cout<<"\n"<<jack.get_root().get_info()<<"\n";
 
     // get complete channel(-group) overview
-    format grpformatter(26,false,false,' ');
+    format grpformatter(16,false,false,' ');
     if (listgroups) std::cout<<"\n"<<jack.get_overview<tdm_channelgroup>(grpformatter)<<"\n";
-    format chformatter(14,false,false,' ');
+    format chformatter(16,false,false,' ');
     if (listchannels) std::cout<<"\n"<<jack.get_channel_overview(chformatter)<<"\n";
 
     // get complete submatrix/localcolumns overview
-    format formatter(18,false,false,' ');
+    format formatter(16,false,false,' ');
     if (listblocks) std::cout<<jack.get_overview<block>(formatter)<<"\n";
     if (listsubmatrices) std::cout<<jack.get_overview<submatrix>(formatter)<<"\n";
     if (listlocalcolumns) std::cout<<jack.get_overview<localcolumn>(formatter)<<"\n";

src/test.cpp

@@ -0,0 +1,33 @@
+// ------------------------------------------------------------------------- //
+
+#include "tdm_termite.hpp"
+
+#include <filesystem>
+#include <regex>
+#include <thread>
+#include <chrono>
+
+// ------------------------------------------------------------------------- //
+
+int main(int argc, char* argv[])
+{
+  std::string tdmfile(argv[1]);
+  std::string tdxfile(argv[2]);
+
+  std::cout<<tdmfile<<"\n"<<tdxfile<<"\n";
+
+  pugi::xml_document xml_doc;
+  pugi::xml_parse_result xml_result;
+
+  // load XML document from stream
+  std::ifstream fin(tdmfile.c_str());
+  xml_result = xml_doc.load(fin);
+  fin.close();
+
+  std::cout<<"\nloading "<<tdmfile<<": "<<xml_result.description()<<"\n";
+  std::cout<<"encoding: "<<(pugi::xml_encoding)xml_result.encoding<<"\n\n";
+
+  std::this_thread::sleep_for(std::chrono::milliseconds(4000));
+
+  return 0;
+}