Skip to content

Commit d76b8c7

Browse files
BrianMichellBrianMichell
committed
Add latest documentation
1 parent 838538d commit d76b8c7

221 files changed

Lines changed: 25019 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎html/annotated.html‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.9.1"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>mdio-cpp: Class List</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="resize.js"></script>
14+
<script type="text/javascript" src="navtreedata.js"></script>
15+
<script type="text/javascript" src="navtree.js"></script>
16+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
17+
<script type="text/javascript" src="search/searchdata.js"></script>
18+
<script type="text/javascript" src="search/search.js"></script>
19+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
20+
</head>
21+
<body>
22+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
23+
<div id="titlearea">
24+
<table cellspacing="0" cellpadding="0">
25+
<tbody>
26+
<tr style="height: 56px;">
27+
<td id="projectlogo"><img alt="Logo" src="favicon.png"/></td>
28+
<td id="projectalign" style="padding-left: 0.5em;">
29+
<div id="projectname">mdio-cpp
30+
&#160;<span id="projectnumber">latest</span>
31+
</div>
32+
<div id="projectbrief">C++, Cloud native, scalable storage engine for various types of energy data.</div>
33+
</td>
34+
</tr>
35+
</tbody>
36+
</table>
37+
</div>
38+
<!-- end header part -->
39+
<!-- Generated by Doxygen 1.9.1 -->
40+
<script type="text/javascript">
41+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
42+
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
43+
/* @license-end */
44+
</script>
45+
<script type="text/javascript" src="menudata.js"></script>
46+
<script type="text/javascript" src="menu.js"></script>
47+
<script type="text/javascript">
48+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
49+
$(function() {
50+
initMenu('',true,false,'search.php','Search');
51+
$(document).ready(function() { init_search(); });
52+
});
53+
/* @license-end */</script>
54+
<div id="main-nav"></div>
55+
</div><!-- top -->
56+
<div id="side-nav" class="ui-resizable side-nav-resizable">
57+
<div id="nav-tree">
58+
<div id="nav-tree-contents">
59+
<div id="nav-sync" class="sync"></div>
60+
</div>
61+
</div>
62+
<div id="splitbar" style="-moz-user-select:none;"
63+
class="ui-resizable-handle">
64+
</div>
65+
</div>
66+
<script type="text/javascript">
67+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
68+
$(document).ready(function(){initNavTree('annotated.html',''); initResizable(); });
69+
/* @license-end */
70+
</script>
71+
<div id="doc-content">
72+
<!-- window showing the filter options -->
73+
<div id="MSearchSelectWindow"
74+
onmouseover="return searchBox.OnSearchSelectShow()"
75+
onmouseout="return searchBox.OnSearchSelectHide()"
76+
onkeydown="return searchBox.OnSearchSelectKey(event)">
77+
</div>
78+
79+
<!-- iframe showing the search results (closed by default) -->
80+
<div id="MSearchResultsWindow">
81+
<iframe src="javascript:void(0)" frameborder="0"
82+
name="MSearchResults" id="MSearchResults">
83+
</iframe>
84+
</div>
85+
86+
<div class="header">
87+
<div class="headertitle">
88+
<div class="title">Class List</div> </div>
89+
</div><!--header-->
90+
<div class="contents">
91+
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
92+
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">
93+
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacemdio.html" target="_self">mdio</a></td><td class="desc"></td></tr>
94+
<tr id="row_0_0_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_0_" class="arrow" onclick="toggleFolder('0_0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>internal</b></td><td class="desc"></td></tr>
95+
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmdio_1_1internal_1_1Histogram.html" target="_self">Histogram</a></td><td class="desc">A <a class="el" href="classmdio_1_1internal_1_1Histogram.html" title="A Histogram can be either CenteredBinHistogram or EdgeDefinedHistogram as defined by the MDIO spec.">Histogram</a> can be either <a class="el" href="classmdio_1_1internal_1_1CenteredBinHistogram.html">CenteredBinHistogram</a> or <a class="el" href="classmdio_1_1internal_1_1EdgeDefinedHistogram.html">EdgeDefinedHistogram</a> as defined by the MDIO spec </td></tr>
96+
<tr id="row_0_0_1_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmdio_1_1internal_1_1CenteredBinHistogram.html" target="_self">CenteredBinHistogram</a></td><td class="desc"></td></tr>
97+
<tr id="row_0_0_2_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmdio_1_1internal_1_1EdgeDefinedHistogram.html" target="_self">EdgeDefinedHistogram</a></td><td class="desc"></td></tr>
98+
<tr id="row_0_0_3_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmdio_1_1internal_1_1SummaryStats.html" target="_self">SummaryStats</a></td><td class="desc"></td></tr>
99+
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_1_" class="arrow" onclick="toggleFolder('0_1_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmdio_1_1Dataset.html" target="_self">Dataset</a></td><td class="desc">The <a class="el" href="classmdio_1_1Dataset.html" title="The Dataset class The dataset represents a collection of variables sharing a common grid.">Dataset</a> class The dataset represents a collection of variables sharing a common grid </td></tr>
100+
<tr id="row_0_1_0_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1Dataset_1_1index__sequence.html" target="_self">index_sequence</a></td><td class="desc"></td></tr>
101+
<tr id="row_0_2_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmdio_1_1UserAttributes.html" target="_self">UserAttributes</a></td><td class="desc"></td></tr>
102+
<tr id="row_0_3_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_3_" class="arrow" onclick="toggleFolder('0_3_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1Variable.html" target="_self">Variable</a></td><td class="desc">A templated struct representing an MDIO <a class="el" href="structmdio_1_1Variable.html" title="A templated struct representing an MDIO Variable with a tensorstore. This is an MDIO specified zarr V...">Variable</a> with a tensorstore. This is an MDIO specified zarr V2 tensorstore variable. It represents the non-volitile (on-disc, in-cloud, etc.) data </td></tr>
103+
<tr id="row_0_3_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1Variable_1_1index__sequence.html" target="_self">index_sequence</a></td><td class="desc"></td></tr>
104+
<tr id="row_0_3_1_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1Variable_1_1Interval.html" target="_self">Interval</a></td><td class="desc"></td></tr>
105+
<tr id="row_0_4_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1VariableData.html" target="_self">VariableData</a></td><td class="desc">The in-memory representation of the data This object should only be constructed through the <a class="el" href="structmdio_1_1Variable.html#af425045bbd682a466383dcb99e244c6e" title="Read the data from the variable. Reads the data from the source variable. Provide an Open method for ...">Variable::Read()</a> function. This data only exists in memory and should be preserved with the <a class="el" href="structmdio_1_1Variable.html#ab4ba4f463cf01d9b0e410ab21e590a2b" title="Write the data to the variable. Writes the data from the source variable data to the target variable.">Variable::Write()</a> function </td></tr>
106+
<tr id="row_0_5_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1LabeledArray.html" target="_self">LabeledArray</a></td><td class="desc">A <a class="el" href="structmdio_1_1LabeledArray.html" title="A LabeledArray is an underlying data type for a VariableData object and is not intended to be directl...">LabeledArray</a> is an underlying data type for a <a class="el" href="structmdio_1_1VariableData.html" title="The in-memory representation of the data This object should only be constructed through the Variable:...">VariableData</a> object and is not intended to be directly interacted with </td></tr>
107+
<tr id="row_0_6_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1RangeDescriptor.html" target="_self">RangeDescriptor</a></td><td class="desc">A descriptor for slicing a <a class="el" href="structmdio_1_1Variable.html" title="A templated struct representing an MDIO Variable with a tensorstore. This is an MDIO specified zarr V...">Variable</a> or <a class="el" href="classmdio_1_1Dataset.html" title="The Dataset class The dataset represents a collection of variables sharing a common grid.">Dataset</a> </td></tr>
108+
<tr id="row_0_7_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1SliceDescriptor.html" target="_self">SliceDescriptor</a></td><td class="desc">A descriptor for slicing a <a class="el" href="structmdio_1_1Variable.html" title="A templated struct representing an MDIO Variable with a tensorstore. This is an MDIO specified zarr V...">Variable</a>. A struct representing how to slice a <a class="el" href="structmdio_1_1Variable.html" title="A templated struct representing an MDIO Variable with a tensorstore. This is an MDIO specified zarr V...">Variable</a> or <a class="el" href="classmdio_1_1Dataset.html" title="The Dataset class The dataset represents a collection of variables sharing a common grid.">Dataset</a>. All slices using this will be performed as half open intervals </td></tr>
109+
<tr id="row_0_8_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1ValueDescriptor.html" target="_self">ValueDescriptor</a></td><td class="desc">A descriptor for slicing a single dimension value from a <a class="el" href="classmdio_1_1Dataset.html" title="The Dataset class The dataset represents a collection of variables sharing a common grid.">Dataset</a>. This structure is not supported for index-based slicing </td></tr>
110+
<tr id="row_0_9_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1ListDescriptor.html" target="_self">ListDescriptor</a></td><td class="desc">A descriptor for slicing a list of values from a <a class="el" href="classmdio_1_1Dataset.html" title="The Dataset class The dataset represents a collection of variables sharing a common grid.">Dataset</a>. This structure is not supported for index-based slicing </td></tr>
111+
<tr id="row_0_10_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmdio_1_1VariableCollection.html" target="_self">VariableCollection</a></td><td class="desc">A collection of variables. Provides type erasure for the coordinates and variables. This is intended to be an underlying data structure for the <a class="el" href="classmdio_1_1Dataset.html" title="The Dataset class The dataset represents a collection of variables sharing a common grid.">Dataset</a> class </td></tr>
112+
</table>
113+
</div><!-- directory -->
114+
</div><!-- contents -->
115+
</div><!-- doc-content -->
116+
<!-- start footer part -->
117+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
118+
<ul>
119+
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
120+
</ul>
121+
</div>
122+
</body>
123+
</html>

‎html/annotated_dup.js‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
var annotated_dup =
2+
[
3+
[ "mdio", "namespacemdio.html", [
4+
[ "internal", null, [
5+
[ "Histogram", "classmdio_1_1internal_1_1Histogram.html", "classmdio_1_1internal_1_1Histogram" ],
6+
[ "CenteredBinHistogram", "classmdio_1_1internal_1_1CenteredBinHistogram.html", "classmdio_1_1internal_1_1CenteredBinHistogram" ],
7+
[ "EdgeDefinedHistogram", "classmdio_1_1internal_1_1EdgeDefinedHistogram.html", "classmdio_1_1internal_1_1EdgeDefinedHistogram" ],
8+
[ "SummaryStats", "classmdio_1_1internal_1_1SummaryStats.html", "classmdio_1_1internal_1_1SummaryStats" ]
9+
] ],
10+
[ "Dataset", "classmdio_1_1Dataset.html", "classmdio_1_1Dataset" ],
11+
[ "UserAttributes", "classmdio_1_1UserAttributes.html", "classmdio_1_1UserAttributes" ],
12+
[ "Variable", "structmdio_1_1Variable.html", "structmdio_1_1Variable" ],
13+
[ "VariableData", "structmdio_1_1VariableData.html", "structmdio_1_1VariableData" ],
14+
[ "LabeledArray", "structmdio_1_1LabeledArray.html", "structmdio_1_1LabeledArray" ],
15+
[ "RangeDescriptor", "structmdio_1_1RangeDescriptor.html", "structmdio_1_1RangeDescriptor" ],
16+
[ "SliceDescriptor", "structmdio_1_1SliceDescriptor.html", "structmdio_1_1SliceDescriptor" ],
17+
[ "ValueDescriptor", "structmdio_1_1ValueDescriptor.html", "structmdio_1_1ValueDescriptor" ],
18+
[ "ListDescriptor", "structmdio_1_1ListDescriptor.html", "structmdio_1_1ListDescriptor" ],
19+
[ "VariableCollection", "classmdio_1_1VariableCollection.html", "classmdio_1_1VariableCollection" ]
20+
] ]
21+
];

‎html/bc_s.png‎

676 Bytes
Loading

‎html/bdwn.png‎

147 Bytes
Loading

0 commit comments

Comments
 (0)