Menu ▾ ▴

#354 Add headers to the cache and the NDAT files

v1.1.x
closed
Erik Hänel
None
v1.1.2
Change Request
2019-09-20
2018-06-26
Erik Hänel
No

In the upcoming version 1.1.2, add headers to the NDAT and the cache file, which will contain information about the version of the file format.

Analysis:

The NDAT-header shall contain the following information:

  • NumeRe version
  • Time stamp
  • 1x1 dummy data to prevent older versions from failing. The column headline of the dummy data shall contain the warning that the used version of NumeRe is too old
  • File version (i.e. 2.0+, minor version changes shall be downwards compatible)
  • Space for a comment
  • 3 unused fields for further changes (encode them in length, data)
  • Data type (for providing the possibility to save string and mixed data)
  • Actual dimensions of the data

A reasonable approach seems to be to encapsulate the NDAT functionalities into a own class, which will be instantiated by the other classes as needed. Probably it would be also reasonable to add the other file formats as well and create a NumeRe::File class. Regarding the cache file format: it's probably a good situation to change that file completely.

Implementation:

  • Implementation: The implementation was done as proposed by the analysis. However, it was left on the corresponding branch, because it won't work with the current version number
  • Revision: [r568]
  • Implementation test: Instances of each file were read and written without any deviation.

Documentation:

  • [x] ChangesLog updated
  • [x] Code changes commented
  • Documentation articles:
    • [ ] corresponding documentation articles updated
    • [ ] new documentation articles created
    • [x] not needed
  • Language files:
    • [x] corresponding language files updated
    • [ ] not needed

Tests:

Functionality was tested manually. Deviations were fixed.

Related

Commit: [r568]

Discussion

  • Erik Hänel

    Erik Hänel - 2018-06-26
    • status: open --> accepted
     

  • Erik Hänel

    Erik Hänel - 2018-11-22
    • Version: Planned --> v1.1.2
     

  • Erik Hänel

    Erik Hänel - 2019-05-22
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1 +1,23 @@
 In the upcoming version 1.1.2, add headers to the NDAT and the cache file, which will contain information about the version of the file format.
+
+###Analysis:
+(*Describe, what's the issue and which changes have to be made*)
+
+###Implementation:
+* Implementation: (*Describe, what you've changed*) 
+* Revision: [rXXX]
+* Implementation test: (*Describe the type of test, which you performed, and if it was successful*)
+
+###Documentation:
+* [ ] ChangesLog updated
+* [ ] Code changes commented
+* **Documentation articles:**

+    * [ ] corresponding documentation articles updated
+    * [ ] new documentation articles created
+    * [ ] not needed
+* **Language files:**
+    * [ ] corresponding language files updated
+    * [ ] not needed
+
+###Tests:
+(*Describe, which tests you performed and their outcome*)
    • status: accepted --> analyzing
     

  • Erik Hänel

    Erik Hänel - 2019-05-22
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1,7 +1,15 @@
 In the upcoming version 1.1.2, add headers to the NDAT and the cache file, which will contain information about the version of the file format.

 ###Analysis:
-(*Describe, what's the issue and which changes have to be made*)
+The NDAT-header shall contain the following information:
+
+* NumeRe version
+* 1x1 dummy data to prevent older versions from failing. The column headline of the dummy data shall contain the warning that the used version of NumeRe is too old
+* File version (i.e. 2.0+, minor version changes shall be downwards compatible)
+* Space for a comment
+* 3 unused fields for further changes (encode them in length, data)
+* Data type (for providing the possibility to save string and mixed data)
+* Dimensions of the data

 ###Implementation:

 * Implementation: (*Describe, what you've changed*)
     

  • Erik Hänel

    Erik Hänel - 2019-05-23
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -4,12 +4,13 @@
 The NDAT-header shall contain the following information:


 * NumeRe version
+* Time stamp
 * 1x1 dummy data to prevent older versions from failing. The column headline of the dummy data shall contain the warning that the used version of NumeRe is too old
 * File version (i.e. 2.0+, minor version changes shall be downwards compatible)
 * Space for a comment
 * 3 unused fields for further changes (encode them in length, data)
 * Data type (for providing the possibility to save string and mixed data)
-* Dimensions of the data
+* Actual dimensions of the data

 ###Implementation:

 * Implementation: (*Describe, what you've changed*)
     

  • Erik Hänel

    Erik Hänel - 2019-05-23
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -11,6 +11,8 @@

 * 3 unused fields for further changes (encode them in length, data)
 * Data type (for providing the possibility to save string and mixed data)
 * Actual dimensions of the data
+
+Regarding the cache file format: it's probably a good situation to change that file completely.

 ###Implementation:

 * Implementation: (*Describe, what you've changed*)
     

  • Erik Hänel

    Erik Hänel - 2019-05-25
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -12,7 +12,7 @@

 * Data type (for providing the possibility to save string and mixed data)
 * Actual dimensions of the data

-Regarding the cache file format: it's probably a good situation to change that file completely.
+A reasonable approach seems to be to encapsulate the NDAT functionalities into a own class, which will be instantiated by the other classes as needed. Probably it would be also reasonable to add the other file formats as well and create a `NumeRe::File` class. Regarding the cache file format: it's probably a good situation to change that file completely.

 ###Implementation:

 * Implementation: (*Describe, what you've changed*)
     

  • Erik Hänel

    Erik Hänel - 2019-06-03
    • status: analyzing --> implementing
     

  • Erik Hänel

    Erik Hänel - 2019-06-14
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -15,19 +15,19 @@
 A reasonable approach seems to be to encapsulate the NDAT functionalities into a own class, which will be instantiated by the other classes as needed. Probably it would be also reasonable to add the other file formats as well and create a `NumeRe::File` class. Regarding the cache file format: it's probably a good situation to change that file completely.

 ###Implementation:
-* Implementation: (*Describe, what you've changed*) 
-* Revision: [rXXX]
-* Implementation test: (*Describe the type of test, which you performed, and if it was successful*)
+* Implementation: The implementation was done as proposed by the analysis. However, it was left on the corresponding branch, because it won't work with the current version number
+* Revision: [r568]
+* Implementation test: Instances of each file were read and written without any deviation.

 ###Documentation:
-* [ ] ChangesLog updated
-* [ ] Code changes commented
+* [x] ChangesLog updated
+* [x] Code changes commented

 * **Documentation articles:**
     * [ ] corresponding documentation articles updated
     * [ ] new documentation articles created
-    * [ ] not needed
+    * [x] not needed
 * **Language files:**
-    * [ ] corresponding language files updated
+    * [x] corresponding language files updated
     * [ ] not needed

 ###Tests:
    • status: implementing --> testing
     

    Related

    Commit: [r568]

  • Erik Hänel

    Erik Hänel - 2019-09-20
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -31,4 +31,4 @@

     * [ ] not needed

 ###Tests:
-(*Describe, which tests you performed and their outcome*)
+Functionality was tested manually. Deviations were fixed.
    • status: testing --> closed
     

Anonymous
Anonymous

Add attachments
Cancel





MongoDB Logo MongoDB