From 0d5406aeee466151b81d352656a8658e54c20d78 Mon Sep 17 00:00:00 2001 From: Emily Boudreaux Date: Sun, 16 Feb 2025 12:29:51 -0500 Subject: [PATCH] docs(opatIO): wrote and built doxygen docs --- docs/html/annotated.html | 16 +- docs/html/annotated_dup.js | 12 +- docs/html/classes.html | 15 +- .../dir_68267d1309a1af8e8297ef4c3efbcdba.js | 5 +- docs/html/files.html | 18 +- docs/html/functions.html | 166 ++++++++++-- docs/html/functions_func.html | 90 ++++++- docs/html/functions_rela.html | 3 +- docs/html/globals.html | 3 +- docs/html/globals_func.html | 3 +- docs/html/navtreeindex0.js | 170 ++++++++----- docs/html/search/all_0.js | 7 +- docs/html/search/all_1.js | 12 +- docs/html/search/all_2.js | 13 +- docs/html/search/all_3.js | 17 +- docs/html/search/all_4.js | 7 +- docs/html/search/all_5.js | 5 +- docs/html/search/all_6.js | 6 +- docs/html/search/all_7.js | 16 +- docs/html/search/all_8.js | 7 +- docs/html/search/all_9.js | 6 +- docs/html/search/classes_0.js | 7 +- docs/html/search/classes_1.js | 4 +- docs/html/search/classes_2.js | 3 +- docs/html/search/files_0.js | 2 +- docs/html/search/files_1.js | 6 +- docs/html/search/files_2.js | 4 +- docs/html/search/functions_0.js | 2 +- docs/html/search/functions_1.js | 2 +- docs/html/search/functions_2.js | 23 +- docs/html/search/functions_3.js | 2 +- docs/html/search/functions_4.js | 7 +- docs/html/search/functions_5.js | 2 +- docs/html/search/functions_6.js | 7 +- docs/html/search/functions_7.js | 2 +- docs/html/search/functions_8.js | 5 +- docs/html/search/related_0.js | 2 +- docs/html/search/searchdata.js | 10 +- docs/html/search/typedefs_0.js | 2 +- docs/html/search/typedefs_1.js | 2 +- docs/latex/annotated.tex | 10 +- docs/latex/files.tex | 5 +- docs/latex/refman.tex | 11 +- src/opatIO/public/opatIO.h | 237 +++++++++++++++--- 44 files changed, 711 insertions(+), 243 deletions(-) diff --git a/docs/html/annotated.html b/docs/html/annotated.html index c54be4f..2a854ec 100644 --- a/docs/html/annotated.html +++ b/docs/html/annotated.html @@ -98,16 +98,20 @@ $(document).ready(function(){initNavTree('annotated.html',''); initResizable();
Here are the classes, structs, unions and interfaces with brief descriptions:
- - - - - - + + + + + + + + + +
 CCell
 CconstantStructure to hold a constant's details
 CconstantsClass to manage a collection of constants
 CconstTestTest suite for the const class
 CDObjectA universal data container class
 CDObjectTestTest suite for the DObject class
 CConstantStructure to hold a constant's details
 CConstantsClass to manage a collection of constants
 CconstTestTest suite for the const class
 CDObjectA universal data container class
 CDObjectTestTest suite for the DObject class
 CHeaderStructure to hold the header information of an OPAT file
 CLockableDObjectWrapper for DObject with thread-safe access
 CLockableDObjectTestTest suite for the LockableDObject class
 CMetadataRepresents metadata information for data objects in the dobj module
 CMetadataTestTest suite for the Metadata class
 COpatIOClass to manage the input/output operations for OPAT files
 CopatIOTestTest suite for the const class
 COPATTableStructure to hold the data of an OPAT table
 CTableIndexStructure to hold the index information of a table in an OPAT file
diff --git a/docs/html/annotated_dup.js b/docs/html/annotated_dup.js index 6ff9046..9eb4f4d 100644 --- a/docs/html/annotated_dup.js +++ b/docs/html/annotated_dup.js @@ -1,13 +1,17 @@ var annotated_dup = [ - [ "Cell", "classCell.html", "classCell" ], - [ "constant", "structconstant.html", "structconstant" ], - [ "constants", "classconstants.html", "classconstants" ], + [ "Constant", "structConstant.html", "structConstant" ], + [ "Constants", "classConstants.html", "classConstants" ], [ "constTest", "classconstTest.html", "classconstTest" ], [ "DObject", "classDObject.html", "classDObject" ], [ "DObjectTest", "classDObjectTest.html", "classDObjectTest" ], + [ "Header", "structHeader.html", "structHeader" ], [ "LockableDObject", "classLockableDObject.html", "classLockableDObject" ], [ "LockableDObjectTest", "classLockableDObjectTest.html", "classLockableDObjectTest" ], [ "Metadata", "classMetadata.html", "classMetadata" ], - [ "MetadataTest", "classMetadataTest.html", "classMetadataTest" ] + [ "MetadataTest", "classMetadataTest.html", "classMetadataTest" ], + [ "OpatIO", "classOpatIO.html", "classOpatIO" ], + [ "opatIOTest", "classopatIOTest.html", null ], + [ "OPATTable", "structOPATTable.html", "structOPATTable" ], + [ "TableIndex", "structTableIndex.html", "structTableIndex" ] ]; \ No newline at end of file diff --git a/docs/html/classes.html b/docs/html/classes.html index 80350c5..a5643d6 100644 --- a/docs/html/classes.html +++ b/docs/html/classes.html @@ -96,20 +96,29 @@ $(document).ready(function(){initNavTree('classes.html',''); initResizable(); })
Class Index
-
C | D | L | M
+
C | D | H | L | M | O | T
C
-
Cell
constant
constants
constTest
+
Constant
Constants
constTest
D
DObject
DObjectTest
+
H
+
Header
+
L
LockableDObject
LockableDObjectTest
-
+
M
Metadata
MetadataTest
+
+
O
+
OpatIO
opatIOTest
OPATTable
+
+
T
+
TableIndex
diff --git a/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.js b/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.js index 0f13a4f..5ec2ee3 100644 --- a/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.js +++ b/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.js @@ -2,7 +2,6 @@ var dir_68267d1309a1af8e8297ef4c3efbcdba = [ [ "const", "dir_409882efad9ab48a895cd8b217d1e026.html", "dir_409882efad9ab48a895cd8b217d1e026" ], [ "dobj", "dir_768194193337d64eaa7edd2c5f5038a4.html", "dir_768194193337d64eaa7edd2c5f5038a4" ], - [ "mapping", "dir_5300298560c4bf255ab9f36681603d89.html", "dir_5300298560c4bf255ab9f36681603d89" ], - [ "mesh", "dir_7be0d8c199b9408ae01f5d77515b8def.html", "dir_7be0d8c199b9408ae01f5d77515b8def" ], - [ "opac", "dir_98811334950283dfb0b975440d5272eb.html", "dir_98811334950283dfb0b975440d5272eb" ] + [ "opac", "dir_98811334950283dfb0b975440d5272eb.html", "dir_98811334950283dfb0b975440d5272eb" ], + [ "opatIO", "dir_dc4574cef47f5b50114efcdd6e195baf.html", "dir_dc4574cef47f5b50114efcdd6e195baf" ] ]; \ No newline at end of file diff --git a/docs/html/files.html b/docs/html/files.html index a8794f2..4ade754 100644 --- a/docs/html/files.html +++ b/docs/html/files.html @@ -110,16 +110,12 @@ $(document).ready(function(){initNavTree('files.html',''); initResizable(); });  DObject.hDefines the DObject class, a universal data container for the project  LockableDObject.hA lightweight wrapper for DObject that adds locking capabilities  Metadata.hPublic interface for the Metadata class used in the dobj module - ▼ mapping - ▼ private - grid.h - mapper.h - ▼ mesh - ▼ public - mesh.h - ▼ opac - ▼ public - opac.h + ▼ opac + ▼ public + opac.h + ▼ opatIO + ▼ public + opatIO.h  ▼ tests  ▼ const  constTest.cppUnit tests for the const class @@ -127,6 +123,8 @@ $(document).ready(function(){initNavTree('files.html',''); initResizable(); });  DObjectTest.cppUnit tests for the DObject class  LockableDObjectTest.cppUnit tests for the LockableDObject class  MetadataTest.cppUnit tests and integration tests for the Metadata class + ▼ opatIO + opatIOTest.cppUnit tests for the OpatIO class and associated structs diff --git a/docs/html/functions.html b/docs/html/functions.html index b82dbf0..b3cae26 100644 --- a/docs/html/functions.html +++ b/docs/html/functions.html @@ -94,9 +94,25 @@ $(document).ready(function(){initNavTree('functions.html',''); initResizable();
Here is a list of all documented class members with links to the class documentation for each member:
+

- b -

+ +

- c -

@@ -113,12 +129,21 @@ $(document).ready(function(){initNavTree('functions.html',''); initResizable();

- g -

- h -

- i -

- k -

- l -

- m -

- r -

- u -

diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html index 5a9fe32..c70f0a0 100644 --- a/docs/html/functions_func.html +++ b/docs/html/functions_func.html @@ -95,8 +95,8 @@ $(document).ready(function(){initNavTree('functions_func.html',''); initResizabl  

- c -

@@ -110,12 +110,21 @@ $(document).ready(function(){initNavTree('functions_func.html',''); initResizabl

- g -

- h -

- i -

- k -

- l -

@@ -182,8 +216,24 @@ $(document).ready(function(){initNavTree('functions_func.html',''); initResizabl

- o -

+ + +

- p -

@@ -223,10 +273,19 @@ $(document).ready(function(){initNavTree('functions_func.html',''); initResizabl
  • setErrorCode() : DObject
    • +
  • setFilename() +: OpatIO +
    • +
  • setMaxQDepth() +: OpatIO +

    • - u -

    + + +

    - ~ -

    diff --git a/docs/html/functions_rela.html b/docs/html/functions_rela.html index b71965e..2486401 100644 --- a/docs/html/functions_rela.html +++ b/docs/html/functions_rela.html @@ -94,7 +94,8 @@ $(document).ready(function(){initNavTree('functions_rela.html',''); initResizabl
      diff --git a/docs/html/globals.html b/docs/html/globals.html index e64acd0..3704e10 100644 --- a/docs/html/globals.html +++ b/docs/html/globals.html @@ -99,12 +99,13 @@ $(document).ready(function(){initNavTree('globals.html',''); initResizable(); })
  • TEST_F() : LockableDObjectTest.cpp +, opatIOTest.cpp , MetadataTest.cpp , LockableDObjectTest.cpp , constTest.cpp , LockableDObjectTest.cpp , DObjectTest.cpp -, constTest.cpp +, constTest.cpp
    • diff --git a/docs/html/globals_func.html b/docs/html/globals_func.html index 76f4c54..5ea1bae 100644 --- a/docs/html/globals_func.html +++ b/docs/html/globals_func.html @@ -99,12 +99,13 @@ $(document).ready(function(){initNavTree('globals_func.html',''); initResizable(
  • TEST_F() : LockableDObjectTest.cpp +, opatIOTest.cpp , MetadataTest.cpp , LockableDObjectTest.cpp , constTest.cpp , LockableDObjectTest.cpp , DObjectTest.cpp -, constTest.cpp +, constTest.cpp
    • diff --git a/docs/html/navtreeindex0.js b/docs/html/navtreeindex0.js index 9042404..39509e5 100644 --- a/docs/html/navtreeindex0.js +++ b/docs/html/navtreeindex0.js @@ -35,35 +35,34 @@ var NAVTREEINDEX0 = "Metadata_8h.html#ab57c319c35ea0fbacf781f2ecb3a4339":[2,0,0,1,1,2,1], "Metadata_8h_source.html":[2,0,0,1,1,2], "annotated.html":[1,0], -"classCell.html":[1,0,0], -"classCell.html#a0be67c01402af076ea82f42a013867af":[1,0,0,4], -"classCell.html#a2417b0eb0398012743e88d128b590d68":[1,0,0,3], -"classCell.html#a25f37241a10fa27bcdea7e939eea5efc":[1,0,0,1], -"classCell.html#a426862431a79984cb040c6f396a8e1d9":[1,0,0,5], -"classCell.html#a4a0c2cb92bbc10d4c4c7d8fd415095f3":[1,0,0,2], -"classCell.html#a4a5bedd07f9f68be513382e90f9f2814":[1,0,0,0], -"classDObject.html":[1,0,4], -"classDObject.html#a0ae54853e18265657296bfb5ac3bf9d0":[1,0,4,2], -"classDObject.html#a1223275dcbbf20334ea11707346acb93":[1,0,4,9], -"classDObject.html#a15afffdf339150fc872bf63bdd08d581":[1,0,4,8], -"classDObject.html#a358d5f015da09ae5f0cbb46f3fd9e401":[1,0,4,16], -"classDObject.html#a3dce47a519f9da5085c0c5ac1eea4f38":[1,0,4,13], -"classDObject.html#a4862655c3634d019b0a45b811d6f7235":[1,0,4,4], -"classDObject.html#a598321f3b8524b98df72393c04d7470c":[1,0,4,3], -"classDObject.html#a5b2896a287295bf59a0b9e4d0af21161":[1,0,4,15], -"classDObject.html#a6f0023aee463e71d92442dcf61b6ed47":[1,0,4,12], -"classDObject.html#a79a2ecac4130ef3df272bdfeed26a620":[1,0,4,0], -"classDObject.html#a99072eb52bb22745f0248f273fbf28fb":[1,0,4,10], -"classDObject.html#a99b8688849e11501033a25f61efb8356":[1,0,4,14], -"classDObject.html#ab1718571434e84e90f1ec463e4786a8a":[1,0,4,11], -"classDObject.html#aca2db093c1c8c6f7893de07544aed619":[1,0,4,5], -"classDObject.html#ae47bf220fbe2173cf6933c2380035dbd":[1,0,4,7], -"classDObject.html#af11334d08ef85c68b3aae7554548e5a7":[1,0,4,1], -"classDObject.html#afa8926d916081de72478cb8813c25e98":[1,0,4,6], -"classDObjectTest.html":[1,0,5], -"classDObjectTest.html#a2150dd7881a4d1c68ce51344f174738e":[1,0,5,2], -"classDObjectTest.html#a95ba0f78c44e0bd46603de32028b7be6":[1,0,5,0], -"classDObjectTest.html#ac753942590ae6ee456e6f3dd8b205df2":[1,0,5,1], +"classConstants.html":[1,0,1], +"classConstants.html#a2aa041fd223f259e55bf098c90581039":[1,0,1,1], +"classConstants.html#a36ddd7fe6857d1bbf6d1c84d4ed7bc19":[1,0,1,0], +"classConstants.html#ab9de36fa145552a3e7964e7e85a67149":[1,0,1,3], +"classConstants.html#ad75620743b867fc20d4a05027d1a1c01":[1,0,1,4], +"classConstants.html#ae276dfdc0ffe75a53e3842e33ab52630":[1,0,1,2], +"classDObject.html":[1,0,3], +"classDObject.html#a0ae54853e18265657296bfb5ac3bf9d0":[1,0,3,2], +"classDObject.html#a1223275dcbbf20334ea11707346acb93":[1,0,3,9], +"classDObject.html#a15afffdf339150fc872bf63bdd08d581":[1,0,3,8], +"classDObject.html#a358d5f015da09ae5f0cbb46f3fd9e401":[1,0,3,16], +"classDObject.html#a3dce47a519f9da5085c0c5ac1eea4f38":[1,0,3,13], +"classDObject.html#a4862655c3634d019b0a45b811d6f7235":[1,0,3,4], +"classDObject.html#a598321f3b8524b98df72393c04d7470c":[1,0,3,3], +"classDObject.html#a5b2896a287295bf59a0b9e4d0af21161":[1,0,3,15], +"classDObject.html#a6f0023aee463e71d92442dcf61b6ed47":[1,0,3,12], +"classDObject.html#a79a2ecac4130ef3df272bdfeed26a620":[1,0,3,0], +"classDObject.html#a99072eb52bb22745f0248f273fbf28fb":[1,0,3,10], +"classDObject.html#a99b8688849e11501033a25f61efb8356":[1,0,3,14], +"classDObject.html#ab1718571434e84e90f1ec463e4786a8a":[1,0,3,11], +"classDObject.html#aca2db093c1c8c6f7893de07544aed619":[1,0,3,5], +"classDObject.html#ae47bf220fbe2173cf6933c2380035dbd":[1,0,3,7], +"classDObject.html#af11334d08ef85c68b3aae7554548e5a7":[1,0,3,1], +"classDObject.html#afa8926d916081de72478cb8813c25e98":[1,0,3,6], +"classDObjectTest.html":[1,0,4], +"classDObjectTest.html#a2150dd7881a4d1c68ce51344f174738e":[1,0,4,2], +"classDObjectTest.html#a95ba0f78c44e0bd46603de32028b7be6":[1,0,4,0], +"classDObjectTest.html#ac753942590ae6ee456e6f3dd8b205df2":[1,0,4,1], "classLockableDObject.html":[1,0,6], "classLockableDObject.html#a1481ed99dcd837490bf28309aadaedfb":[1,0,6,3], "classLockableDObject.html#adcfe201fc728cc1c6fcf638a566ba9a1":[1,0,6,1], @@ -87,44 +86,55 @@ var NAVTREEINDEX0 = "classMetadataTest.html":[1,0,9], "classMetadataTest.html#a24075d61d37dceacd353ecde16a1ac71":[1,0,9,1], "classMetadataTest.html#a6273a370a10b42155af951a8fc2c47fa":[1,0,9,0], -"classconstTest.html":[1,0,3], -"classconstTest.html#a3bc6a1a6485821a1c24b8fd5f1cc1025":[1,0,3,1], -"classconstTest.html#a73b1bf87af8167bde37397673ad6bcfe":[1,0,3,2], -"classconstTest.html#af4753885bf401953202f89d455a2702f":[1,0,3,0], -"classconstants.html":[1,0,2], -"classconstants.html#a00666cb3d413cc53e4a3e629c2e22155":[1,0,2,2], -"classconstants.html#a10550367b0875a0767b01d4970cc0a30":[1,0,2,1], -"classconstants.html#a310c5d599cf21de82eaf0abe9bc5f9a0":[1,0,2,6], -"classconstants.html#a32d515b1f539f6fdfc654ed5c8cba8e0":[1,0,2,7], -"classconstants.html#a35dcd5bb493bc095330b177819242c93":[1,0,2,3], -"classconstants.html#a9be0748cd713f4a465b548e0c44458ee":[1,0,2,0], -"classconstants.html#ab08623c9c865188806b6820d3ed27fe9":[1,0,2,4], -"classconstants.html#ab72bcb21759e2e7f26f55f1d3454b999":[1,0,2,5], +"classOpatIO.html":[1,0,10], +"classOpatIO.html#a0817f135f44e3bdc610d30df145f118d":[1,0,10,9], +"classOpatIO.html#a117f7e1f45d6c410c21d0644e447bbb1":[1,0,10,15], +"classOpatIO.html#a2894437c09f4cdb06c9b06d6aad4bd2f":[1,0,10,8], +"classOpatIO.html#a3578ac9bad40dd45ada3459f92a93b56":[1,0,10,12], +"classOpatIO.html#a37959ed6845e09302bb8c206e3e006e4":[1,0,10,14], +"classOpatIO.html#a48cd5e4f3fdb221bc1b6253e149e8e01":[1,0,10,7], +"classOpatIO.html#a7f3436b3ac0dbe141b08d8064550f1b3":[1,0,10,0], +"classOpatIO.html#a83acf4fe2aec4e588453b5a39a4def1a":[1,0,10,4], +"classOpatIO.html#a939e4edec4053517463f848648db770d":[1,0,10,3], +"classOpatIO.html#a9d9600e7af036deeada78da9afd4b65b":[1,0,10,5], +"classOpatIO.html#aa8037fc93588dd4c6cbec9bb7c76225f":[1,0,10,16], +"classOpatIO.html#ab0edd41690b8d5c1775f87439cf82cb5":[1,0,10,19], +"classOpatIO.html#aba1be05d51d4b0b9e4581b95ad0e1890":[1,0,10,11], +"classOpatIO.html#ac1c1a6159f82462fedf9b526ddcc19a6":[1,0,10,20], +"classOpatIO.html#ac34f611a9eab458329553d27e8bffec6":[1,0,10,2], +"classOpatIO.html#ad189e0f239bc4184fecf7daef7923272":[1,0,10,18], +"classOpatIO.html#ae24b6a4f78529c4fe4719ea5438d5ed6":[1,0,10,1], +"classOpatIO.html#af0bc6bb210c4ff74bc1e043aeb252e1a":[1,0,10,10], +"classOpatIO.html#af870ebd76bef969fa1f7c8270ac25cd8":[1,0,10,13], +"classOpatIO.html#afa623ba10f188097e555a682a4c69a9f":[1,0,10,17], +"classOpatIO.html#afe725b647bc5bb802f6d711fc5dca3ab":[1,0,10,6], +"classconstTest.html":[1,0,2], +"classconstTest.html#af4753885bf401953202f89d455a2702f":[1,0,2,0], "classes.html":[1,1], +"classopatIOTest.html":[1,0,11], "constTest_8cpp.html":[2,0,1,0,0], -"constTest_8cpp.html#a24fd011fd348f088cbeace0011dd15a3":[2,0,1,0,0,2], -"constTest_8cpp.html#a6855bb766d336a17d11e54111ebcb225":[2,0,1,0,0,3], -"constTest_8cpp.html#a7791e7d26061981190d234ca729956fd":[2,0,1,0,0,4], -"constTest_8cpp.html#a85e567e4ab97a13cf0b18cf9e3943c64":[2,0,1,0,0,6], -"constTest_8cpp.html#a939ea5fc258275bf5be224b26da12e00":[2,0,1,0,0,7], -"constTest_8cpp.html#ac0b79360ee6716dea67f34fb3ae48a91":[2,0,1,0,0,5], +"constTest_8cpp.html#a1d2582df9987648644c517d89223e849":[2,0,1,0,0,7], +"constTest_8cpp.html#a267b8a580d24fec8326def8656df135a":[2,0,1,0,0,3], +"constTest_8cpp.html#a3bc116c41e8839b6d9d5a49e046a800f":[2,0,1,0,0,2], +"constTest_8cpp.html#a720684391716660c7d0a5dc6238c7e57":[2,0,1,0,0,5], +"constTest_8cpp.html#a92b56f4876b91eb7d628492fe220babb":[2,0,1,0,0,4], +"constTest_8cpp.html#aa33a362aa6f7634f2ef02413183b35ee":[2,0,1,0,0,6], "constTest_8cpp.html#ae050a185fbc60349459af47e661bd3e1":[2,0,1,0,0,1], "const_8h_source.html":[2,0,0,0,0,0], -"dir_01375c4291ef81af6b426b22dfef59b0.html":[2,0,0,2,0], "dir_409882efad9ab48a895cd8b217d1e026.html":[2,0,0,0], "dir_4e6f6de88c62da29e0ddd0d8e63af038.html":[2,0,0,1,0], -"dir_5300298560c4bf255ab9f36681603d89.html":[2,0,0,2], "dir_5657658ab0dc14c9c63c088cb1f6321c.html":[2,0,0,1,1], "dir_59425e443f801f1f2fd8bbe4959a3ccf.html":[2,0,1], "dir_68267d1309a1af8e8297ef4c3efbcdba.html":[2,0,0], "dir_6cfc89239232d12b3feb44b30f54e02f.html":[2,0,1,0], -"dir_6f7ea45c988f41ae8b133398f644b0ed.html":[2,0,0,3,0], "dir_768194193337d64eaa7edd2c5f5038a4.html":[2,0,0,1], -"dir_7be0d8c199b9408ae01f5d77515b8def.html":[2,0,0,3], -"dir_88e1407a1fb38d630626d3e1b6639cc8.html":[2,0,0,4,0], -"dir_98811334950283dfb0b975440d5272eb.html":[2,0,0,4], +"dir_88e1407a1fb38d630626d3e1b6639cc8.html":[2,0,0,2,0], +"dir_98811334950283dfb0b975440d5272eb.html":[2,0,0,2], +"dir_a0668aa070a38eaa8236727e19a9b15f.html":[2,0,1,2], +"dir_a105e00bd9bc580163f6cfcc237f0c76.html":[2,0,0,3,0], "dir_aa74b0b57852b214f24568086f91a43d.html":[2,0,0,0,0], "dir_bc1cc3abf5d5430dc6e21979095d09f3.html":[2,0,1,1], +"dir_dc4574cef47f5b50114efcdd6e195baf.html":[2,0,0,3], "files.html":[2,0], "functions.html":[1,3,0], "functions_func.html":[1,3,1], @@ -133,18 +143,50 @@ var NAVTREEINDEX0 = "functions_vars.html":[1,3,2], "globals.html":[2,1,0], "globals_func.html":[2,1,1], -"grid_8h_source.html":[2,0,0,2,0,0], "hierarchy.html":[1,2], "index.html":[], -"mapper_8h_source.html":[2,0,0,2,0,1], -"mesh_8h_source.html":[2,0,0,3,0,0], -"opac_8h_source.html":[2,0,0,4,0,0], +"opac_8h_source.html":[2,0,0,2,0,0], +"opatIOTest_8cpp.html":[2,0,1,2,0], +"opatIOTest_8cpp.html#a2f358f231bffa8eaaa670ec1db93a470":[2,0,1,2,0,9], +"opatIOTest_8cpp.html#a3962f0895a961e03a0fc208076f6ab1a":[2,0,1,2,0,4], +"opatIOTest_8cpp.html#a4b609f93f9fbea0dbd3e8d619e70f293":[2,0,1,2,0,8], +"opatIOTest_8cpp.html#a4c4af5f8d030d0932c44bfa6607a5599":[2,0,1,2,0,6], +"opatIOTest_8cpp.html#a5a86dce243090b6e4de4c67c23338ab7":[2,0,1,2,0,5], +"opatIOTest_8cpp.html#a7613e1e543a4ea3ad5ce9d6c9156d317":[2,0,1,2,0,7], +"opatIOTest_8cpp.html#a76734dc9ab5318ba389c0b3e54844137":[2,0,1,2,0,1], +"opatIOTest_8cpp.html#ac3a79e8bac7362518c4495f4b9136a99":[2,0,1,2,0,2], +"opatIOTest_8cpp.html#af0f9275c448cde753b14350594af14cf":[2,0,1,2,0,3], +"opatIO_8h_source.html":[2,0,0,3,0,0], "pages.html":[], -"structconstant.html":[1,0,1], -"structconstant.html#a6be3abe8a0b5a3057d1ab572bd7aad76":[1,0,1,1], -"structconstant.html#a81804eeeca08f157af92766d5285064f":[1,0,1,4], -"structconstant.html#aa23b68117657bec4bb8409eb30d1b3e4":[1,0,1,2], -"structconstant.html#ace4a7f2bfc5b80a76c494e92349f9048":[1,0,1,3], -"structconstant.html#af52cfa5a80b3641881d45eef6d597510":[1,0,1,0], +"structConstant.html":[1,0,0], +"structConstant.html#a0ae09f22af150a41aa4169a4a60933be":[1,0,0,4], +"structConstant.html#a1c7e6c5a1d2316c98e59e04a234754d1":[1,0,0,3], +"structConstant.html#a2c46956a2d2b0ebf78ff99c5971130d2":[1,0,0,5], +"structConstant.html#a3bda8d7fadd6fb2510fd39962a065a02":[1,0,0,6], +"structConstant.html#a84ca5b6951cc8a8eccd083894302a857":[1,0,0,0], +"structConstant.html#a8d8d2a81e9a8f36dfa02b4d23a5be55c":[1,0,0,2], +"structConstant.html#ad298f7af7cdfd2e2267fd9e464558e2b":[1,0,0,1], +"structHeader.html":[1,0,5], +"structHeader.html#a122331824871070af2c6cebc9698abd8":[1,0,5,0], +"structHeader.html#a162ced3913c3373d6d54c32274b99d72":[1,0,5,5], +"structHeader.html#a31039c09176a479defcbe38597eb9957":[1,0,5,3], +"structHeader.html#a83f52dffac0449704ef1a50a5e787e92":[1,0,5,1], +"structHeader.html#a87c9fc5b27c41fe65698f8538c23b182":[1,0,5,4], +"structHeader.html#ac1a0c67ed5bd4021581fc00c2d79dba3":[1,0,5,7], +"structHeader.html#ac55e763f9e96050f4dab115a4a1c2356":[1,0,5,8], +"structHeader.html#af0bdf31defd5888cc8d2f7537e687917":[1,0,5,2], +"structHeader.html#af99697d38997984f2295c902d3ce1772":[1,0,5,6], +"structOPATTable.html":[1,0,12], +"structOPATTable.html#a237ed50cee8df2144a2c47b5ffa443d3":[1,0,12,2], +"structOPATTable.html#a70b70699726b2f77b486702e913a164b":[1,0,12,3], +"structOPATTable.html#a87cc2d8e225e5e9c567602d779aec88f":[1,0,12,4], +"structOPATTable.html#aee4e3713cffa0ed0a5bd79e2dec97d6e":[1,0,12,0], +"structOPATTable.html#afaf11794675d27e75de5233b947fced9":[1,0,12,1], +"structTableIndex.html":[1,0,13], +"structTableIndex.html#a0c4826e48839977fa2bfaa1bf51b6cdb":[1,0,13,2], +"structTableIndex.html#a303592792b2490da4105e294fb4666ca":[1,0,13,3], +"structTableIndex.html#a69c87fd1cb0b7a64a82c52c54193e5e6":[1,0,13,0], +"structTableIndex.html#a7271de867fee8bb48a71f70afebbf0bd":[1,0,13,4], +"structTableIndex.html#ad899cf13056eb17b33e1c5e303e10132":[1,0,13,1], "test.html":[0] }; diff --git a/docs/html/search/all_0.js b/docs/html/search/all_0.js index 40bf655..9530d1a 100644 --- a/docs/html/search/all_0.js +++ b/docs/html/search/all_0.js @@ -1,8 +1,5 @@ var searchData= [ - ['cell_0',['Cell',['../classCell.html',1,'']]], - ['constant_1',['constant',['../structconstant.html',1,'']]], - ['constants_2',['constants',['../classconstants.html',1,'constants'],['../classconstants.html#a9be0748cd713f4a465b548e0c44458ee',1,'constants::constants()'],['../classconstants.html#a10550367b0875a0767b01d4970cc0a30',1,'constants::constants(const std::string &filename)']]], - ['consttest_3',['constTest',['../classconstTest.html',1,'']]], - ['consttest_2ecpp_4',['constTest.cpp',['../constTest_8cpp.html',1,'']]] + ['byteend_0',['byteEnd',['../structTableIndex.html#a69c87fd1cb0b7a64a82c52c54193e5e6',1,'TableIndex']]], + ['bytestart_1',['byteStart',['../structTableIndex.html#ad899cf13056eb17b33e1c5e303e10132',1,'TableIndex']]] ]; diff --git a/docs/html/search/all_1.js b/docs/html/search/all_1.js index 95856c4..6d8c88d 100644 --- a/docs/html/search/all_1.js +++ b/docs/html/search/all_1.js @@ -1,9 +1,9 @@ var searchData= [ - ['datatype_5',['DataType',['../classDObject.html#a79a2ecac4130ef3df272bdfeed26a620',1,'DObject']]], - ['dobject_6',['DObject',['../classDObject.html',1,'DObject'],['../classDObject.html#a0ae54853e18265657296bfb5ac3bf9d0',1,'DObject::DObject()'],['../classDObject.html#a598321f3b8524b98df72393c04d7470c',1,'DObject::DObject(const DataType &data)']]], - ['dobject_2ecpp_7',['DObject.cpp',['../DObject_8cpp.html',1,'']]], - ['dobject_2eh_8',['DObject.h',['../DObject_8h.html',1,'']]], - ['dobjecttest_9',['DObjectTest',['../classDObjectTest.html',1,'']]], - ['dobjecttest_2ecpp_10',['DObjectTest.cpp',['../DObjectTest_8cpp.html',1,'']]] + ['comment_2',['comment',['../structHeader.html#a122331824871070af2c6cebc9698abd8',1,'Header']]], + ['constant_3',['Constant',['../structConstant.html',1,'Constant'],['../structConstant.html#a84ca5b6951cc8a8eccd083894302a857',1,'Constant::Constant()']]], + ['constants_4',['Constants',['../classConstants.html',1,'']]], + ['consttest_5',['constTest',['../classconstTest.html',1,'']]], + ['consttest_2ecpp_6',['constTest.cpp',['../constTest_8cpp.html',1,'']]], + ['creationdate_7',['creationDate',['../structHeader.html#a83f52dffac0449704ef1a50a5e787e92',1,'Header']]] ]; diff --git a/docs/html/search/all_2.js b/docs/html/search/all_2.js index 2ee7a0d..b3a6dd1 100644 --- a/docs/html/search/all_2.js +++ b/docs/html/search/all_2.js @@ -1,10 +1,9 @@ var searchData= [ - ['get_11',['get',['../classconstants.html#a00666cb3d413cc53e4a3e629c2e22155',1,'constants::get()'],['../classLockableDObject.html#adcfe201fc728cc1c6fcf638a566ba9a1',1,'LockableDObject::get()']]], - ['getbytesize_12',['getByteSize',['../classMetadata.html#ac7980d1efdd6ae434f0115f83d08348e',1,'Metadata']]], - ['getdata_13',['getData',['../classDObject.html#a4862655c3634d019b0a45b811d6f7235',1,'DObject']]], - ['getdataas_14',['getDataAs',['../classDObject.html#aca2db093c1c8c6f7893de07544aed619',1,'DObject']]], - ['getdatatype_15',['getDataType',['../classMetadata.html#aeed7f22ccc61d9a3d6425441d381dcdc',1,'Metadata']]], - ['getdimensions_16',['getDimensions',['../classMetadata.html#a412c0c0b8754d85f9edbbdcd637f3b20',1,'Metadata']]], - ['geterrorcode_17',['getErrorCode',['../classDObject.html#afa8926d916081de72478cb8813c25e98',1,'DObject']]] + ['datatype_8',['DataType',['../classDObject.html#a79a2ecac4130ef3df272bdfeed26a620',1,'DObject']]], + ['dobject_9',['DObject',['../classDObject.html',1,'DObject'],['../classDObject.html#a0ae54853e18265657296bfb5ac3bf9d0',1,'DObject::DObject()'],['../classDObject.html#a598321f3b8524b98df72393c04d7470c',1,'DObject::DObject(const DataType &data)']]], + ['dobject_2ecpp_10',['DObject.cpp',['../DObject_8cpp.html',1,'']]], + ['dobject_2eh_11',['DObject.h',['../DObject_8h.html',1,'']]], + ['dobjecttest_12',['DObjectTest',['../classDObjectTest.html',1,'']]], + ['dobjecttest_2ecpp_13',['DObjectTest.cpp',['../DObjectTest_8cpp.html',1,'']]] ]; diff --git a/docs/html/search/all_3.js b/docs/html/search/all_3.js index 6a05872..4c91c47 100644 --- a/docs/html/search/all_3.js +++ b/docs/html/search/all_3.js @@ -1,4 +1,19 @@ var searchData= [ - ['has_18',['has',['../classconstants.html#a35dcd5bb493bc095330b177819242c93',1,'constants']]] + ['get_14',['get',['../classLockableDObject.html#adcfe201fc728cc1c6fcf638a566ba9a1',1,'LockableDObject::get()'],['../classConstants.html#a36ddd7fe6857d1bbf6d1c84d4ed7bc19',1,'Constants::get()']]], + ['getbytesize_15',['getByteSize',['../classMetadata.html#ac7980d1efdd6ae434f0115f83d08348e',1,'Metadata']]], + ['getclosesttables_16',['getClosestTables',['../classOpatIO.html#a939e4edec4053517463f848648db770d',1,'OpatIO']]], + ['getclosestxtables_17',['getClosestXTables',['../classOpatIO.html#a83acf4fe2aec4e588453b5a39a4def1a',1,'OpatIO']]], + ['getclosestztables_18',['getClosestZTables',['../classOpatIO.html#a9d9600e7af036deeada78da9afd4b65b',1,'OpatIO']]], + ['getdata_19',['getData',['../classDObject.html#a4862655c3634d019b0a45b811d6f7235',1,'DObject']]], + ['getdataas_20',['getDataAs',['../classDObject.html#aca2db093c1c8c6f7893de07544aed619',1,'DObject']]], + ['getdatatype_21',['getDataType',['../classMetadata.html#aeed7f22ccc61d9a3d6425441d381dcdc',1,'Metadata']]], + ['getdimensions_22',['getDimensions',['../classMetadata.html#a412c0c0b8754d85f9edbbdcd637f3b20',1,'Metadata']]], + ['geterrorcode_23',['getErrorCode',['../classDObject.html#afa8926d916081de72478cb8813c25e98',1,'DObject']]], + ['getheader_24',['getHeader',['../classOpatIO.html#afe725b647bc5bb802f6d711fc5dca3ab',1,'OpatIO']]], + ['getinstance_25',['getInstance',['../classConstants.html#aaa6f3af20fa563cf22df71a987923065',1,'Constants']]], + ['getmaxqdepth_26',['getMaxQDepth',['../classOpatIO.html#a48cd5e4f3fdb221bc1b6253e149e8e01',1,'OpatIO']]], + ['getopatversion_27',['getOPATVersion',['../classOpatIO.html#a2894437c09f4cdb06c9b06d6aad4bd2f',1,'OpatIO']]], + ['gettable_28',['getTable',['../classOpatIO.html#a0817f135f44e3bdc610d30df145f118d',1,'OpatIO']]], + ['gettableindex_29',['getTableIndex',['../classOpatIO.html#af0bc6bb210c4ff74bc1e043aeb252e1a',1,'OpatIO']]] ]; diff --git a/docs/html/search/all_4.js b/docs/html/search/all_4.js index e5bcacb..78362f2 100644 --- a/docs/html/search/all_4.js +++ b/docs/html/search/all_4.js @@ -1,7 +1,6 @@ var searchData= [ - ['initialize_19',['initialize',['../classconstants.html#ab08623c9c865188806b6820d3ed27fe9',1,'constants']]], - ['is_5floaded_20',['is_loaded',['../classconstants.html#ab72bcb21759e2e7f26f55f1d3454b999',1,'constants']]], - ['isdebugenabled_21',['isDebugEnabled',['../classMetadata.html#abe52c81e04665628666b4140cd346b69',1,'Metadata']]], - ['isdebuggingenabled_22',['isDebuggingEnabled',['../classDObject.html#ae47bf220fbe2173cf6933c2380035dbd',1,'DObject']]] + ['has_30',['has',['../classConstants.html#a2aa041fd223f259e55bf098c90581039',1,'Constants']]], + ['header_31',['Header',['../structHeader.html',1,'']]], + ['headersize_32',['headerSize',['../structHeader.html#af0bdf31defd5888cc8d2f7537e687917',1,'Header']]] ]; diff --git a/docs/html/search/all_5.js b/docs/html/search/all_5.js index 3236917..f987aa8 100644 --- a/docs/html/search/all_5.js +++ b/docs/html/search/all_5.js @@ -1,4 +1,7 @@ var searchData= [ - ['keys_23',['keys',['../classconstants.html#a310c5d599cf21de82eaf0abe9bc5f9a0',1,'constants']]] + ['indexoffset_33',['indexOffset',['../structHeader.html#a31039c09176a479defcbe38597eb9957',1,'Header']]], + ['isdebugenabled_34',['isDebugEnabled',['../classMetadata.html#abe52c81e04665628666b4140cd346b69',1,'Metadata']]], + ['isdebuggingenabled_35',['isDebuggingEnabled',['../classDObject.html#ae47bf220fbe2173cf6933c2380035dbd',1,'DObject']]], + ['isloaded_36',['isLoaded',['../classConstants.html#ae276dfdc0ffe75a53e3842e33ab52630',1,'Constants::isLoaded()'],['../classOpatIO.html#aba1be05d51d4b0b9e4581b95ad0e1890',1,'OpatIO::isLoaded()']]] ]; diff --git a/docs/html/search/all_6.js b/docs/html/search/all_6.js index 8f48c69..3e70c49 100644 --- a/docs/html/search/all_6.js +++ b/docs/html/search/all_6.js @@ -1,8 +1,4 @@ var searchData= [ - ['lock_24',['lock',['../classLockableDObject.html#ade38ca54703913359fc3b4366f6e292a',1,'LockableDObject']]], - ['lockabledobject_25',['LockableDObject',['../classLockableDObject.html',1,'LockableDObject'],['../classLockableDObject.html#ae1a174a2740fa053626fe2820ee0efee',1,'LockableDObject::LockableDObject()']]], - ['lockabledobject_2eh_26',['LockableDObject.h',['../LockableDObject_8h.html',1,'']]], - ['lockabledobjecttest_27',['LockableDObjectTest',['../classLockableDObjectTest.html',1,'']]], - ['lockabledobjecttest_2ecpp_28',['LockableDObjectTest.cpp',['../LockableDObjectTest_8cpp.html',1,'']]] + ['keys_37',['keys',['../classConstants.html#ab9de36fa145552a3e7964e7e85a67149',1,'Constants']]] ]; diff --git a/docs/html/search/all_7.js b/docs/html/search/all_7.js index 73cf0b3..55692eb 100644 --- a/docs/html/search/all_7.js +++ b/docs/html/search/all_7.js @@ -1,8 +1,14 @@ var searchData= [ - ['metadata_29',['Metadata',['../classMetadata.html',1,'Metadata'],['../classMetadata.html#ae849560667461008cb72e83919c20be0',1,'Metadata::Metadata()=default'],['../classMetadata.html#a3d56c8c5adee4b8c7d2089802211522b',1,'Metadata::Metadata(std::size_t byteSize, std::string dataType, std::vector< std::size_t > dimensions, bool debugFlag=false)']]], - ['metadata_2ecpp_30',['Metadata.cpp',['../Metadata_8cpp.html',1,'']]], - ['metadata_2eh_31',['Metadata.h',['../Metadata_8h.html',1,'']]], - ['metadatatest_32',['MetadataTest',['../classMetadataTest.html',1,'']]], - ['metadatatest_2ecpp_33',['MetadataTest.cpp',['../MetadataTest_8cpp.html',1,'']]] + ['load_38',['load',['../classOpatIO.html#a3578ac9bad40dd45ada3459f92a93b56',1,'OpatIO']]], + ['lock_39',['lock',['../classLockableDObject.html#ade38ca54703913359fc3b4366f6e292a',1,'LockableDObject']]], + ['lockabledobject_40',['LockableDObject',['../classLockableDObject.html',1,'LockableDObject'],['../classLockableDObject.html#ae1a174a2740fa053626fe2820ee0efee',1,'LockableDObject::LockableDObject()']]], + ['lockabledobject_2eh_41',['LockableDObject.h',['../LockableDObject_8h.html',1,'']]], + ['lockabledobjecttest_42',['LockableDObjectTest',['../classLockableDObjectTest.html',1,'']]], + ['lockabledobjecttest_2ecpp_43',['LockableDObjectTest.cpp',['../LockableDObjectTest_8cpp.html',1,'']]], + ['logkappa_44',['logKappa',['../structOPATTable.html#aee4e3713cffa0ed0a5bd79e2dec97d6e',1,'OPATTable']]], + ['logr_45',['logR',['../structOPATTable.html#afaf11794675d27e75de5233b947fced9',1,'OPATTable']]], + ['logt_46',['logT',['../structOPATTable.html#a237ed50cee8df2144a2c47b5ffa443d3',1,'OPATTable']]], + ['lookupclosesttableid_47',['lookupClosestTableID',['../classOpatIO.html#af870ebd76bef969fa1f7c8270ac25cd8',1,'OpatIO']]], + ['lookuptableid_48',['lookupTableID',['../classOpatIO.html#a37959ed6845e09302bb8c206e3e006e4',1,'OpatIO']]] ]; diff --git a/docs/html/search/all_8.js b/docs/html/search/all_8.js index 32878f8..37acc8e 100644 --- a/docs/html/search/all_8.js +++ b/docs/html/search/all_8.js @@ -1,4 +1,9 @@ var searchData= [ - ['name_34',['name',['../structconstant.html#af52cfa5a80b3641881d45eef6d597510',1,'constant']]] + ['magic_49',['magic',['../structHeader.html#a87c9fc5b27c41fe65698f8538c23b182',1,'Header']]], + ['metadata_50',['Metadata',['../classMetadata.html',1,'Metadata'],['../classMetadata.html#ae849560667461008cb72e83919c20be0',1,'Metadata::Metadata()=default'],['../classMetadata.html#a3d56c8c5adee4b8c7d2089802211522b',1,'Metadata::Metadata(std::size_t byteSize, std::string dataType, std::vector< std::size_t > dimensions, bool debugFlag=false)']]], + ['metadata_2ecpp_51',['Metadata.cpp',['../Metadata_8cpp.html',1,'']]], + ['metadata_2eh_52',['Metadata.h',['../Metadata_8h.html',1,'']]], + ['metadatatest_53',['MetadataTest',['../classMetadataTest.html',1,'']]], + ['metadatatest_2ecpp_54',['MetadataTest.cpp',['../MetadataTest_8cpp.html',1,'']]] ]; diff --git a/docs/html/search/all_9.js b/docs/html/search/all_9.js index f36e7ea..4da262b 100644 --- a/docs/html/search/all_9.js +++ b/docs/html/search/all_9.js @@ -1,5 +1,7 @@ var searchData= [ - ['operator_3c_3c_35',['operator<<',['../classDObject.html#a5b2896a287295bf59a0b9e4d0af21161',1,'DObject::operator<<()'],['../classMetadata.html#a9bc49cc23da2d1ff8b3e197630b9dfd2',1,'Metadata::operator<<()'],['../DObject_8cpp.html#a5b2896a287295bf59a0b9e4d0af21161',1,'operator<<(std::ostream &os, const DObject &obj): DObject.cpp'],['../Metadata_8cpp.html#a9bc49cc23da2d1ff8b3e197630b9dfd2',1,'operator<<(std::ostream &os, const Metadata &metadata): Metadata.cpp']]], - ['operator_5b_5d_36',['operator[]',['../classconstants.html#a32d515b1f539f6fdfc654ed5c8cba8e0',1,'constants']]] + ['n_5fr_55',['N_R',['../structOPATTable.html#a70b70699726b2f77b486702e913a164b',1,'OPATTable']]], + ['n_5ft_56',['N_T',['../structOPATTable.html#a87cc2d8e225e5e9c567602d779aec88f',1,'OPATTable']]], + ['name_57',['name',['../structConstant.html#a8d8d2a81e9a8f36dfa02b4d23a5be55c',1,'Constant']]], + ['numtables_58',['numTables',['../structHeader.html#a162ced3913c3373d6d54c32274b99d72',1,'Header']]] ]; diff --git a/docs/html/search/classes_0.js b/docs/html/search/classes_0.js index fdce1b9..323e64c 100644 --- a/docs/html/search/classes_0.js +++ b/docs/html/search/classes_0.js @@ -1,7 +1,6 @@ var searchData= [ - ['cell_56',['Cell',['../classCell.html',1,'']]], - ['constant_57',['constant',['../structconstant.html',1,'']]], - ['constants_58',['constants',['../classconstants.html',1,'']]], - ['consttest_59',['constTest',['../classconstTest.html',1,'']]] + ['constant_98',['Constant',['../structConstant.html',1,'']]], + ['constants_99',['Constants',['../classConstants.html',1,'']]], + ['consttest_100',['constTest',['../classconstTest.html',1,'']]] ]; diff --git a/docs/html/search/classes_1.js b/docs/html/search/classes_1.js index 26f83f2..5f94bee 100644 --- a/docs/html/search/classes_1.js +++ b/docs/html/search/classes_1.js @@ -1,5 +1,5 @@ var searchData= [ - ['dobject_60',['DObject',['../classDObject.html',1,'']]], - ['dobjecttest_61',['DObjectTest',['../classDObjectTest.html',1,'']]] + ['dobject_101',['DObject',['../classDObject.html',1,'']]], + ['dobjecttest_102',['DObjectTest',['../classDObjectTest.html',1,'']]] ]; diff --git a/docs/html/search/classes_2.js b/docs/html/search/classes_2.js index a45ce22..4c2f8c0 100644 --- a/docs/html/search/classes_2.js +++ b/docs/html/search/classes_2.js @@ -1,5 +1,4 @@ var searchData= [ - ['lockabledobject_62',['LockableDObject',['../classLockableDObject.html',1,'']]], - ['lockabledobjecttest_63',['LockableDObjectTest',['../classLockableDObjectTest.html',1,'']]] + ['header_103',['Header',['../structHeader.html',1,'']]] ]; diff --git a/docs/html/search/files_0.js b/docs/html/search/files_0.js index 736849e..0e30d77 100644 --- a/docs/html/search/files_0.js +++ b/docs/html/search/files_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['consttest_2ecpp_66',['constTest.cpp',['../constTest_8cpp.html',1,'']]] + ['consttest_2ecpp_112',['constTest.cpp',['../constTest_8cpp.html',1,'']]] ]; diff --git a/docs/html/search/files_1.js b/docs/html/search/files_1.js index 18385c0..e33fbf5 100644 --- a/docs/html/search/files_1.js +++ b/docs/html/search/files_1.js @@ -1,6 +1,6 @@ var searchData= [ - ['dobject_2ecpp_67',['DObject.cpp',['../DObject_8cpp.html',1,'']]], - ['dobject_2eh_68',['DObject.h',['../DObject_8h.html',1,'']]], - ['dobjecttest_2ecpp_69',['DObjectTest.cpp',['../DObjectTest_8cpp.html',1,'']]] + ['dobject_2ecpp_113',['DObject.cpp',['../DObject_8cpp.html',1,'']]], + ['dobject_2eh_114',['DObject.h',['../DObject_8h.html',1,'']]], + ['dobjecttest_2ecpp_115',['DObjectTest.cpp',['../DObjectTest_8cpp.html',1,'']]] ]; diff --git a/docs/html/search/files_2.js b/docs/html/search/files_2.js index b3f5f79..a043da4 100644 --- a/docs/html/search/files_2.js +++ b/docs/html/search/files_2.js @@ -1,5 +1,5 @@ var searchData= [ - ['lockabledobject_2eh_70',['LockableDObject.h',['../LockableDObject_8h.html',1,'']]], - ['lockabledobjecttest_2ecpp_71',['LockableDObjectTest.cpp',['../LockableDObjectTest_8cpp.html',1,'']]] + ['lockabledobject_2eh_116',['LockableDObject.h',['../LockableDObject_8h.html',1,'']]], + ['lockabledobjecttest_2ecpp_117',['LockableDObjectTest.cpp',['../LockableDObjectTest_8cpp.html',1,'']]] ]; diff --git a/docs/html/search/functions_0.js b/docs/html/search/functions_0.js index cb2e396..40c3e0d 100644 --- a/docs/html/search/functions_0.js +++ b/docs/html/search/functions_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['constants_75',['constants',['../classconstants.html#a9be0748cd713f4a465b548e0c44458ee',1,'constants::constants()'],['../classconstants.html#a10550367b0875a0767b01d4970cc0a30',1,'constants::constants(const std::string &filename)']]] + ['constant_122',['Constant',['../structConstant.html#a84ca5b6951cc8a8eccd083894302a857',1,'Constant']]] ]; diff --git a/docs/html/search/functions_1.js b/docs/html/search/functions_1.js index 5ff185b..acb73a8 100644 --- a/docs/html/search/functions_1.js +++ b/docs/html/search/functions_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['dobject_76',['DObject',['../classDObject.html#a0ae54853e18265657296bfb5ac3bf9d0',1,'DObject::DObject()'],['../classDObject.html#a598321f3b8524b98df72393c04d7470c',1,'DObject::DObject(const DataType &data)']]] + ['dobject_123',['DObject',['../classDObject.html#a0ae54853e18265657296bfb5ac3bf9d0',1,'DObject::DObject()'],['../classDObject.html#a598321f3b8524b98df72393c04d7470c',1,'DObject::DObject(const DataType &data)']]] ]; diff --git a/docs/html/search/functions_2.js b/docs/html/search/functions_2.js index 1eb2f0d..1672899 100644 --- a/docs/html/search/functions_2.js +++ b/docs/html/search/functions_2.js @@ -1,10 +1,19 @@ var searchData= [ - ['get_77',['get',['../classconstants.html#a00666cb3d413cc53e4a3e629c2e22155',1,'constants::get()'],['../classLockableDObject.html#adcfe201fc728cc1c6fcf638a566ba9a1',1,'LockableDObject::get()']]], - ['getbytesize_78',['getByteSize',['../classMetadata.html#ac7980d1efdd6ae434f0115f83d08348e',1,'Metadata']]], - ['getdata_79',['getData',['../classDObject.html#a4862655c3634d019b0a45b811d6f7235',1,'DObject']]], - ['getdataas_80',['getDataAs',['../classDObject.html#aca2db093c1c8c6f7893de07544aed619',1,'DObject']]], - ['getdatatype_81',['getDataType',['../classMetadata.html#aeed7f22ccc61d9a3d6425441d381dcdc',1,'Metadata']]], - ['getdimensions_82',['getDimensions',['../classMetadata.html#a412c0c0b8754d85f9edbbdcd637f3b20',1,'Metadata']]], - ['geterrorcode_83',['getErrorCode',['../classDObject.html#afa8926d916081de72478cb8813c25e98',1,'DObject']]] + ['get_124',['get',['../classLockableDObject.html#adcfe201fc728cc1c6fcf638a566ba9a1',1,'LockableDObject::get()'],['../classConstants.html#a36ddd7fe6857d1bbf6d1c84d4ed7bc19',1,'Constants::get()']]], + ['getbytesize_125',['getByteSize',['../classMetadata.html#ac7980d1efdd6ae434f0115f83d08348e',1,'Metadata']]], + ['getclosesttables_126',['getClosestTables',['../classOpatIO.html#a939e4edec4053517463f848648db770d',1,'OpatIO']]], + ['getclosestxtables_127',['getClosestXTables',['../classOpatIO.html#a83acf4fe2aec4e588453b5a39a4def1a',1,'OpatIO']]], + ['getclosestztables_128',['getClosestZTables',['../classOpatIO.html#a9d9600e7af036deeada78da9afd4b65b',1,'OpatIO']]], + ['getdata_129',['getData',['../classDObject.html#a4862655c3634d019b0a45b811d6f7235',1,'DObject']]], + ['getdataas_130',['getDataAs',['../classDObject.html#aca2db093c1c8c6f7893de07544aed619',1,'DObject']]], + ['getdatatype_131',['getDataType',['../classMetadata.html#aeed7f22ccc61d9a3d6425441d381dcdc',1,'Metadata']]], + ['getdimensions_132',['getDimensions',['../classMetadata.html#a412c0c0b8754d85f9edbbdcd637f3b20',1,'Metadata']]], + ['geterrorcode_133',['getErrorCode',['../classDObject.html#afa8926d916081de72478cb8813c25e98',1,'DObject']]], + ['getheader_134',['getHeader',['../classOpatIO.html#afe725b647bc5bb802f6d711fc5dca3ab',1,'OpatIO']]], + ['getinstance_135',['getInstance',['../classConstants.html#aaa6f3af20fa563cf22df71a987923065',1,'Constants']]], + ['getmaxqdepth_136',['getMaxQDepth',['../classOpatIO.html#a48cd5e4f3fdb221bc1b6253e149e8e01',1,'OpatIO']]], + ['getopatversion_137',['getOPATVersion',['../classOpatIO.html#a2894437c09f4cdb06c9b06d6aad4bd2f',1,'OpatIO']]], + ['gettable_138',['getTable',['../classOpatIO.html#a0817f135f44e3bdc610d30df145f118d',1,'OpatIO']]], + ['gettableindex_139',['getTableIndex',['../classOpatIO.html#af0bc6bb210c4ff74bc1e043aeb252e1a',1,'OpatIO']]] ]; diff --git a/docs/html/search/functions_3.js b/docs/html/search/functions_3.js index 314b842..6fd270d 100644 --- a/docs/html/search/functions_3.js +++ b/docs/html/search/functions_3.js @@ -1,4 +1,4 @@ var searchData= [ - ['has_84',['has',['../classconstants.html#a35dcd5bb493bc095330b177819242c93',1,'constants']]] + ['has_140',['has',['../classConstants.html#a2aa041fd223f259e55bf098c90581039',1,'Constants']]] ]; diff --git a/docs/html/search/functions_4.js b/docs/html/search/functions_4.js index edb493c..cae0e1f 100644 --- a/docs/html/search/functions_4.js +++ b/docs/html/search/functions_4.js @@ -1,7 +1,6 @@ var searchData= [ - ['initialize_85',['initialize',['../classconstants.html#ab08623c9c865188806b6820d3ed27fe9',1,'constants']]], - ['is_5floaded_86',['is_loaded',['../classconstants.html#ab72bcb21759e2e7f26f55f1d3454b999',1,'constants']]], - ['isdebugenabled_87',['isDebugEnabled',['../classMetadata.html#abe52c81e04665628666b4140cd346b69',1,'Metadata']]], - ['isdebuggingenabled_88',['isDebuggingEnabled',['../classDObject.html#ae47bf220fbe2173cf6933c2380035dbd',1,'DObject']]] + ['isdebugenabled_141',['isDebugEnabled',['../classMetadata.html#abe52c81e04665628666b4140cd346b69',1,'Metadata']]], + ['isdebuggingenabled_142',['isDebuggingEnabled',['../classDObject.html#ae47bf220fbe2173cf6933c2380035dbd',1,'DObject']]], + ['isloaded_143',['isLoaded',['../classConstants.html#ae276dfdc0ffe75a53e3842e33ab52630',1,'Constants::isLoaded()'],['../classOpatIO.html#aba1be05d51d4b0b9e4581b95ad0e1890',1,'OpatIO::isLoaded()']]] ]; diff --git a/docs/html/search/functions_5.js b/docs/html/search/functions_5.js index 9adac97..860a5b7 100644 --- a/docs/html/search/functions_5.js +++ b/docs/html/search/functions_5.js @@ -1,4 +1,4 @@ var searchData= [ - ['keys_89',['keys',['../classconstants.html#a310c5d599cf21de82eaf0abe9bc5f9a0',1,'constants']]] + ['keys_144',['keys',['../classConstants.html#ab9de36fa145552a3e7964e7e85a67149',1,'Constants']]] ]; diff --git a/docs/html/search/functions_6.js b/docs/html/search/functions_6.js index f11ec4a..817dbc1 100644 --- a/docs/html/search/functions_6.js +++ b/docs/html/search/functions_6.js @@ -1,5 +1,8 @@ var searchData= [ - ['lock_90',['lock',['../classLockableDObject.html#ade38ca54703913359fc3b4366f6e292a',1,'LockableDObject']]], - ['lockabledobject_91',['LockableDObject',['../classLockableDObject.html#ae1a174a2740fa053626fe2820ee0efee',1,'LockableDObject']]] + ['load_145',['load',['../classOpatIO.html#a3578ac9bad40dd45ada3459f92a93b56',1,'OpatIO']]], + ['lock_146',['lock',['../classLockableDObject.html#ade38ca54703913359fc3b4366f6e292a',1,'LockableDObject']]], + ['lockabledobject_147',['LockableDObject',['../classLockableDObject.html#ae1a174a2740fa053626fe2820ee0efee',1,'LockableDObject']]], + ['lookupclosesttableid_148',['lookupClosestTableID',['../classOpatIO.html#af870ebd76bef969fa1f7c8270ac25cd8',1,'OpatIO']]], + ['lookuptableid_149',['lookupTableID',['../classOpatIO.html#a37959ed6845e09302bb8c206e3e006e4',1,'OpatIO']]] ]; diff --git a/docs/html/search/functions_7.js b/docs/html/search/functions_7.js index 5983282..4b49a83 100644 --- a/docs/html/search/functions_7.js +++ b/docs/html/search/functions_7.js @@ -1,4 +1,4 @@ var searchData= [ - ['metadata_92',['Metadata',['../classMetadata.html#ae849560667461008cb72e83919c20be0',1,'Metadata::Metadata()=default'],['../classMetadata.html#a3d56c8c5adee4b8c7d2089802211522b',1,'Metadata::Metadata(std::size_t byteSize, std::string dataType, std::vector< std::size_t > dimensions, bool debugFlag=false)']]] + ['metadata_150',['Metadata',['../classMetadata.html#ae849560667461008cb72e83919c20be0',1,'Metadata::Metadata()=default'],['../classMetadata.html#a3d56c8c5adee4b8c7d2089802211522b',1,'Metadata::Metadata(std::size_t byteSize, std::string dataType, std::vector< std::size_t > dimensions, bool debugFlag=false)']]] ]; diff --git a/docs/html/search/functions_8.js b/docs/html/search/functions_8.js index afd5d7d..f0f0e54 100644 --- a/docs/html/search/functions_8.js +++ b/docs/html/search/functions_8.js @@ -1,5 +1,6 @@ var searchData= [ - ['operator_3c_3c_93',['operator<<',['../DObject_8cpp.html#a5b2896a287295bf59a0b9e4d0af21161',1,'operator<<(std::ostream &os, const DObject &obj): DObject.cpp'],['../Metadata_8cpp.html#a9bc49cc23da2d1ff8b3e197630b9dfd2',1,'operator<<(std::ostream &os, const Metadata &metadata): Metadata.cpp']]], - ['operator_5b_5d_94',['operator[]',['../classconstants.html#a32d515b1f539f6fdfc654ed5c8cba8e0',1,'constants']]] + ['opatio_151',['OpatIO',['../classOpatIO.html#a7f3436b3ac0dbe141b08d8064550f1b3',1,'OpatIO::OpatIO()'],['../classOpatIO.html#ae24b6a4f78529c4fe4719ea5438d5ed6',1,'OpatIO::OpatIO(std::string filename)']]], + ['operator_3c_3c_152',['operator<<',['../DObject_8cpp.html#a5b2896a287295bf59a0b9e4d0af21161',1,'operator<<(std::ostream &os, const DObject &obj): DObject.cpp'],['../Metadata_8cpp.html#a9bc49cc23da2d1ff8b3e197630b9dfd2',1,'operator<<(std::ostream &os, const Metadata &metadata): Metadata.cpp']]], + ['operator_5b_5d_153',['operator[]',['../classConstants.html#ad75620743b867fc20d4a05027d1a1c01',1,'Constants']]] ]; diff --git a/docs/html/search/related_0.js b/docs/html/search/related_0.js index 3c77549..00715f2 100644 --- a/docs/html/search/related_0.js +++ b/docs/html/search/related_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['operator_3c_3c_115',['operator<<',['../classDObject.html#a5b2896a287295bf59a0b9e4d0af21161',1,'DObject::operator<<()'],['../classMetadata.html#a9bc49cc23da2d1ff8b3e197630b9dfd2',1,'Metadata::operator<<()']]] + ['operator_3c_3c_200',['operator<<',['../structConstant.html#ad298f7af7cdfd2e2267fd9e464558e2b',1,'Constant::operator<<()'],['../classDObject.html#a5b2896a287295bf59a0b9e4d0af21161',1,'DObject::operator<<()'],['../classMetadata.html#a9bc49cc23da2d1ff8b3e197630b9dfd2',1,'Metadata::operator<<()']]] ]; diff --git a/docs/html/search/searchdata.js b/docs/html/search/searchdata.js index b35ab66..95e74fb 100644 --- a/docs/html/search/searchdata.js +++ b/docs/html/search/searchdata.js @@ -1,10 +1,10 @@ var indexSectionsWithContent = { - 0: "cdghiklmnoprstuv", - 1: "cdlm", - 2: "cdlm", - 3: "cdghiklmorstu", - 4: "nruv", + 0: "bcdghiklmnoprstuvxz~", + 1: "cdhlmot", + 2: "cdlmo", + 3: "cdghiklmoprstu~", + 4: "bchilmnrsuvxz", 5: "dp", 6: "o", 7: "t" diff --git a/docs/html/search/typedefs_0.js b/docs/html/search/typedefs_0.js index 4274e36..6438974 100644 --- a/docs/html/search/typedefs_0.js +++ b/docs/html/search/typedefs_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['datatype_113',['DataType',['../classDObject.html#a79a2ecac4130ef3df272bdfeed26a620',1,'DObject']]] + ['datatype_198',['DataType',['../classDObject.html#a79a2ecac4130ef3df272bdfeed26a620',1,'DObject']]] ]; diff --git a/docs/html/search/typedefs_1.js b/docs/html/search/typedefs_1.js index 1428905..cba1077 100644 --- a/docs/html/search/typedefs_1.js +++ b/docs/html/search/typedefs_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['plugin_114',['Plugin',['../classDObject.html#af11334d08ef85c68b3aae7554548e5a7',1,'DObject']]] + ['plugin_199',['Plugin',['../classDObject.html#af11334d08ef85c68b3aae7554548e5a7',1,'DObject']]] ]; diff --git a/docs/latex/annotated.tex b/docs/latex/annotated.tex index e1886c5..de9ce65 100644 --- a/docs/latex/annotated.tex +++ b/docs/latex/annotated.tex @@ -1,13 +1,17 @@ \doxysection{Class List} Here are the classes, structs, unions and interfaces with brief descriptions\+:\begin{DoxyCompactList} -\item\contentsline{section}{\mbox{\hyperlink{classCell}{Cell}} }{\pageref{classCell}}{} -\item\contentsline{section}{\mbox{\hyperlink{structconstant}{constant}} \\*Structure to hold a constant\textquotesingle{}s details }{\pageref{structconstant}}{} -\item\contentsline{section}{\mbox{\hyperlink{classconstants}{constants}} \\*Class to manage a collection of constants }{\pageref{classconstants}}{} +\item\contentsline{section}{\mbox{\hyperlink{structConstant}{Constant}} \\*Structure to hold a constant\textquotesingle{}s details }{\pageref{structConstant}}{} +\item\contentsline{section}{\mbox{\hyperlink{classConstants}{Constants}} \\*Class to manage a collection of constants }{\pageref{classConstants}}{} \item\contentsline{section}{\mbox{\hyperlink{classconstTest}{const\+Test}} \\*Test suite for the const class }{\pageref{classconstTest}}{} \item\contentsline{section}{\mbox{\hyperlink{classDObject}{DObject}} \\*A universal data container class }{\pageref{classDObject}}{} \item\contentsline{section}{\mbox{\hyperlink{classDObjectTest}{DObject\+Test}} \\*Test suite for the \mbox{\hyperlink{classDObject}{DObject}} class }{\pageref{classDObjectTest}}{} +\item\contentsline{section}{\mbox{\hyperlink{structHeader}{Header}} \\*Structure to hold the header information of an OPAT file }{\pageref{structHeader}}{} \item\contentsline{section}{\mbox{\hyperlink{classLockableDObject}{Lockable\+DObject}} \\*Wrapper for \mbox{\hyperlink{classDObject}{DObject}} with thread-\/safe access }{\pageref{classLockableDObject}}{} \item\contentsline{section}{\mbox{\hyperlink{classLockableDObjectTest}{Lockable\+DObject\+Test}} \\*Test suite for the \mbox{\hyperlink{classLockableDObject}{Lockable\+DObject}} class }{\pageref{classLockableDObjectTest}}{} \item\contentsline{section}{\mbox{\hyperlink{classMetadata}{Metadata}} \\*Represents metadata information for data objects in the dobj module }{\pageref{classMetadata}}{} \item\contentsline{section}{\mbox{\hyperlink{classMetadataTest}{Metadata\+Test}} \\*Test suite for the \mbox{\hyperlink{classMetadata}{Metadata}} class }{\pageref{classMetadataTest}}{} +\item\contentsline{section}{\mbox{\hyperlink{classOpatIO}{Opat\+IO}} \\*Class to manage the input/output operations for OPAT files }{\pageref{classOpatIO}}{} +\item\contentsline{section}{\mbox{\hyperlink{classopatIOTest}{opat\+IOTest}} \\*Test suite for the const class }{\pageref{classopatIOTest}}{} +\item\contentsline{section}{\mbox{\hyperlink{structOPATTable}{OPATTable}} \\*Structure to hold the data of an OPAT table }{\pageref{structOPATTable}}{} +\item\contentsline{section}{\mbox{\hyperlink{structTableIndex}{Table\+Index}} \\*Structure to hold the index information of a table in an OPAT file }{\pageref{structTableIndex}}{} \end{DoxyCompactList} diff --git a/docs/latex/files.tex b/docs/latex/files.tex index 54ea8c7..400c489 100644 --- a/docs/latex/files.tex +++ b/docs/latex/files.tex @@ -6,12 +6,11 @@ Here is a list of all documented files with brief descriptions\+:\begin{DoxyComp \item\contentsline{section}{src/dobj/public/\mbox{\hyperlink{DObject_8h}{DObject.\+h}} \\*Defines the \mbox{\hyperlink{classDObject}{DObject}} class, a universal data container for the project }{\pageref{DObject_8h}}{} \item\contentsline{section}{src/dobj/public/\mbox{\hyperlink{LockableDObject_8h}{Lockable\+DObject.\+h}} \\*A lightweight wrapper for \mbox{\hyperlink{classDObject}{DObject}} that adds locking capabilities }{\pageref{LockableDObject_8h}}{} \item\contentsline{section}{src/dobj/public/\mbox{\hyperlink{Metadata_8h}{Metadata.\+h}} \\*Public interface for the \mbox{\hyperlink{classMetadata}{Metadata}} class used in the dobj module }{\pageref{Metadata_8h}}{} -\item\contentsline{section}{src/mapping/private/{\bfseries grid.\+h} }{\pageref{grid_8h}}{} -\item\contentsline{section}{src/mapping/private/{\bfseries mapper.\+h} }{\pageref{mapper_8h}}{} -\item\contentsline{section}{src/mesh/public/{\bfseries mesh.\+h} }{\pageref{mesh_8h}}{} \item\contentsline{section}{src/opac/public/{\bfseries opac.\+h} }{\pageref{opac_8h}}{} +\item\contentsline{section}{src/opat\+IO/public/{\bfseries opat\+IO.\+h} }{\pageref{opatIO_8h}}{} \item\contentsline{section}{tests/const/\mbox{\hyperlink{constTest_8cpp}{const\+Test.\+cpp}} \\*Unit tests for the const class }{\pageref{constTest_8cpp}}{} \item\contentsline{section}{tests/dobj/\mbox{\hyperlink{DObjectTest_8cpp}{DObject\+Test.\+cpp}} \\*Unit tests for the \mbox{\hyperlink{classDObject}{DObject}} class }{\pageref{DObjectTest_8cpp}}{} \item\contentsline{section}{tests/dobj/\mbox{\hyperlink{LockableDObjectTest_8cpp}{Lockable\+DObject\+Test.\+cpp}} \\*Unit tests for the \mbox{\hyperlink{classLockableDObject}{Lockable\+DObject}} class }{\pageref{LockableDObjectTest_8cpp}}{} \item\contentsline{section}{tests/dobj/\mbox{\hyperlink{MetadataTest_8cpp}{Metadata\+Test.\+cpp}} \\*Unit tests and integration tests for the \mbox{\hyperlink{classMetadata}{Metadata}} class }{\pageref{MetadataTest_8cpp}}{} +\item\contentsline{section}{tests/opat\+IO/\mbox{\hyperlink{opatIOTest_8cpp}{opat\+IOTest.\+cpp}} \\*Unit tests for the \mbox{\hyperlink{classOpatIO}{Opat\+IO}} class and associated structs }{\pageref{opatIOTest_8cpp}}{} \end{DoxyCompactList} diff --git a/docs/latex/refman.tex b/docs/latex/refman.tex index 4048eaf..8e61ba6 100644 --- a/docs/latex/refman.tex +++ b/docs/latex/refman.tex @@ -182,16 +182,20 @@ \chapter{File Index} \input{files} \chapter{Class Documentation} -\input{classCell} -\input{structconstant} -\input{classconstants} +\input{structConstant} +\input{classConstants} \input{classconstTest} \input{classDObject} \input{classDObjectTest} +\input{structHeader} \input{classLockableDObject} \input{classLockableDObjectTest} \input{classMetadata} \input{classMetadataTest} +\input{classOpatIO} +\input{classopatIOTest} +\input{structOPATTable} +\input{structTableIndex} \chapter{File Documentation} \input{DObject_8cpp} \input{Metadata_8cpp} @@ -202,6 +206,7 @@ \input{DObjectTest_8cpp} \input{LockableDObjectTest_8cpp} \input{MetadataTest_8cpp} +\input{opatIOTest_8cpp} %--- End generated contents --- % Index diff --git a/src/opatIO/public/opatIO.h b/src/opatIO/public/opatIO.h index 1da6ee9..62ffe0f 100644 --- a/src/opatIO/public/opatIO.h +++ b/src/opatIO/public/opatIO.h @@ -9,93 +9,264 @@ #include #include +/** + * @brief Structure to hold the header information of an OPAT file. + */ #pragma pack(1) struct Header { - char magic[4]; - uint16_t version; - uint32_t numTables; - uint32_t headerSize; - uint64_t indexOffset; - char creationDate[16]; - char sourceInfo[64]; - char comment[128]; - char reserved[26]; + char magic[4]; ///< Magic number to identify the file type + uint16_t version; ///< Version of the OPAT file format + uint32_t numTables; ///< Number of tables in the file + uint32_t headerSize; ///< Size of the header + uint64_t indexOffset; ///< Offset to the index section + char creationDate[16]; ///< Creation date of the file + char sourceInfo[64]; ///< Source information + char comment[128]; ///< Comment section + char reserved[26]; ///< Reserved for future use }; - #pragma pack() + +/** + * @brief Structure to hold the index information of a table in an OPAT file. + */ struct TableIndex { - double X; - double Z; - // double C; // For type 2 OPAL tables. When not set will be 0 - // double O; // For type 2 OPAL tables. When not set will be 0 - uint64_t byteStart; - uint64_t byteEnd; - char sha256[32]; + double X; ///< X composition value + double Z; ///< Z composition value + uint64_t byteStart; ///< Byte start position of the table + uint64_t byteEnd; ///< Byte end position of the table + char sha256[32]; ///< SHA-256 hash of the table data }; +/** + * @brief Structure to hold the data of an OPAT table. + */ struct OPATTable { - uint32_t N_R; - uint32_t N_T; - std::vector logR; - std::vector logT; - std::vector> logKappa; + uint32_t N_R; ///< Number of R values + uint32_t N_T; ///< Number of T values + std::vector logR; ///< Logarithm of R values + std::vector logT; ///< Logarithm of T values + std::vector> logKappa; ///< Logarithm of Kappa values }; class opatIOTest; // Friend for gtest +/** + * @brief Class to manage the input/output operations for OPAT files. + */ class OpatIO { private: - Header header; - std::vector tableIndex; - std::deque> tableQueue; - std::map> tableIDToComposition; - std::pair XZepsilon; - int maxQDepth = 10; - std::string filename; - bool loaded = false; + Header header; ///< Header information of the OPAT file + std::vector tableIndex; ///< Index information of the tables + std::deque> tableQueue; ///< Queue to manage table caching + std::map> tableIDToComposition; ///< Map to store table ID to composition mapping + std::pair XZepsilon; ///< Epsilon values for X and Z + int maxQDepth = 10; ///< Maximum depth of the table queue + std::string filename; ///< Filename of the OPAT file + bool loaded = false; ///< Flag to indicate if the file is loaded + /** + * @brief Read the header from the file. + * @param file The input file stream. + */ void readHeader(std::ifstream &file); + + /** + * @brief Read the table index from the file. + * @param file The input file stream. + */ void readTableIndex(std::ifstream &file); + /** + * @brief Get a table from the queue. + * @param tableID The ID of the table. + * @return The OPAT table. + */ OPATTable getTableFromQueue(int tableID); + + /** + * @brief Add a table to the queue. + * @param tableID The ID of the table. + * @param table The OPAT table. + */ void addTableToQueue(int tableID, OPATTable table); + + /** + * @brief Remove a table from the queue. + */ void removeTableFromQueue(); + + /** + * @brief Flush the table queue. + */ void flushQueue(); + /** + * @brief Get a table by its ID. + * @param tableID The ID of the table. + * @return The OPAT table. + */ OPATTable getTable(int tableID); + + /** + * @brief Print a table. + * @param table The OPAT table. + * @param truncateDigits Number of digits to truncate. + */ void printTable(OPATTable table, uint32_t truncateDigits=5); + /** + * @brief Lookup epsilon values for X and Z. + */ void XZLookupEpsilon(); + + /** + * @brief Build the table ID to composition mapping. + */ void buildTableIDToComposition(); public: + /** + * @brief Default constructor. + */ OpatIO(); + + /** + * @brief Constructor with filename. + * @param filename The name of the OPAT file. + */ OpatIO(std::string filename); + + /** + * @brief Destructor. + */ ~OpatIO(); + /** + * @brief Get a table by X and Z values. + * @param X The X composition value. + * @param Z The Z composition value. + * @return The OPAT table. + */ OPATTable getTable(double X, double Z); + + /** + * @brief Set the maximum depth of the table queue. + * @param depth The maximum depth. + */ void setMaxQDepth(int depth); + + /** + * @brief Get the maximum depth of the table queue. + * @return The maximum depth. + */ int getMaxQDepth(); + + /** + * @brief Set the filename of the OPAT file. + * @param filename The name of the file. + */ void setFilename(std::string filename); + + /** + * @brief Load the OPAT file. + */ void load(); + + /** + * @brief Unload the OPAT file. + */ void unload(); + + /** + * @brief Check if the file is loaded. + * @return True if the file is loaded, false otherwise. + */ bool isLoaded(); + /** + * @brief Print the header information. + */ void printHeader(); + + /** + * @brief Print the table index. + */ void printTableIndex(); + + /** + * @brief Print a table by X and Z values. + * @param X The X composition value. + * @param Z The Z composition value. + * @param truncateDigits Number of digits to truncate. + */ void printTable(double X, double Z, uint32_t truncateDigits=5); + /** + * @brief Get the table index. + * @return A vector of TableIndex structures. + */ std::vector getTableIndex(); + + /** + * @brief Get the header information. + * @return The Header structure. + */ Header getHeader(); + /** + * @brief Get the closest tables by X value. + * @param X The X composition value. + * @param ZExact The exact Z composition value. + * @param C The C composition value (default is 0). + * @param O The O composition value (default is 0). + * @param numTables The number of closest tables to retrieve (default is 1). + * @return A vector of OPAT tables. + */ std::vector getClosestXTables(double X, double ZExact, double C=0, double O=0, int numTables=1); - std::vector getClosestZTables(double XExact, double Z, double C=0, double O=0, int numTables=1); - std::vector getClosestTables(double X, double Z, double C=0, double O=0, int numTables=1); + /** + * @brief Get the closest tables by Z value. + * @param XExact The exact X composition value. + * @param Z The Z composition value. + * @param C The C composition value (default is 0). + * @param O The O composition value (default is 0). + * @param numTables The number of closest tables to retrieve (default is 1). + * @return A vector of OPAT tables. + */ + std::vector getClosestZTables(double XExact, double Z, double C=0, double O=0, int numTables=1); + + /** + * @brief Get the closest tables by X and Z values. + * @param X The X composition value. + * @param Z The Z composition value. + * @param C The C composition value (default is 0). + * @param O The O composition value (default is 0). + * @param numTables The number of closest tables to retrieve (default is 1). + * @return A vector of OPAT tables. + */ + std::vector getClosestTables(double X, double Z, double C=0, double O=0, int numTables=1); + + /** + * @brief Lookup the table ID by X and Z values. + * @param X The X composition value. + * @param Z The Z composition value. + * @return The table ID. + */ int lookupTableID(double X, double Z); + + /** + * @brief Lookup the closest table ID by X and Z values. + * @param X The X composition value. + * @param Z The Z composition value. + * @return The closest table ID. + */ int lookupClosestTableID(double X, double Z); + + /** + * @brief Get the version of the OPAT file format. + * @return The version of the OPAT file format. + */ uint16_t getOPATVersion(); }; - #endif \ No newline at end of file