tboudreaux/SERiF
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(opatIO): wrote and built doxygen docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-02-16 12:29:51 -05:00
parent 5ce365d545
commit 0d5406aeee
44 changed files with 711 additions and 243 deletions
Download Patch File Download Diff File Expand all files Collapse all files

166
docs/html/functions.html
View File

@@ -94,9 +94,25 @@ $(document).ready(function(){initNavTree('functions.html',''); initResizable();
<div class="contents">
<div class="textblock">Here is a list of all documented class members with links to the class documentation for each member:</div>
<h3><a id="index_b"></a>- b -</h3><ul>
<li>byteEnd
: <a class="el" href="structTableIndex.html#a69c87fd1cb0b7a64a82c52c54193e5e6">TableIndex</a>
</li>
<li>byteStart
: <a class="el" href="structTableIndex.html#ad899cf13056eb17b33e1c5e303e10132">TableIndex</a>
</li>
</ul>
<h3><a id="index_c"></a>- c -</h3><ul>
<li>constants()
: <a class="el" href="classconstants.html#a9be0748cd713f4a465b548e0c44458ee">constants</a>
<li>comment
: <a class="el" href="structHeader.html#a122331824871070af2c6cebc9698abd8">Header</a>
</li>
<li>Constant()
: <a class="el" href="structConstant.html#a84ca5b6951cc8a8eccd083894302a857">Constant</a>
</li>
<li>creationDate
: <a class="el" href="structHeader.html#a83f52dffac0449704ef1a50a5e787e92">Header</a>
</li>
</ul>
@@ -113,12 +129,21 @@ $(document).ready(function(){initNavTree('functions.html',''); initResizable();
<h3><a id="index_g"></a>- g -</h3><ul>
<li>get()
: <a class="el" href="classconstants.html#a00666cb3d413cc53e4a3e629c2e22155">constants</a>
: <a class="el" href="classConstants.html#a36ddd7fe6857d1bbf6d1c84d4ed7bc19">Constants</a>
, <a class="el" href="classLockableDObject.html#adcfe201fc728cc1c6fcf638a566ba9a1">LockableDObject</a>
</li>
<li>getByteSize()
: <a class="el" href="classMetadata.html#ac7980d1efdd6ae434f0115f83d08348e">Metadata</a>
</li>
<li>getClosestTables()
: <a class="el" href="classOpatIO.html#a939e4edec4053517463f848648db770d">OpatIO</a>
</li>
<li>getClosestXTables()
: <a class="el" href="classOpatIO.html#a83acf4fe2aec4e588453b5a39a4def1a">OpatIO</a>
</li>
<li>getClosestZTables()
: <a class="el" href="classOpatIO.html#a9d9600e7af036deeada78da9afd4b65b">OpatIO</a>
</li>
<li>getData()
: <a class="el" href="classDObject.html#a4862655c3634d019b0a45b811d6f7235">DObject</a>
</li>
@@ -134,22 +159,40 @@ $(document).ready(function(){initNavTree('functions.html',''); initResizable();
<li>getErrorCode()
: <a class="el" href="classDObject.html#afa8926d916081de72478cb8813c25e98">DObject</a>
</li>
<li>getHeader()
: <a class="el" href="classOpatIO.html#afe725b647bc5bb802f6d711fc5dca3ab">OpatIO</a>
</li>
<li>getInstance()
: <a class="el" href="classConstants.html#aaa6f3af20fa563cf22df71a987923065">Constants</a>
</li>
<li>getMaxQDepth()
: <a class="el" href="classOpatIO.html#a48cd5e4f3fdb221bc1b6253e149e8e01">OpatIO</a>
</li>
<li>getOPATVersion()
: <a class="el" href="classOpatIO.html#a2894437c09f4cdb06c9b06d6aad4bd2f">OpatIO</a>
</li>
<li>getTable()
: <a class="el" href="classOpatIO.html#a0817f135f44e3bdc610d30df145f118d">OpatIO</a>
</li>
<li>getTableIndex()
: <a class="el" href="classOpatIO.html#af0bc6bb210c4ff74bc1e043aeb252e1a">OpatIO</a>
</li>
</ul>
<h3><a id="index_h"></a>- h -</h3><ul>
<li>has()
: <a class="el" href="classconstants.html#a35dcd5bb493bc095330b177819242c93">constants</a>
: <a class="el" href="classConstants.html#a2aa041fd223f259e55bf098c90581039">Constants</a>
</li>
<li>headerSize
: <a class="el" href="structHeader.html#af0bdf31defd5888cc8d2f7537e687917">Header</a>
</li>
</ul>
<h3><a id="index_i"></a>- i -</h3><ul>
<li>initialize()
: <a class="el" href="classconstants.html#ab08623c9c865188806b6820d3ed27fe9">constants</a>
</li>
<li>is_loaded()
: <a class="el" href="classconstants.html#ab72bcb21759e2e7f26f55f1d3454b999">constants</a>
<li>indexOffset
: <a class="el" href="structHeader.html#a31039c09176a479defcbe38597eb9957">Header</a>
</li>
<li>isDebugEnabled()
: <a class="el" href="classMetadata.html#abe52c81e04665628666b4140cd346b69">Metadata</a>
@@ -157,27 +200,52 @@ $(document).ready(function(){initNavTree('functions.html',''); initResizable();
<li>isDebuggingEnabled()
: <a class="el" href="classDObject.html#ae47bf220fbe2173cf6933c2380035dbd">DObject</a>
</li>
<li>isLoaded()
: <a class="el" href="classConstants.html#ae276dfdc0ffe75a53e3842e33ab52630">Constants</a>
, <a class="el" href="classOpatIO.html#aba1be05d51d4b0b9e4581b95ad0e1890">OpatIO</a>
</li>
</ul>
<h3><a id="index_k"></a>- k -</h3><ul>
<li>keys()
: <a class="el" href="classconstants.html#a310c5d599cf21de82eaf0abe9bc5f9a0">constants</a>
: <a class="el" href="classConstants.html#ab9de36fa145552a3e7964e7e85a67149">Constants</a>
</li>
</ul>
<h3><a id="index_l"></a>- l -</h3><ul>
<li>load()
: <a class="el" href="classOpatIO.html#a3578ac9bad40dd45ada3459f92a93b56">OpatIO</a>
</li>
<li>lock()
: <a class="el" href="classLockableDObject.html#ade38ca54703913359fc3b4366f6e292a">LockableDObject</a>
</li>
<li>LockableDObject()
: <a class="el" href="classLockableDObject.html#ae1a174a2740fa053626fe2820ee0efee">LockableDObject</a>
</li>
<li>logKappa
: <a class="el" href="structOPATTable.html#aee4e3713cffa0ed0a5bd79e2dec97d6e">OPATTable</a>
</li>
<li>logR
: <a class="el" href="structOPATTable.html#afaf11794675d27e75de5233b947fced9">OPATTable</a>
</li>
<li>logT
: <a class="el" href="structOPATTable.html#a237ed50cee8df2144a2c47b5ffa443d3">OPATTable</a>
</li>
<li>lookupClosestTableID()
: <a class="el" href="classOpatIO.html#af870ebd76bef969fa1f7c8270ac25cd8">OpatIO</a>
</li>
<li>lookupTableID()
: <a class="el" href="classOpatIO.html#a37959ed6845e09302bb8c206e3e006e4">OpatIO</a>
</li>
</ul>
<h3><a id="index_m"></a>- m -</h3><ul>
<li>magic
: <a class="el" href="structHeader.html#a87c9fc5b27c41fe65698f8538c23b182">Header</a>
</li>
<li>Metadata()
: <a class="el" href="classMetadata.html#ae849560667461008cb72e83919c20be0">Metadata</a>
</li>
@@ -185,19 +253,32 @@ $(document).ready(function(){initNavTree('functions.html',''); initResizable();
<h3><a id="index_n"></a>- n -</h3><ul>
<li>N_R
: <a class="el" href="structOPATTable.html#a70b70699726b2f77b486702e913a164b">OPATTable</a>
</li>
<li>N_T
: <a class="el" href="structOPATTable.html#a87cc2d8e225e5e9c567602d779aec88f">OPATTable</a>
</li>
<li>name
: <a class="el" href="structconstant.html#af52cfa5a80b3641881d45eef6d597510">constant</a>
: <a class="el" href="structConstant.html#a8d8d2a81e9a8f36dfa02b4d23a5be55c">Constant</a>
</li>
<li>numTables
: <a class="el" href="structHeader.html#a162ced3913c3373d6d54c32274b99d72">Header</a>
</li>
</ul>
<h3><a id="index_o"></a>- o -</h3><ul>
<li>OpatIO()
: <a class="el" href="classOpatIO.html#a7f3436b3ac0dbe141b08d8064550f1b3">OpatIO</a>
</li>
<li>operator&lt;&lt;
: <a class="el" href="classDObject.html#a5b2896a287295bf59a0b9e4d0af21161">DObject</a>
: <a class="el" href="structConstant.html#ad298f7af7cdfd2e2267fd9e464558e2b">Constant</a>
, <a class="el" href="classDObject.html#a5b2896a287295bf59a0b9e4d0af21161">DObject</a>
, <a class="el" href="classMetadata.html#a9bc49cc23da2d1ff8b3e197630b9dfd2">Metadata</a>
</li>
<li>operator[]()
: <a class="el" href="classconstants.html#a32d515b1f539f6fdfc654ed5c8cba8e0">constants</a>
: <a class="el" href="classConstants.html#ad75620743b867fc20d4a05027d1a1c01">Constants</a>
</li>
</ul>
@@ -206,16 +287,28 @@ $(document).ready(function(){initNavTree('functions.html',''); initResizable();
<li>Plugin
: <a class="el" href="classDObject.html#af11334d08ef85c68b3aae7554548e5a7">DObject</a>
</li>
<li>printHeader()
: <a class="el" href="classOpatIO.html#a117f7e1f45d6c410c21d0644e447bbb1">OpatIO</a>
</li>
<li>printTable()
: <a class="el" href="classOpatIO.html#aa8037fc93588dd4c6cbec9bb7c76225f">OpatIO</a>
</li>
<li>printTableIndex()
: <a class="el" href="classOpatIO.html#afa623ba10f188097e555a682a4c69a9f">OpatIO</a>
</li>
</ul>
<h3><a id="index_r"></a>- r -</h3><ul>
<li>reference
: <a class="el" href="structconstant.html#a6be3abe8a0b5a3057d1ab572bd7aad76">constant</a>
: <a class="el" href="structConstant.html#a1c7e6c5a1d2316c98e59e04a234754d1">Constant</a>
</li>
<li>registerPlugin()
: <a class="el" href="classDObject.html#a15afffdf339150fc872bf63bdd08d581">DObject</a>
</li>
<li>reserved
: <a class="el" href="structHeader.html#af99697d38997984f2295c902d3ce1772">Header</a>
</li>
<li>runAllPlugins()
: <a class="el" href="classDObject.html#a1223275dcbbf20334ea11707346acb93">DObject</a>
</li>
@@ -247,15 +340,30 @@ $(document).ready(function(){initNavTree('functions.html',''); initResizable();
<li>setErrorCode()
: <a class="el" href="classDObject.html#a3dce47a519f9da5085c0c5ac1eea4f38">DObject</a>
</li>
<li>setFilename()
: <a class="el" href="classOpatIO.html#ad189e0f239bc4184fecf7daef7923272">OpatIO</a>
</li>
<li>setMaxQDepth()
: <a class="el" href="classOpatIO.html#ab0edd41690b8d5c1775f87439cf82cb5">OpatIO</a>
</li>
<li>sha256
: <a class="el" href="structTableIndex.html#a0c4826e48839977fa2bfaa1bf51b6cdb">TableIndex</a>
</li>
<li>sourceInfo
: <a class="el" href="structHeader.html#ac1a0c67ed5bd4021581fc00c2d79dba3">Header</a>
</li>
</ul>
<h3><a id="index_u"></a>- u -</h3><ul>
<li>uncertainty
: <a class="el" href="structconstant.html#aa23b68117657bec4bb8409eb30d1b3e4">constant</a>
: <a class="el" href="structConstant.html#a0ae09f22af150a41aa4169a4a60933be">Constant</a>
</li>
<li>unit
: <a class="el" href="structconstant.html#ace4a7f2bfc5b80a76c494e92349f9048">constant</a>
: <a class="el" href="structConstant.html#a2c46956a2d2b0ebf78ff99c5971130d2">Constant</a>
</li>
<li>unload()
: <a class="el" href="classOpatIO.html#ac1c1a6159f82462fedf9b526ddcc19a6">OpatIO</a>
</li>
<li>unlock()
: <a class="el" href="classLockableDObject.html#a1481ed99dcd837490bf28309aadaedfb">LockableDObject</a>
@@ -268,7 +376,31 @@ $(document).ready(function(){initNavTree('functions.html',''); initResizable();
<h3><a id="index_v"></a>- v -</h3><ul>
<li>value
: <a class="el" href="structconstant.html#a81804eeeca08f157af92766d5285064f">constant</a>
: <a class="el" href="structConstant.html#a3bda8d7fadd6fb2510fd39962a065a02">Constant</a>
</li>
<li>version
: <a class="el" href="structHeader.html#ac55e763f9e96050f4dab115a4a1c2356">Header</a>
</li>
</ul>
<h3><a id="index_x"></a>- x -</h3><ul>
<li>X
: <a class="el" href="structTableIndex.html#a303592792b2490da4105e294fb4666ca">TableIndex</a>
</li>
</ul>
<h3><a id="index_z"></a>- z -</h3><ul>
<li>Z
: <a class="el" href="structTableIndex.html#a7271de867fee8bb48a71f70afebbf0bd">TableIndex</a>
</li>
</ul>
<h3><a id="index__7E"></a>- ~ -</h3><ul>
<li>~OpatIO()
: <a class="el" href="classOpatIO.html#ac34f611a9eab458329553d27e8bffec6">OpatIO</a>
</li>
</ul>
</div><!-- contents -->