177 lines
16 KiB
HTML
177 lines
16 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.13.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>New 4DSSE Code: src/dobj/public/Metadata.h Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { init_search(); });
|
|
/* @license-end */
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">New 4DSSE Code<span id="projectnumber"> 0.0.1a</span>
|
|
</div>
|
|
</td>
|
|
<td> <div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
|
|
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @license-end */
|
|
</script>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){initNavTree('_metadata_8h_source.html',''); initResizable(true); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">Metadata.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="_metadata_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef METADATA_H</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define METADATA_H</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#if defined(__APPLE__) || defined(__linux__)</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#define EXPORT_SYMBOL __attribute__((visibility("default")))</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#else</span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#define EXPORT_SYMBOL</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include <vector></span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include <cstddef></span></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include <iostream></span></div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span></div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span></div>
|
|
<div class="foldopen" id="foldopen00031" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="class_metadata.html"> 31</a></span><span class="keyword">class </span>EXPORT_SYMBOL <a class="code hl_function" href="class_metadata.html#ae849560667461008cb72e83919c20be0">Metadata</a> {</div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="class_metadata.html#ae849560667461008cb72e83919c20be0"> 36</a></span> <a class="code hl_function" href="class_metadata.html#ae849560667461008cb72e83919c20be0">Metadata</a>() = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span></div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <a class="code hl_function" href="class_metadata.html#ae849560667461008cb72e83919c20be0">Metadata</a>(std::size_t byteSize, std::string dataType, std::vector<std::size_t> dimensions, <span class="keywordtype">bool</span> debugFlag = <span class="keyword">false</span>);</div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span></div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> [[nodiscard]] std::size_t <a class="code hl_function" href="class_metadata.html#ac7980d1efdd6ae434f0115f83d08348e">getByteSize</a>() const noexcept;</div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span></div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_metadata.html#a07035de7b0c780ef340e1a11c60a4d2b">setByteSize</a>(std::<span class="keywordtype">size_t</span> byteSize) noexcept;</div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span></div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> [[nodiscard]] const std::<span class="keywordtype">string</span>& <a class="code hl_function" href="class_metadata.html#aeed7f22ccc61d9a3d6425441d381dcdc">getDataType</a>() const noexcept;</div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span></div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_metadata.html#a88f4f57d443e2b7664e75e57a29dfbf0">setDataType</a>(const std::<span class="keywordtype">string</span>& dataType);</div>
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span></div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> [[nodiscard]] const std::vector<std::<span class="keywordtype">size_t</span>>& <a class="code hl_function" href="class_metadata.html#a412c0c0b8754d85f9edbbdcd637f3b20">getDimensions</a>() const noexcept;</div>
|
|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span></div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_metadata.html#af5264d1666839e69c192b565b5cfa606">setDimensions</a>(const std::vector<std::<span class="keywordtype">size_t</span>>& dimensions);</div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span></div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> [[nodiscard]] <span class="keywordtype">bool</span> <a class="code hl_function" href="class_metadata.html#abe52c81e04665628666b4140cd346b69">isDebugEnabled</a>() const noexcept;</div>
|
|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span></div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_metadata.html#a365c4594ad65c3b10b40a1cf4f4aea26">setDebugEnabled</a>(<span class="keywordtype">bool</span> debugFlag) noexcept;</div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span></div>
|
|
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> friend std::ostream& operator<<(std::ostream& os, const <a class="code hl_function" href="class_metadata.html#ae849560667461008cb72e83919c20be0">Metadata</a>& metadata);</div>
|
|
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div>
|
|
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span>private:</div>
|
|
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> std::<span class="keywordtype">size_t</span> byteSize_ = 0; </div>
|
|
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> std::<span class="keywordtype">string</span> dataType_; </div>
|
|
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> std::vector<std::<span class="keywordtype">size_t</span>> dimensions_; </div>
|
|
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> <span class="keywordtype">bool</span> debugFlag_ = false; </div>
|
|
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span>};</div>
|
|
</div>
|
|
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> </div>
|
|
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span><span class="preprocessor">#endif </span><span class="comment">// METADATA_H</span></div>
|
|
<div class="ttc" id="aclass_metadata_html_a07035de7b0c780ef340e1a11c60a4d2b"><div class="ttname"><a href="class_metadata.html#a07035de7b0c780ef340e1a11c60a4d2b">Metadata::setByteSize</a></div><div class="ttdeci">void setByteSize(std::size_t byteSize) noexcept</div><div class="ttdoc">Sets the total size of the data in bytes.</div><div class="ttdef"><b>Definition</b> Metadata.cpp:42</div></div>
|
|
<div class="ttc" id="aclass_metadata_html_a365c4594ad65c3b10b40a1cf4f4aea26"><div class="ttname"><a href="class_metadata.html#a365c4594ad65c3b10b40a1cf4f4aea26">Metadata::setDebugEnabled</a></div><div class="ttdeci">void setDebugEnabled(bool debugFlag) noexcept</div><div class="ttdoc">Sets the debugging flag.</div><div class="ttdef"><b>Definition</b> Metadata.cpp:112</div></div>
|
|
<div class="ttc" id="aclass_metadata_html_a412c0c0b8754d85f9edbbdcd637f3b20"><div class="ttname"><a href="class_metadata.html#a412c0c0b8754d85f9edbbdcd637f3b20">Metadata::getDimensions</a></div><div class="ttdeci">const std::vector< std::size_t > & getDimensions() const noexcept</div><div class="ttdoc">Gets the dimensions of the data.</div><div class="ttdef"><b>Definition</b> Metadata.cpp:78</div></div>
|
|
<div class="ttc" id="aclass_metadata_html_a88f4f57d443e2b7664e75e57a29dfbf0"><div class="ttname"><a href="class_metadata.html#a88f4f57d443e2b7664e75e57a29dfbf0">Metadata::setDataType</a></div><div class="ttdeci">void setDataType(const std::string &dataType)</div><div class="ttdoc">Sets the type of the data.</div><div class="ttdef"><b>Definition</b> Metadata.cpp:66</div></div>
|
|
<div class="ttc" id="aclass_metadata_html_abe52c81e04665628666b4140cd346b69"><div class="ttname"><a href="class_metadata.html#abe52c81e04665628666b4140cd346b69">Metadata::isDebugEnabled</a></div><div class="ttdeci">bool isDebugEnabled() const noexcept</div><div class="ttdoc">Checks if debugging information is enabled.</div><div class="ttdef"><b>Definition</b> Metadata.cpp:100</div></div>
|
|
<div class="ttc" id="aclass_metadata_html_ac7980d1efdd6ae434f0115f83d08348e"><div class="ttname"><a href="class_metadata.html#ac7980d1efdd6ae434f0115f83d08348e">Metadata::getByteSize</a></div><div class="ttdeci">std::size_t getByteSize() const noexcept</div><div class="ttdoc">Gets the total size of the data in bytes.</div><div class="ttdef"><b>Definition</b> Metadata.cpp:30</div></div>
|
|
<div class="ttc" id="aclass_metadata_html_ae849560667461008cb72e83919c20be0"><div class="ttname"><a href="class_metadata.html#ae849560667461008cb72e83919c20be0">Metadata::Metadata</a></div><div class="ttdeci">Metadata()=default</div><div class="ttdoc">Default constructor for Metadata.</div></div>
|
|
<div class="ttc" id="aclass_metadata_html_aeed7f22ccc61d9a3d6425441d381dcdc"><div class="ttname"><a href="class_metadata.html#aeed7f22ccc61d9a3d6425441d381dcdc">Metadata::getDataType</a></div><div class="ttdeci">const std::string & getDataType() const noexcept</div><div class="ttdoc">Gets the type of the data.</div><div class="ttdef"><b>Definition</b> Metadata.cpp:54</div></div>
|
|
<div class="ttc" id="aclass_metadata_html_af5264d1666839e69c192b565b5cfa606"><div class="ttname"><a href="class_metadata.html#af5264d1666839e69c192b565b5cfa606">Metadata::setDimensions</a></div><div class="ttdeci">void setDimensions(const std::vector< std::size_t > &dimensions)</div><div class="ttdoc">Sets the dimensions of the data.</div><div class="ttdef"><b>Definition</b> Metadata.cpp:89</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_768194193337d64eaa7edd2c5f5038a4.html">dobj</a></li><li class="navelem"><a class="el" href="dir_5657658ab0dc14c9c63c088cb1f6321c.html">public</a></li><li class="navelem"><a class="el" href="_metadata_8h.html">Metadata.h</a></li>
|
|
<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.13.2 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|