699 lines
36 KiB
HTML
699 lines
36 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>SERiF: Metadata Class 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="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>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen-awesome-sidebar-only.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">SERiF<span id="projectnumber"> 0.0.1a</span>
|
|
</div>
|
|
<div id="projectbrief">3+1D Stellar Structure and Evolution</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>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</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">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){initNavTree('class_metadata.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="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="#friends">Friends</a> |
|
|
<a href="class_metadata-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">Metadata Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Represents metadata information for data objects in the dobj module.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_metadata_8h_source.html">Metadata.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:ae849560667461008cb72e83919c20be0" id="r_ae849560667461008cb72e83919c20be0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae849560667461008cb72e83919c20be0">Metadata</a> ()=default</td></tr>
|
|
<tr class="memdesc:ae849560667461008cb72e83919c20be0"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor for <a class="el" href="class_metadata.html" title="Represents metadata information for data objects in the dobj module.">Metadata</a>. <br /></td></tr>
|
|
<tr class="separator:ae849560667461008cb72e83919c20be0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3d56c8c5adee4b8c7d2089802211522b" id="r_a3d56c8c5adee4b8c7d2089802211522b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3d56c8c5adee4b8c7d2089802211522b">Metadata</a> (std::size_t byteSize, std::string dataType, std::vector< std::size_t > dimensions, bool debugFlag=false)</td></tr>
|
|
<tr class="memdesc:a3d56c8c5adee4b8c7d2089802211522b"><td class="mdescLeft"> </td><td class="mdescRight">Constructor to initialize <a class="el" href="class_metadata.html" title="Represents metadata information for data objects in the dobj module.">Metadata</a> with specific attributes. <br /></td></tr>
|
|
<tr class="separator:a3d56c8c5adee4b8c7d2089802211522b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac7980d1efdd6ae434f0115f83d08348e" id="r_ac7980d1efdd6ae434f0115f83d08348e"><td class="memItemLeft" align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac7980d1efdd6ae434f0115f83d08348e">getByteSize</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:ac7980d1efdd6ae434f0115f83d08348e"><td class="mdescLeft"> </td><td class="mdescRight">Gets the total size of the data in bytes. <br /></td></tr>
|
|
<tr class="separator:ac7980d1efdd6ae434f0115f83d08348e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a07035de7b0c780ef340e1a11c60a4d2b" id="r_a07035de7b0c780ef340e1a11c60a4d2b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a07035de7b0c780ef340e1a11c60a4d2b">setByteSize</a> (std::size_t byteSize) noexcept</td></tr>
|
|
<tr class="memdesc:a07035de7b0c780ef340e1a11c60a4d2b"><td class="mdescLeft"> </td><td class="mdescRight">Sets the total size of the data in bytes. <br /></td></tr>
|
|
<tr class="separator:a07035de7b0c780ef340e1a11c60a4d2b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeed7f22ccc61d9a3d6425441d381dcdc" id="r_aeed7f22ccc61d9a3d6425441d381dcdc"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="#aeed7f22ccc61d9a3d6425441d381dcdc">getDataType</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:aeed7f22ccc61d9a3d6425441d381dcdc"><td class="mdescLeft"> </td><td class="mdescRight">Gets the type of the data. <br /></td></tr>
|
|
<tr class="separator:aeed7f22ccc61d9a3d6425441d381dcdc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a88f4f57d443e2b7664e75e57a29dfbf0" id="r_a88f4f57d443e2b7664e75e57a29dfbf0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a88f4f57d443e2b7664e75e57a29dfbf0">setDataType</a> (const std::string &dataType)</td></tr>
|
|
<tr class="memdesc:a88f4f57d443e2b7664e75e57a29dfbf0"><td class="mdescLeft"> </td><td class="mdescRight">Sets the type of the data. <br /></td></tr>
|
|
<tr class="separator:a88f4f57d443e2b7664e75e57a29dfbf0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a412c0c0b8754d85f9edbbdcd637f3b20" id="r_a412c0c0b8754d85f9edbbdcd637f3b20"><td class="memItemLeft" align="right" valign="top">const std::vector< std::size_t > & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a412c0c0b8754d85f9edbbdcd637f3b20">getDimensions</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a412c0c0b8754d85f9edbbdcd637f3b20"><td class="mdescLeft"> </td><td class="mdescRight">Gets the dimensions of the data. <br /></td></tr>
|
|
<tr class="separator:a412c0c0b8754d85f9edbbdcd637f3b20"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af5264d1666839e69c192b565b5cfa606" id="r_af5264d1666839e69c192b565b5cfa606"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#af5264d1666839e69c192b565b5cfa606">setDimensions</a> (const std::vector< std::size_t > &dimensions)</td></tr>
|
|
<tr class="memdesc:af5264d1666839e69c192b565b5cfa606"><td class="mdescLeft"> </td><td class="mdescRight">Sets the dimensions of the data. <br /></td></tr>
|
|
<tr class="separator:af5264d1666839e69c192b565b5cfa606"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abe52c81e04665628666b4140cd346b69" id="r_abe52c81e04665628666b4140cd346b69"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#abe52c81e04665628666b4140cd346b69">isDebugEnabled</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:abe52c81e04665628666b4140cd346b69"><td class="mdescLeft"> </td><td class="mdescRight">Checks if debugging information is enabled. <br /></td></tr>
|
|
<tr class="separator:abe52c81e04665628666b4140cd346b69"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a365c4594ad65c3b10b40a1cf4f4aea26" id="r_a365c4594ad65c3b10b40a1cf4f4aea26"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a365c4594ad65c3b10b40a1cf4f4aea26">setDebugEnabled</a> (bool debugFlag) noexcept</td></tr>
|
|
<tr class="memdesc:a365c4594ad65c3b10b40a1cf4f4aea26"><td class="mdescLeft"> </td><td class="mdescRight">Sets the debugging flag. <br /></td></tr>
|
|
<tr class="separator:a365c4594ad65c3b10b40a1cf4f4aea26"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:ac73a509797c98c0d52fb32e1f93e38bc" id="r_ac73a509797c98c0d52fb32e1f93e38bc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac73a509797c98c0d52fb32e1f93e38bc">byteSize_</a> = 0</td></tr>
|
|
<tr class="memdesc:ac73a509797c98c0d52fb32e1f93e38bc"><td class="mdescLeft"> </td><td class="mdescRight">Total size of the data in bytes. <br /></td></tr>
|
|
<tr class="separator:ac73a509797c98c0d52fb32e1f93e38bc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a290205e5f46416dd0f48bd6ff62888ac" id="r_a290205e5f46416dd0f48bd6ff62888ac"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="#a290205e5f46416dd0f48bd6ff62888ac">dataType_</a></td></tr>
|
|
<tr class="memdesc:a290205e5f46416dd0f48bd6ff62888ac"><td class="mdescLeft"> </td><td class="mdescRight">Type of the data (e.g., "float", "double"). <br /></td></tr>
|
|
<tr class="separator:a290205e5f46416dd0f48bd6ff62888ac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a163f74d4ef9ecd13a34e7e9cab2e21ce" id="r_a163f74d4ef9ecd13a34e7e9cab2e21ce"><td class="memItemLeft" align="right" valign="top">std::vector< std::size_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a163f74d4ef9ecd13a34e7e9cab2e21ce">dimensions_</a></td></tr>
|
|
<tr class="memdesc:a163f74d4ef9ecd13a34e7e9cab2e21ce"><td class="mdescLeft"> </td><td class="mdescRight">Dimensions of the data (e.g., {3, 4} for a 3x4 matrix). <br /></td></tr>
|
|
<tr class="separator:a163f74d4ef9ecd13a34e7e9cab2e21ce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a65fd506f1bd41699d9cd19bc0dfc9701" id="r_a65fd506f1bd41699d9cd19bc0dfc9701"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a65fd506f1bd41699d9cd19bc0dfc9701">debugFlag_</a> = false</td></tr>
|
|
<tr class="memdesc:a65fd506f1bd41699d9cd19bc0dfc9701"><td class="mdescLeft"> </td><td class="mdescRight">Indicates whether debugging is enabled. <br /></td></tr>
|
|
<tr class="separator:a65fd506f1bd41699d9cd19bc0dfc9701"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:a12949a1ea26c4ff1afeb97101c0493c5" id="r_a12949a1ea26c4ff1afeb97101c0493c5"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a12949a1ea26c4ff1afeb97101c0493c5">operator<<</a> (std::ostream &os, const <a class="el" href="class_metadata.html">Metadata</a> &metadata)</td></tr>
|
|
<tr class="memdesc:a12949a1ea26c4ff1afeb97101c0493c5"><td class="mdescLeft"> </td><td class="mdescRight">Prints the metadata information for debugging purposes. <br /></td></tr>
|
|
<tr class="separator:a12949a1ea26c4ff1afeb97101c0493c5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Represents metadata information for data objects in the dobj module. </p>
|
|
<p>The <a class="el" href="class_metadata.html" title="Represents metadata information for data objects in the dobj module.">Metadata</a> class encapsulates details such as data size, type, dimensions, and optional debugging flags. It is designed to provide descriptive attributes in a lightweight and efficient manner. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_metadata_8h_source.html#l00051">51</a> of file <a class="el" href="_metadata_8h_source.html">Metadata.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="ae849560667461008cb72e83919c20be0" name="ae849560667461008cb72e83919c20be0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae849560667461008cb72e83919c20be0">◆ </a></span>Metadata() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Metadata::Metadata </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel default">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor for <a class="el" href="class_metadata.html" title="Represents metadata information for data objects in the dobj module.">Metadata</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3d56c8c5adee4b8c7d2089802211522b" name="a3d56c8c5adee4b8c7d2089802211522b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3d56c8c5adee4b8c7d2089802211522b">◆ </a></span>Metadata() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Metadata::Metadata </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>byteSize</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::string</td> <td class="paramname"><span class="paramname"><em>dataType</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::vector< std::size_t ></td> <td class="paramname"><span class="paramname"><em>dimensions</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>debugFlag</em></span><span class="paramdefsep"> = </span><span class="paramdefval">false</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructor to initialize <a class="el" href="class_metadata.html" title="Represents metadata information for data objects in the dobj module.">Metadata</a> with specific attributes. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">byteSize</td><td>The total size of the data in bytes. </td></tr>
|
|
<tr><td class="paramname">dataType</td><td>The type of the data (e.g., "float", "double"). </td></tr>
|
|
<tr><td class="paramname">dimensions</td><td>A vector representing the size of each dimension (e.g., {3, 4} for a 3x4 matrix). </td></tr>
|
|
<tr><td class="paramname">debugFlag</td><td>Whether debugging information is enabled for this <a class="el" href="class_metadata.html" title="Represents metadata information for data objects in the dobj module.">Metadata</a> instance. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_metadata_8cpp_source.html#l00040">40</a> of file <a class="el" href="_metadata_8cpp_source.html">Metadata.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ac7980d1efdd6ae434f0115f83d08348e" name="ac7980d1efdd6ae434f0115f83d08348e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac7980d1efdd6ae434f0115f83d08348e">◆ </a></span>getByteSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::size_t Metadata::getByteSize </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the total size of the data in bytes. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The total byte size of the data.</dd></dl>
|
|
<p>The size is often required for memory allocation and validation in numerical routines.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The total byte size of the data. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_metadata_8cpp_source.html#l00050">50</a> of file <a class="el" href="_metadata_8cpp_source.html">Metadata.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aeed7f22ccc61d9a3d6425441d381dcdc" name="aeed7f22ccc61d9a3d6425441d381dcdc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aeed7f22ccc61d9a3d6425441d381dcdc">◆ </a></span>getDataType()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::string & Metadata::getDataType </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the type of the data. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A string representing the data type.</dd></dl>
|
|
<p>The type (e.g., "float", "double") is critical for casting raw data or interfacing with libraries that require specific types.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A string representing the data type. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_metadata_8cpp_source.html#l00074">74</a> of file <a class="el" href="_metadata_8cpp_source.html">Metadata.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a412c0c0b8754d85f9edbbdcd637f3b20" name="a412c0c0b8754d85f9edbbdcd637f3b20"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a412c0c0b8754d85f9edbbdcd637f3b20">◆ </a></span>getDimensions()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::vector< std::size_t > & Metadata::getDimensions </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the dimensions of the data. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A vector representing the size of each dimension.</dd></dl>
|
|
<p>Dimensions define the shape of the data (e.g., 2D arrays, 3D matrices). This is essential for ensuring that operations (e.g., matrix multiplication) are performed correctly.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A vector representing the size of each dimension. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_metadata_8cpp_source.html#l00098">98</a> of file <a class="el" href="_metadata_8cpp_source.html">Metadata.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abe52c81e04665628666b4140cd346b69" name="abe52c81e04665628666b4140cd346b69"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abe52c81e04665628666b4140cd346b69">◆ </a></span>isDebugEnabled()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Metadata::isDebugEnabled </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Checks if debugging information is enabled. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if debugging is enabled, false otherwise.</dd></dl>
|
|
<p>Debugging flags can be useful for tracking performance metrics or error provenance.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if debugging is enabled, false otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_metadata_8cpp_source.html#l00120">120</a> of file <a class="el" href="_metadata_8cpp_source.html">Metadata.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a07035de7b0c780ef340e1a11c60a4d2b" name="a07035de7b0c780ef340e1a11c60a4d2b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a07035de7b0c780ef340e1a11c60a4d2b">◆ </a></span>setByteSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Metadata::setByteSize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>byteSize</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the total size of the data in bytes. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">byteSize</td><td>The total byte size to set.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>It's important to ensure this matches the actual data size in memory to prevent overflows or incorrect computations downstream.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">byteSize</td><td>The total byte size to set. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_metadata_8cpp_source.html#l00062">62</a> of file <a class="el" href="_metadata_8cpp_source.html">Metadata.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a88f4f57d443e2b7664e75e57a29dfbf0" name="a88f4f57d443e2b7664e75e57a29dfbf0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a88f4f57d443e2b7664e75e57a29dfbf0">◆ </a></span>setDataType()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Metadata::setDataType </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>dataType</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the type of the data. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dataType</td><td>A string representing the data type.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>When setting the data type, ensure it aligns with the underlying data representation. Mismatched types can lead to undefined behavior in numerical calculations.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dataType</td><td>A string representing the data type. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_metadata_8cpp_source.html#l00086">86</a> of file <a class="el" href="_metadata_8cpp_source.html">Metadata.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a365c4594ad65c3b10b40a1cf4f4aea26" name="a365c4594ad65c3b10b40a1cf4f4aea26"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a365c4594ad65c3b10b40a1cf4f4aea26">◆ </a></span>setDebugEnabled()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Metadata::setDebugEnabled </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>debugFlag</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the debugging flag. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">debugFlag</td><td>Whether debugging is enabled.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Enabling debugging can introduce performance overhead but provides valuable insights during development or testing.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">debugFlag</td><td>Whether debugging is enabled. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_metadata_8cpp_source.html#l00132">132</a> of file <a class="el" href="_metadata_8cpp_source.html">Metadata.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af5264d1666839e69c192b565b5cfa606" name="af5264d1666839e69c192b565b5cfa606"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af5264d1666839e69c192b565b5cfa606">◆ </a></span>setDimensions()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Metadata::setDimensions </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::vector< std::size_t > &</td> <td class="paramname"><span class="paramname"><em>dimensions</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the dimensions of the data. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dimensions</td><td>A vector representing the size of each dimension.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>When modifying dimensions, verify that they are consistent with the actual data representation.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dimensions</td><td>A vector representing the size of each dimension. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_metadata_8cpp_source.html#l00109">109</a> of file <a class="el" href="_metadata_8cpp_source.html">Metadata.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
|
|
<a id="a12949a1ea26c4ff1afeb97101c0493c5" name="a12949a1ea26c4ff1afeb97101c0493c5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a12949a1ea26c4ff1afeb97101c0493c5">◆ </a></span>operator<<</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::ostream & operator<< </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::ostream &</td> <td class="paramname"><span class="paramname"><em>os</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="class_metadata.html">Metadata</a> &</td> <td class="paramname"><span class="paramname"><em>metadata</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel friend">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Prints the metadata information for debugging purposes. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">os</td><td>The output stream to print to. </td></tr>
|
|
<tr><td class="paramname">metadata</td><td>The <a class="el" href="class_metadata.html" title="Represents metadata information for data objects in the dobj module.">Metadata</a> object to print. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A reference to the output stream.</dd></dl>
|
|
<p>This function provides a human-readable summary of the metadata. Useful for quick checks or logging during debugging sessions.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">os</td><td>The output stream to print to. </td></tr>
|
|
<tr><td class="paramname">metadata</td><td>The <a class="el" href="class_metadata.html" title="Represents metadata information for data objects in the dobj module.">Metadata</a> object to print. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A reference to the output stream. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_metadata_8cpp_source.html#l00146">146</a> of file <a class="el" href="_metadata_8cpp_source.html">Metadata.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="ac73a509797c98c0d52fb32e1f93e38bc" name="ac73a509797c98c0d52fb32e1f93e38bc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac73a509797c98c0d52fb32e1f93e38bc">◆ </a></span>byteSize_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int Metadata::byteSize_ = 0</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Total size of the data in bytes. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_metadata_8h_source.html#l00126">126</a> of file <a class="el" href="_metadata_8h_source.html">Metadata.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a290205e5f46416dd0f48bd6ff62888ac" name="a290205e5f46416dd0f48bd6ff62888ac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a290205e5f46416dd0f48bd6ff62888ac">◆ </a></span>dataType_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string Metadata::dataType_</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Type of the data (e.g., "float", "double"). </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_metadata_8h_source.html#l00127">127</a> of file <a class="el" href="_metadata_8h_source.html">Metadata.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a65fd506f1bd41699d9cd19bc0dfc9701" name="a65fd506f1bd41699d9cd19bc0dfc9701"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a65fd506f1bd41699d9cd19bc0dfc9701">◆ </a></span>debugFlag_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Metadata::debugFlag_ = false</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Indicates whether debugging is enabled. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_metadata_8h_source.html#l00129">129</a> of file <a class="el" href="_metadata_8h_source.html">Metadata.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a163f74d4ef9ecd13a34e7e9cab2e21ce" name="a163f74d4ef9ecd13a34e7e9cab2e21ce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a163f74d4ef9ecd13a34e7e9cab2e21ce">◆ </a></span>dimensions_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::vector<std::size_t> Metadata::dimensions_</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Dimensions of the data (e.g., {3, 4} for a 3x4 matrix). </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_metadata_8h_source.html#l00128">128</a> of file <a class="el" href="_metadata_8h_source.html">Metadata.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/dobj/public/<a class="el" href="_metadata_8h_source.html">Metadata.h</a></li>
|
|
<li>src/dobj/private/<a class="el" href="_metadata_8cpp_source.html">Metadata.cpp</a></li>
|
|
</ul>
|
|
</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="class_metadata.html">Metadata</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>
|