aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2026-04-23 22:49:29 +00:00
Code Issues 3 Packages Projects Releases Wiki Activity
Files
devel
libaaruformat/docs/html/structFluxCaptureMeta.html

268 lines
14 KiB
HTML
Raw Permalink Normal View History

Update doxygen documentation.
2026-01-04 16:05:30 +00:00
<!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"/>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<meta name="generator" content="Doxygen 1.16.1"/>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libaaruformat: FluxCaptureMeta Struct Reference</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="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>
<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">libaaruformat<span id="projectnumber">&#160;1.0</span>
</div>
<div id="projectbrief">Aaru Data Preservation Suite - Format Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<!-- Generated by Doxygen 1.16.1 -->
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</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">
$(function(){initNavTree('structFluxCaptureMeta.html','',''); });
</script>
<div id="container">
<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">FluxCaptureMeta Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Metadata structure returned by <a class="el" href="decls_8h.html#a5f50a859c1849d13a6f4d26d904fb458" title="Retrieve metadata for all flux captures in the image.">aaruf_get_flux_captures()</a>.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="flux_8h_source.html">aaruformat/structs/flux.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<tr class="memitem:a0b227d050c7e82a606376fd3f0c2db02" id="r_a0b227d050c7e82a606376fd3f0c2db02"><td class="memItemLeft">uint32_t&#160;</td><td class="memItemRight"><a class="el" href="#a0b227d050c7e82a606376fd3f0c2db02">head</a></td></tr>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
<tr class="memdesc:a0b227d050c7e82a606376fd3f0c2db02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Head number the flux capture corresponds to. <br /></td></tr>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<tr class="memitem:aebee512e3f6ce8a4c1aa1b4cfbecdb33" id="r_aebee512e3f6ce8a4c1aa1b4cfbecdb33"><td class="memItemLeft">uint16_t&#160;</td><td class="memItemRight"><a class="el" href="#aebee512e3f6ce8a4c1aa1b4cfbecdb33">track</a></td></tr>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
<tr class="memdesc:aebee512e3f6ce8a4c1aa1b4cfbecdb33"><td class="mdescLeft">&#160;</td><td class="mdescRight">Track number the flux capture corresponds to. <br /></td></tr>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<tr class="memitem:a9e7ceeae4845e8dcd87bd76e32d065d6" id="r_a9e7ceeae4845e8dcd87bd76e32d065d6"><td class="memItemLeft">uint8_t&#160;</td><td class="memItemRight"><a class="el" href="#a9e7ceeae4845e8dcd87bd76e32d065d6">subtrack</a></td></tr>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
<tr class="memdesc:a9e7ceeae4845e8dcd87bd76e32d065d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Subtrack number the flux capture corresponds to. <br /></td></tr>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<tr class="memitem:a6558bace422cf15c3f371ef437cc5610" id="r_a6558bace422cf15c3f371ef437cc5610"><td class="memItemLeft">uint32_t&#160;</td><td class="memItemRight"><a class="el" href="#a6558bace422cf15c3f371ef437cc5610">captureIndex</a></td></tr>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
<tr class="memdesc:a6558bace422cf15c3f371ef437cc5610"><td class="mdescLeft">&#160;</td><td class="mdescRight">Capture index, allowing multiple captures for the same location. <br /></td></tr>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<tr class="memitem:a3df2812cbb33d5774ae4485eee96c4c9" id="r_a3df2812cbb33d5774ae4485eee96c4c9"><td class="memItemLeft">uint64_t&#160;</td><td class="memItemRight"><a class="el" href="#a3df2812cbb33d5774ae4485eee96c4c9">indexResolution</a></td></tr>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
<tr class="memdesc:a3df2812cbb33d5774ae4485eee96c4c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resolution in picoseconds at which the index stream was sampled. <br /></td></tr>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<tr class="memitem:ae9699355343e04f88bfe25093774dfde" id="r_ae9699355343e04f88bfe25093774dfde"><td class="memItemLeft">uint64_t&#160;</td><td class="memItemRight"><a class="el" href="#ae9699355343e04f88bfe25093774dfde">dataResolution</a></td></tr>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
<tr class="memdesc:ae9699355343e04f88bfe25093774dfde"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resolution in picoseconds at which the data stream was sampled. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Metadata structure returned by <a class="el" href="decls_8h.html#a5f50a859c1849d13a6f4d26d904fb458" title="Retrieve metadata for all flux captures in the image.">aaruf_get_flux_captures()</a>. </p>
<p>This structure contains the public metadata for a flux capture, excluding internal file offsets. It is used when retrieving metadata for all captures in an image without needing to access the actual flux data.</p>
<p>The structure contains the same location and resolution information as <a class="el" href="structFluxEntry.html" title="Metadata entry describing a single flux capture in the FluxDataBlock.">FluxEntry</a>, but omits the indexOffset and payloadOffset fields which are implementation details not needed by API users.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="decls_8h.html#a5f50a859c1849d13a6f4d26d904fb458" title="Retrieve metadata for all flux captures in the image.">aaruf_get_flux_captures()</a> to retrieve metadata for all captures </dd>
<dd>
<a class="el" href="structFluxEntry.html" title="Metadata entry describing a single flux capture in the FluxDataBlock.">FluxEntry</a> for the complete structure including file offsets </dd></dl>
<p class="definition">Definition at line <a class="el" href="flux_8h_source.html#l00182">182</a> of file <a class="el" href="flux_8h_source.html">flux.h</a>.</p>
</div><a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Field Documentation</h2>
<a id="a6558bace422cf15c3f371ef437cc5610" name="a6558bace422cf15c3f371ef437cc5610"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6558bace422cf15c3f371ef437cc5610">&#9670;&#160;</a></span>captureIndex</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t FluxCaptureMeta::captureIndex</td>
</tr>
</table>
</div><div class="memdoc">
<p>Capture index, allowing multiple captures for the same location. </p>
<p class="definition">Definition at line <a class="el" href="flux_8h_source.html#l00187">187</a> of file <a class="el" href="flux_8h_source.html">flux.h</a>.</p>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<p class="reference">Referenced by <a class="el" href="flux_8c_source.html#l00483">aaruf_get_flux_captures()</a>.</p>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
</div>
</div>
<a id="ae9699355343e04f88bfe25093774dfde" name="ae9699355343e04f88bfe25093774dfde"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9699355343e04f88bfe25093774dfde">&#9670;&#160;</a></span>dataResolution</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t FluxCaptureMeta::dataResolution</td>
</tr>
</table>
</div><div class="memdoc">
<p>Resolution in picoseconds at which the data stream was sampled. </p>
<p class="definition">Definition at line <a class="el" href="flux_8h_source.html#l00189">189</a> of file <a class="el" href="flux_8h_source.html">flux.h</a>.</p>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<p class="reference">Referenced by <a class="el" href="flux_8c_source.html#l00483">aaruf_get_flux_captures()</a>.</p>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
</div>
</div>
<a id="a0b227d050c7e82a606376fd3f0c2db02" name="a0b227d050c7e82a606376fd3f0c2db02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b227d050c7e82a606376fd3f0c2db02">&#9670;&#160;</a></span>head</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t FluxCaptureMeta::head</td>
</tr>
</table>
</div><div class="memdoc">
<p>Head number the flux capture corresponds to. </p>
<p class="definition">Definition at line <a class="el" href="flux_8h_source.html#l00184">184</a> of file <a class="el" href="flux_8h_source.html">flux.h</a>.</p>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<p class="reference">Referenced by <a class="el" href="flux_8c_source.html#l00483">aaruf_get_flux_captures()</a>.</p>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
</div>
</div>
<a id="a3df2812cbb33d5774ae4485eee96c4c9" name="a3df2812cbb33d5774ae4485eee96c4c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3df2812cbb33d5774ae4485eee96c4c9">&#9670;&#160;</a></span>indexResolution</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t FluxCaptureMeta::indexResolution</td>
</tr>
</table>
</div><div class="memdoc">
<p>Resolution in picoseconds at which the index stream was sampled. </p>
<p class="definition">Definition at line <a class="el" href="flux_8h_source.html#l00188">188</a> of file <a class="el" href="flux_8h_source.html">flux.h</a>.</p>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<p class="reference">Referenced by <a class="el" href="flux_8c_source.html#l00483">aaruf_get_flux_captures()</a>.</p>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
</div>
</div>
<a id="a9e7ceeae4845e8dcd87bd76e32d065d6" name="a9e7ceeae4845e8dcd87bd76e32d065d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e7ceeae4845e8dcd87bd76e32d065d6">&#9670;&#160;</a></span>subtrack</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t FluxCaptureMeta::subtrack</td>
</tr>
</table>
</div><div class="memdoc">
<p>Subtrack number the flux capture corresponds to. </p>
<p class="definition">Definition at line <a class="el" href="flux_8h_source.html#l00186">186</a> of file <a class="el" href="flux_8h_source.html">flux.h</a>.</p>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<p class="reference">Referenced by <a class="el" href="flux_8c_source.html#l00483">aaruf_get_flux_captures()</a>.</p>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
</div>
</div>
<a id="aebee512e3f6ce8a4c1aa1b4cfbecdb33" name="aebee512e3f6ce8a4c1aa1b4cfbecdb33"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebee512e3f6ce8a4c1aa1b4cfbecdb33">&#9670;&#160;</a></span>track</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t FluxCaptureMeta::track</td>
</tr>
</table>
</div><div class="memdoc">
<p>Track number the flux capture corresponds to. </p>
<p class="definition">Definition at line <a class="el" href="flux_8h_source.html#l00185">185</a> of file <a class="el" href="flux_8h_source.html">flux.h</a>.</p>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<p class="reference">Referenced by <a class="el" href="flux_8c_source.html#l00483">aaruf_get_flux_captures()</a>.</p>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/aaruformat/structs/<a class="el" href="flux_8h_source.html">flux.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="structFluxCaptureMeta.html">FluxCaptureMeta</a></li>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<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.16.1 </li>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
</ul>
</div>
</body>
</html>
Reference in New Issue Copy Permalink