Skip to content

Commit 1f22ae2

Browse files
PhRosenbergerpmai
authored andcommitted
Removal of the historical .txt trace file format and related scripts
Signed-off-by: Philipp Rosenberger <[email protected]>
1 parent 41f14a3 commit 1f22ae2

File tree

4 files changed

+3
-118
lines changed

4 files changed

+3
-118
lines changed

doc/architecture/formatting_scripts.adoc

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,6 @@ endif::[]
77
The OSI repository contains Python scripts for converting trace files from one format to another.
88
The formatting scripts are stored in `open-simulation-interface/format/`
99

10-
**txt2osi.py**
11-
12-
`txt2osi.py` converts plain-text trace files to binary `.osi` trace files.
13-
This script takes the following parameters:
14-
15-
`--data`, `-d`::
16-
String containing the path to the file with serialized data.
17-
18-
`--type`, `-t`::
19-
Optional string describing the message type used to serialize data.
20-
`'SensorView'`, `'GroundTruth'`, or `'SensorData'` are permitted values.
21-
The default value is `'SensorView'`.
22-
23-
`--output`, `-o`::
24-
Optional string containing the name of the output file.
25-
The default value is `'converted.osi'`.
26-
27-
`--compress`, `-c`::
28-
Optional Boolean controlling whether to compress the output to an lzma file.
29-
`True`, or `False` are permitted values.
30-
The default value is `False`.
31-
3210
**osi2read.py**
3311

3412
`osi2read.py` converts trace files to human-readable `.txth` trace files.

doc/architecture/trace_file_formats.adoc

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,14 @@ endif::[]
55
[#top-osi_trace_file_formats]
66
= OSI trace file formats
77

8-
There are multiple formats for storing multiple serialized OSI messages in one trace file.
8+
There are two formats for storing multiple serialized OSI messages in one trace file.
99

1010
*.osi::
1111
Binary trace file.
1212
Messages are separated by a length specification before each message.
1313
The length is represented by a four-byte, little-endian, unsigned integer.
1414
The length does not include the integer itself.
1515
16-
*.txt::
17-
Plain-text trace file.
18-
Messages are separated by `$$__$$`.
19-
2016
*.txth::
2117
Human-readable plain-text trace file.
2218
Messages are separated by newlines.

format/osi2read.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
"""
2-
This program converts serialized txt/osi trace files into a human readable txth file.
2+
This program converts serialized osi trace files into a human readable txth file.
33
44
Example usage:
55
python3 osi2read.py -d trace.osi -o myreadableosifile
6-
python3 osi2read.py -d trace.txt -f separated -o myreadableosifile
76
"""
87

98
from OSITrace import OSITrace
@@ -19,7 +18,7 @@ def command_line_arguments():
1918
dir_path = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
2019

2120
parser = argparse.ArgumentParser(
22-
description="Convert a serialized osi/txt trace file to a readable txth output.",
21+
description="Convert a serialized osi trace file to a readable txth output.",
2322
prog="osi2read converter",
2423
)
2524
parser.add_argument(

format/txt2osi.py

Lines changed: 0 additions & 88 deletions
This file was deleted.

0 commit comments

Comments
 (0)