705 lines
50 KiB
HTML
705 lines
50 KiB
HTML
<!-- HTML header for doxygen 1.9.1-->
|
|
<!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">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.15.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>L4Re Operating System Framework: cxx::Bitfield< T, LSB, MSB > Class Template 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>
|
|
<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" />
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="l4re-awesome.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 style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="L4Re_rgb_logo_quer_hg_h55.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">L4Re Operating System Framework
|
|
</div>
|
|
<div id="projectbrief">Interface and Usage Documentation</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.15.0 -->
|
|
<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('classcxx_1_1Bitfield.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">cxx::Bitfield< T, LSB, MSB > Class Template Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Definition for a member (part) of a bit field.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="bitfield_source.html">bitfield</a>></code></p>
|
|
<div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Inheritance diagram for cxx::Bitfield< T, LSB, MSB >:</div>
|
|
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Bitfield__inherit__graph.svg" width="8102" height="582"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
<div id="dynsection-1" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Collaboration diagram for cxx::Bitfield< T, LSB, MSB >:</div>
|
|
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Bitfield__coll__graph.svg" width="174" height="251"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-nested-classes" class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:Value_5Fbase" id="r_Value_5Fbase"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcxx_1_1Bitfield_1_1Value__base.html">Value_base</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Internal helper type. <a href="classcxx_1_1Bitfield_1_1Value__base.html#details">More...</a><br /></td></tr>
|
|
<tr class="memitem:Value" id="r_Value"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcxx_1_1Bitfield_1_1Value.html">Value</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Internal helper type. <a href="classcxx_1_1Bitfield_1_1Value.html#details">More...</a><br /></td></tr>
|
|
<tr class="memitem:Value_5Funshifted" id="r_Value_5Funshifted"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcxx_1_1Bitfield_1_1Value__unshifted.html">Value_unshifted</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Internal helper type. <a href="classcxx_1_1Bitfield_1_1Value__unshifted.html#details">More...</a><br /></td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-pub-types" class="groupheader"><a id="pub-types" name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a104a69c25da249e74ab5858ba67f5c82" id="r_a104a69c25da249e74ab5858ba67f5c82"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <a class="el" href="#a104a69c25da249e74ab5858ba67f5c82aa177a701313bc78e77f61c807e89559a">Bits</a> = MSB + 1 - LSB
|
|
, <a class="el" href="#a104a69c25da249e74ab5858ba67f5c82aae230140b2dc77764062352e4c0b27a2">Lsb</a> = LSB
|
|
, <a class="el" href="#a104a69c25da249e74ab5858ba67f5c82a2f5e6f2d3e1cd25d4c905e680eadcc34">Msb</a> = MSB
|
|
}</td></tr>
|
|
<tr class="memitem:a66cd0a99e4d836c4e1a76250cf6d2d23" id="r_a66cd0a99e4d836c4e1a76250cf6d2d23"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="#a66cd0a99e4d836c4e1a76250cf6d2d23">Masks</a> : Base_type { <a class="el" href="#a66cd0a99e4d836c4e1a76250cf6d2d23ab4b9584d83b7e460678379ba52b3262e">Low_mask</a> = static_cast<Base_type>(~0ULL) >> (sizeof(Base_type)*8 - Bits)
|
|
, <a class="el" href="#a66cd0a99e4d836c4e1a76250cf6d2d23ae140ccae1e38bdcad4354722b4ff888e">Mask</a> = Low_mask << Lsb
|
|
}</td></tr>
|
|
<tr class="memdesc:a66cd0a99e4d836c4e1a76250cf6d2d23"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="#a66cd0a99e4d836c4e1a76250cf6d2d23" title="Masks for bitswise operation on internal parts of a bitfield.">Masks</a> for bitswise operation on internal parts of a bitfield. <a href="#a66cd0a99e4d836c4e1a76250cf6d2d23">More...</a><br /></td></tr>
|
|
<tr class="memitem:ac1dcfd2c2916485bae6edf52e7cb326a" id="r_ac1dcfd2c2916485bae6edf52e7cb326a"><td class="memItemLeft" align="right" valign="top">typedef Best_type< <a class="el" href="#a104a69c25da249e74ab5858ba67f5c82aa177a701313bc78e77f61c807e89559a">Bits</a> >::Type </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac1dcfd2c2916485bae6edf52e7cb326a">Bits_type</a></td></tr>
|
|
<tr class="memdesc:ac1dcfd2c2916485bae6edf52e7cb326a"><td class="mdescLeft"> </td><td class="mdescRight">Type to hold at least <a class="el" href="#a104a69c25da249e74ab5858ba67f5c82aa177a701313bc78e77f61c807e89559a" title="Number of bits.">Bits</a> bits. <br /></td></tr>
|
|
<tr class="memitem:a781d6d6a9d4788f56f8071ce9b2b9ca3" id="r_a781d6d6a9d4788f56f8071ce9b2b9ca3"><td class="memItemLeft" align="right" valign="top">typedef Best_type< <a class="el" href="#a104a69c25da249e74ab5858ba67f5c82aa177a701313bc78e77f61c807e89559a">Bits</a>+<a class="el" href="#a104a69c25da249e74ab5858ba67f5c82aae230140b2dc77764062352e4c0b27a2">Lsb</a> >::Type </td><td class="memItemRight" valign="bottom"><a class="el" href="#a781d6d6a9d4788f56f8071ce9b2b9ca3">Shift_type</a></td></tr>
|
|
<tr class="memdesc:a781d6d6a9d4788f56f8071ce9b2b9ca3"><td class="mdescLeft"> </td><td class="mdescRight">Type to hold at least <a class="el" href="#a104a69c25da249e74ab5858ba67f5c82aa177a701313bc78e77f61c807e89559a" title="Number of bits.">Bits</a> + <a class="el" href="#a104a69c25da249e74ab5858ba67f5c82aae230140b2dc77764062352e4c0b27a2" title="index of the LSB">Lsb</a> bits. <br /></td></tr>
|
|
<tr class="memitem:af4ee89e7f26d1628bd4c702959ca4fbc" id="r_af4ee89e7f26d1628bd4c702959ca4fbc"><td class="memItemLeft" align="right" valign="top"><a id="af4ee89e7f26d1628bd4c702959ca4fbc" name="af4ee89e7f26d1628bd4c702959ca4fbc"></a>
|
|
typedef <a class="el" href="classcxx_1_1Bitfield_1_1Value.html">Value</a>< Base_type & > </td><td class="memItemRight" valign="bottom"><b>Ref</b></td></tr>
|
|
<tr class="memdesc:af4ee89e7f26d1628bd4c702959ca4fbc"><td class="mdescLeft"> </td><td class="mdescRight">Reference type to access the bits inside a raw bit field. <br /></td></tr>
|
|
<tr class="memitem:a60d8b3892a758f5b30875df738df6469" id="r_a60d8b3892a758f5b30875df738df6469"><td class="memItemLeft" align="right" valign="top"><a id="a60d8b3892a758f5b30875df738df6469" name="a60d8b3892a758f5b30875df738df6469"></a>
|
|
typedef <a class="el" href="classcxx_1_1Bitfield_1_1Value.html">Value</a>< Base_type volatile & > </td><td class="memItemRight" valign="bottom"><b>Ref_volatile</b></td></tr>
|
|
<tr class="memdesc:a60d8b3892a758f5b30875df738df6469"><td class="mdescLeft"> </td><td class="mdescRight">Volatile reference type to access the bits inside a raw bit field. <br /></td></tr>
|
|
<tr class="memitem:a801b1fb423551966bfd9a0d773e3b036" id="r_a801b1fb423551966bfd9a0d773e3b036"><td class="memItemLeft" align="right" valign="top"><a id="a801b1fb423551966bfd9a0d773e3b036" name="a801b1fb423551966bfd9a0d773e3b036"></a>
|
|
typedef <a class="el" href="classcxx_1_1Bitfield_1_1Value.html">Value</a>< Base_type const > </td><td class="memItemRight" valign="bottom"><b>Val</b></td></tr>
|
|
<tr class="memdesc:a801b1fb423551966bfd9a0d773e3b036"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classcxx_1_1Bitfield_1_1Value.html" title="Internal helper type.">Value</a> type to access the bits inside a raw bit field. <br /></td></tr>
|
|
<tr class="memitem:acfb81932e19cd94bfac4cf870e639936" id="r_acfb81932e19cd94bfac4cf870e639936"><td class="memItemLeft" align="right" valign="top"><a id="acfb81932e19cd94bfac4cf870e639936" name="acfb81932e19cd94bfac4cf870e639936"></a>
|
|
typedef <a class="el" href="classcxx_1_1Bitfield_1_1Value__unshifted.html">Value_unshifted</a>< Base_type & > </td><td class="memItemRight" valign="bottom"><b>Ref_unshifted</b></td></tr>
|
|
<tr class="memdesc:acfb81932e19cd94bfac4cf870e639936"><td class="mdescLeft"> </td><td class="mdescRight">Reference type to access the bits inside a raw bit field (in place). <br /></td></tr>
|
|
<tr class="memitem:a2f557c49aec16845516dde95373fdf9f" id="r_a2f557c49aec16845516dde95373fdf9f"><td class="memItemLeft" align="right" valign="top"><a id="a2f557c49aec16845516dde95373fdf9f" name="a2f557c49aec16845516dde95373fdf9f"></a>
|
|
typedef <a class="el" href="classcxx_1_1Bitfield_1_1Value__unshifted.html">Value_unshifted</a>< Base_type volatile & > </td><td class="memItemRight" valign="bottom"><b>Ref_unshifted_volatile</b></td></tr>
|
|
<tr class="memdesc:a2f557c49aec16845516dde95373fdf9f"><td class="mdescLeft"> </td><td class="mdescRight">Volatile reference type to access the bits inside a raw bit field (in place). <br /></td></tr>
|
|
<tr class="memitem:aeac44da9ba4a2d0e37047a2aa0c2a4dc" id="r_aeac44da9ba4a2d0e37047a2aa0c2a4dc"><td class="memItemLeft" align="right" valign="top"><a id="aeac44da9ba4a2d0e37047a2aa0c2a4dc" name="aeac44da9ba4a2d0e37047a2aa0c2a4dc"></a>
|
|
typedef <a class="el" href="classcxx_1_1Bitfield_1_1Value__unshifted.html">Value_unshifted</a>< Base_type const > </td><td class="memItemRight" valign="bottom"><b>Val_unshifted</b></td></tr>
|
|
<tr class="memdesc:aeac44da9ba4a2d0e37047a2aa0c2a4dc"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classcxx_1_1Bitfield_1_1Value.html" title="Internal helper type.">Value</a> type to access the bits inside a raw bit field (in place). <br /></td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-pub-static-methods" class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a06fdbf197205ae22f89a997a03f7d873" id="r_a06fdbf197205ae22f89a997a03f7d873"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="#ac1dcfd2c2916485bae6edf52e7cb326a">Bits_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a06fdbf197205ae22f89a997a03f7d873">get</a> (<a class="el" href="#a781d6d6a9d4788f56f8071ce9b2b9ca3">Shift_type</a> <a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367">val</a>)</td></tr>
|
|
<tr class="memdesc:a06fdbf197205ae22f89a997a03f7d873"><td class="mdescLeft"> </td><td class="mdescRight">Get the bits out of <span class="tt"><a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367" title="Get the shifted bits for val.">val</a></span>. <br /></td></tr>
|
|
<tr class="memitem:ae5f0c0601a22cf6cf61c19a3e61dcaa8" id="r_ae5f0c0601a22cf6cf61c19a3e61dcaa8"><td class="memItemLeft" align="right" valign="top">static constexpr Base_type </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae5f0c0601a22cf6cf61c19a3e61dcaa8">get_unshifted</a> (<a class="el" href="#a781d6d6a9d4788f56f8071ce9b2b9ca3">Shift_type</a> <a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367">val</a>)</td></tr>
|
|
<tr class="memdesc:ae5f0c0601a22cf6cf61c19a3e61dcaa8"><td class="mdescLeft"> </td><td class="mdescRight">Get the bits in place out of <span class="tt"><a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367" title="Get the shifted bits for val.">val</a></span>. <br /></td></tr>
|
|
<tr class="memitem:ae7ae0469cb02433656c409037496c1c5" id="r_ae7ae0469cb02433656c409037496c1c5"><td class="memItemLeft" align="right" valign="top">static constexpr Base_type </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae7ae0469cb02433656c409037496c1c5">set_dirty</a> (Base_type dest, <a class="el" href="#a781d6d6a9d4788f56f8071ce9b2b9ca3">Shift_type</a> <a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367">val</a>)</td></tr>
|
|
<tr class="memdesc:ae7ae0469cb02433656c409037496c1c5"><td class="mdescLeft"> </td><td class="mdescRight">Set the bits corresponding to <span class="tt"><a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367" title="Get the shifted bits for val.">val</a></span>. <br /></td></tr>
|
|
<tr class="memitem:a8e305e8c9e712e990c0c433563df6e9d" id="r_a8e305e8c9e712e990c0c433563df6e9d"><td class="memItemLeft" align="right" valign="top">static constexpr Base_type </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8e305e8c9e712e990c0c433563df6e9d">set_unshifted_dirty</a> (Base_type dest, <a class="el" href="#a781d6d6a9d4788f56f8071ce9b2b9ca3">Shift_type</a> <a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367">val</a>)</td></tr>
|
|
<tr class="memdesc:a8e305e8c9e712e990c0c433563df6e9d"><td class="mdescLeft"> </td><td class="mdescRight">Set the bits corresponding to <span class="tt"><a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367" title="Get the shifted bits for val.">val</a></span>. <br /></td></tr>
|
|
<tr class="memitem:a6f6d68cd9ec3d1e73d4cfbf09a152a3d" id="r_a6f6d68cd9ec3d1e73d4cfbf09a152a3d"><td class="memItemLeft" align="right" valign="top">static Base_type </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6f6d68cd9ec3d1e73d4cfbf09a152a3d">set</a> (Base_type dest, <a class="el" href="#ac1dcfd2c2916485bae6edf52e7cb326a">Bits_type</a> <a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367">val</a>)</td></tr>
|
|
<tr class="memdesc:a6f6d68cd9ec3d1e73d4cfbf09a152a3d"><td class="mdescLeft"> </td><td class="mdescRight">Set the bits corresponding to <span class="tt"><a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367" title="Get the shifted bits for val.">val</a></span>. <br /></td></tr>
|
|
<tr class="memitem:acf71654863853313e89cc5af4b6bdd3a" id="r_acf71654863853313e89cc5af4b6bdd3a"><td class="memItemLeft" align="right" valign="top">static Base_type </td><td class="memItemRight" valign="bottom"><a class="el" href="#acf71654863853313e89cc5af4b6bdd3a">set_unshifted</a> (Base_type dest, <a class="el" href="#a781d6d6a9d4788f56f8071ce9b2b9ca3">Shift_type</a> <a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367">val</a>)</td></tr>
|
|
<tr class="memdesc:acf71654863853313e89cc5af4b6bdd3a"><td class="mdescLeft"> </td><td class="mdescRight">Set the bits corresponding to <span class="tt"><a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367" title="Get the shifted bits for val.">val</a></span>. <br /></td></tr>
|
|
<tr class="memitem:a818da07b2e19e478f5deb4f30fed2b68" id="r_a818da07b2e19e478f5deb4f30fed2b68"><td class="memItemLeft" align="right" valign="top">static constexpr Base_type </td><td class="memItemRight" valign="bottom"><a class="el" href="#a818da07b2e19e478f5deb4f30fed2b68">val_dirty</a> (<a class="el" href="#a781d6d6a9d4788f56f8071ce9b2b9ca3">Shift_type</a> <a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367">val</a>)</td></tr>
|
|
<tr class="memdesc:a818da07b2e19e478f5deb4f30fed2b68"><td class="mdescLeft"> </td><td class="mdescRight">Get the shifted bits for <span class="tt"><a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367" title="Get the shifted bits for val.">val</a></span>. <br /></td></tr>
|
|
<tr class="memitem:a9eb831cf0efee1b05529a685f9cf8367" id="r_a9eb831cf0efee1b05529a685f9cf8367"><td class="memItemLeft" align="right" valign="top">static constexpr Base_type </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367">val</a> (<a class="el" href="#ac1dcfd2c2916485bae6edf52e7cb326a">Bits_type</a> val)</td></tr>
|
|
<tr class="memdesc:a9eb831cf0efee1b05529a685f9cf8367"><td class="mdescLeft"> </td><td class="mdescRight">Get the shifted bits for <span class="tt"><a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367" title="Get the shifted bits for val.">val</a></span>. <br /></td></tr>
|
|
<tr class="memitem:a348dd87b1a812459bf3a575c89925f16" id="r_a348dd87b1a812459bf3a575c89925f16"><td class="memItemLeft" align="right" valign="top">static constexpr Base_type </td><td class="memItemRight" valign="bottom"><a class="el" href="#a348dd87b1a812459bf3a575c89925f16">val_unshifted</a> (<a class="el" href="#a781d6d6a9d4788f56f8071ce9b2b9ca3">Shift_type</a> <a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367">val</a>)</td></tr>
|
|
<tr class="memdesc:a348dd87b1a812459bf3a575c89925f16"><td class="mdescLeft"> </td><td class="mdescRight">Get the shifted bits for <span class="tt"><a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367" title="Get the shifted bits for val.">val</a></span>. <br /></td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><div class="compoundTemplParams">template<typename T, unsigned LSB, unsigned MSB><br />
|
|
class cxx::Bitfield< T, LSB, MSB ></div><p>Definition for a member (part) of a bit field. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">T</td><td>The underlying type of the bit field. </td></tr>
|
|
<tr><td class="paramname">LSB</td><td>The least significant bit of our bits. </td></tr>
|
|
<tr><td class="paramname">MSB</td><td>The most significant bit of our bits. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="bitfield_source.html#l00024">24</a> of file <a class="el" href="bitfield_source.html">bitfield</a>.</p>
|
|
</div><a name="doc-typedef-members" id="doc-typedef-members"></a><h2 id="header-doc-typedef-members" class="groupheader">Member Typedef Documentation</h2>
|
|
<a id="ac1dcfd2c2916485bae6edf52e7cb326a" name="ac1dcfd2c2916485bae6edf52e7cb326a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac1dcfd2c2916485bae6edf52e7cb326a">◆ </a></span>Bits_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T, unsigned LSB, unsigned MSB> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef Best_type<<a class="el" href="#a104a69c25da249e74ab5858ba67f5c82aa177a701313bc78e77f61c807e89559a">Bits</a>>::Type <a class="el" href="classcxx_1_1Bitfield.html">cxx::Bitfield</a>< T, LSB, MSB >::Bits_type</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Type to hold at least <a class="el" href="#a104a69c25da249e74ab5858ba67f5c82aa177a701313bc78e77f61c807e89559a" title="Number of bits.">Bits</a> bits. </p>
|
|
<p>This type can handle all values that can be stored in this part of the bit field. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="bitfield_source.html#l00074">74</a> of file <a class="el" href="bitfield_source.html">bitfield</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a781d6d6a9d4788f56f8071ce9b2b9ca3" name="a781d6d6a9d4788f56f8071ce9b2b9ca3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a781d6d6a9d4788f56f8071ce9b2b9ca3">◆ </a></span>Shift_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T, unsigned LSB, unsigned MSB> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef Best_type<<a class="el" href="#a104a69c25da249e74ab5858ba67f5c82aa177a701313bc78e77f61c807e89559a">Bits</a>+<a class="el" href="#a104a69c25da249e74ab5858ba67f5c82aae230140b2dc77764062352e4c0b27a2">Lsb</a>>::Type <a class="el" href="classcxx_1_1Bitfield.html">cxx::Bitfield</a>< T, LSB, MSB >::Shift_type</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Type to hold at least <a class="el" href="#a104a69c25da249e74ab5858ba67f5c82aa177a701313bc78e77f61c807e89559a" title="Number of bits.">Bits</a> + <a class="el" href="#a104a69c25da249e74ab5858ba67f5c82aae230140b2dc77764062352e4c0b27a2" title="index of the LSB">Lsb</a> bits. </p>
|
|
<p>This type can handle all values that can be stored in this part of the bit field when they are at the target location (<a class="el" href="#a104a69c25da249e74ab5858ba67f5c82aae230140b2dc77764062352e4c0b27a2" title="index of the LSB">Lsb</a> bits shifted to the left). </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="bitfield_source.html#l00082">82</a> of file <a class="el" href="bitfield_source.html">bitfield</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="doc-enum-members" id="doc-enum-members"></a><h2 id="header-doc-enum-members" class="groupheader">Member Enumeration Documentation</h2>
|
|
<a id="a104a69c25da249e74ab5858ba67f5c82" name="a104a69c25da249e74ab5858ba67f5c82"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a104a69c25da249e74ab5858ba67f5c82">◆ </a></span>anonymous enum</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T, unsigned LSB, unsigned MSB> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">anonymous enum</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a104a69c25da249e74ab5858ba67f5c82aa177a701313bc78e77f61c807e89559a" name="a104a69c25da249e74ab5858ba67f5c82aa177a701313bc78e77f61c807e89559a"></a>Bits </td><td class="fielddoc"><p>Number of bits. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a104a69c25da249e74ab5858ba67f5c82aae230140b2dc77764062352e4c0b27a2" name="a104a69c25da249e74ab5858ba67f5c82aae230140b2dc77764062352e4c0b27a2"></a>Lsb </td><td class="fielddoc"><p>index of the LSB </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a104a69c25da249e74ab5858ba67f5c82a2f5e6f2d3e1cd25d4c905e680eadcc34" name="a104a69c25da249e74ab5858ba67f5c82a2f5e6f2d3e1cd25d4c905e680eadcc34"></a>Msb </td><td class="fielddoc"><p>index of the MSB </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="bitfield_source.html#l00052">52</a> of file <a class="el" href="bitfield_source.html">bitfield</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a66cd0a99e4d836c4e1a76250cf6d2d23" name="a66cd0a99e4d836c4e1a76250cf6d2d23"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a66cd0a99e4d836c4e1a76250cf6d2d23">◆ </a></span>Masks</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T, unsigned LSB, unsigned MSB> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="#a66cd0a99e4d836c4e1a76250cf6d2d23">cxx::Bitfield::Masks</a> : Base_type</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p><a class="el" href="#a66cd0a99e4d836c4e1a76250cf6d2d23" title="Masks for bitswise operation on internal parts of a bitfield.">Masks</a> for bitswise operation on internal parts of a bitfield. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a66cd0a99e4d836c4e1a76250cf6d2d23ab4b9584d83b7e460678379ba52b3262e" name="a66cd0a99e4d836c4e1a76250cf6d2d23ab4b9584d83b7e460678379ba52b3262e"></a>Low_mask </td><td class="fielddoc"><p>Mask value to get <a class="el" href="#a104a69c25da249e74ab5858ba67f5c82aa177a701313bc78e77f61c807e89559a" title="Number of bits.">Bits</a> bits. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a66cd0a99e4d836c4e1a76250cf6d2d23ae140ccae1e38bdcad4354722b4ff888e" name="a66cd0a99e4d836c4e1a76250cf6d2d23ae140ccae1e38bdcad4354722b4ff888e"></a>Mask </td><td class="fielddoc"><p>Mask value to the bits out of a <span class="tt">T</span>. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="bitfield_source.html#l00060">60</a> of file <a class="el" href="bitfield_source.html">bitfield</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
|
|
<a id="a06fdbf197205ae22f89a997a03f7d873" name="a06fdbf197205ae22f89a997a03f7d873"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a06fdbf197205ae22f89a997a03f7d873">◆ </a></span>get()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T, unsigned LSB, unsigned MSB> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">constexpr <a class="el" href="#ac1dcfd2c2916485bae6edf52e7cb326a">Bits_type</a> <a class="el" href="classcxx_1_1Bitfield.html">cxx::Bitfield</a>< T, LSB, MSB >::get </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a781d6d6a9d4788f56f8071ce9b2b9ca3">Shift_type</a></td> <td class="paramname"><span class="paramname"><em>val</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the bits out of <span class="tt"><a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367" title="Get the shifted bits for val.">val</a></span>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">val</td><td>The raw value of the whole bit field.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The bits form <a class="el" href="#a104a69c25da249e74ab5858ba67f5c82aae230140b2dc77764062352e4c0b27a2" title="index of the LSB">Lsb</a> to <a class="el" href="#a104a69c25da249e74ab5858ba67f5c82a2f5e6f2d3e1cd25d4c905e680eadcc34" title="index of the MSB">Msb</a> shifted to the right. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="bitfield_source.html#l00099">99</a> of file <a class="el" href="bitfield_source.html">bitfield</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae5f0c0601a22cf6cf61c19a3e61dcaa8" name="ae5f0c0601a22cf6cf61c19a3e61dcaa8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae5f0c0601a22cf6cf61c19a3e61dcaa8">◆ </a></span>get_unshifted()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T, unsigned LSB, unsigned MSB> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">constexpr Base_type <a class="el" href="classcxx_1_1Bitfield.html">cxx::Bitfield</a>< T, LSB, MSB >::get_unshifted </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a781d6d6a9d4788f56f8071ce9b2b9ca3">Shift_type</a></td> <td class="paramname"><span class="paramname"><em>val</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the bits in place out of <span class="tt"><a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367" title="Get the shifted bits for val.">val</a></span>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">val</td><td>The raw value of the whole bit field.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The bits from <a class="el" href="#a104a69c25da249e74ab5858ba67f5c82aae230140b2dc77764062352e4c0b27a2" title="index of the LSB">Lsb</a> to <a class="el" href="#a104a69c25da249e74ab5858ba67f5c82a2f5e6f2d3e1cd25d4c905e680eadcc34" title="index of the MSB">Msb</a> (unshifted).</dd></dl>
|
|
<p>This means other bits are masked out, however the result is not shifted to the right. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="bitfield_source.html#l00112">112</a> of file <a class="el" href="bitfield_source.html">bitfield</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6f6d68cd9ec3d1e73d4cfbf09a152a3d" name="a6f6d68cd9ec3d1e73d4cfbf09a152a3d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6f6d68cd9ec3d1e73d4cfbf09a152a3d">◆ </a></span>set()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T, unsigned LSB, unsigned MSB> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Base_type <a class="el" href="classcxx_1_1Bitfield.html">cxx::Bitfield</a>< T, LSB, MSB >::set </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Base_type</td> <td class="paramname"><span class="paramname"><em>dest</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="#ac1dcfd2c2916485bae6edf52e7cb326a">Bits_type</a></td> <td class="paramname"><span class="paramname"><em>val</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the bits corresponding to <span class="tt"><a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367" title="Get the shifted bits for val.">val</a></span>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dest</td><td>The current value of the whole bit field. </td></tr>
|
|
<tr><td class="paramname">val</td><td>The value to set into the bits.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The new value of the whole bit field. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="bitfield_source.html#l00161">161</a> of file <a class="el" href="bitfield_source.html">bitfield</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae7ae0469cb02433656c409037496c1c5" name="ae7ae0469cb02433656c409037496c1c5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae7ae0469cb02433656c409037496c1c5">◆ </a></span>set_dirty()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T, unsigned LSB, unsigned MSB> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">constexpr Base_type <a class="el" href="classcxx_1_1Bitfield.html">cxx::Bitfield</a>< T, LSB, MSB >::set_dirty </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Base_type</td> <td class="paramname"><span class="paramname"><em>dest</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="#a781d6d6a9d4788f56f8071ce9b2b9ca3">Shift_type</a></td> <td class="paramname"><span class="paramname"><em>val</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the bits corresponding to <span class="tt"><a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367" title="Get the shifted bits for val.">val</a></span>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dest</td><td>The current value of the whole bit field. </td></tr>
|
|
<tr><td class="paramname">val</td><td>The value to set into the bits.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The new value of the whole bit field.</dd></dl>
|
|
<dl class="section pre"><dt>Precondition</dt><dd><span class="tt"><a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367" title="Get the shifted bits for val.">val</a></span> must not contain more than <a class="el" href="#a104a69c25da249e74ab5858ba67f5c82aa177a701313bc78e77f61c807e89559a" title="Number of bits.">Bits</a> bits.</dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>This function does not mask <span class="tt"><a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367" title="Get the shifted bits for val.">val</a></span> to the right number of bits. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="bitfield_source.html#l00127">127</a> of file <a class="el" href="bitfield_source.html">bitfield</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="bitfield_source.html#l00161">cxx::Bitfield< decltype(raw), 0, 0 >::set()</a>.</p>
|
|
<div id="dynsection-2" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</div>
|
|
<div id="dynsection-2-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-2-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Bitfield_ae7ae0469cb02433656c409037496c1c5_icgraph.svg" width="356" height="51"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acf71654863853313e89cc5af4b6bdd3a" name="acf71654863853313e89cc5af4b6bdd3a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acf71654863853313e89cc5af4b6bdd3a">◆ </a></span>set_unshifted()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T, unsigned LSB, unsigned MSB> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Base_type <a class="el" href="classcxx_1_1Bitfield.html">cxx::Bitfield</a>< T, LSB, MSB >::set_unshifted </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Base_type</td> <td class="paramname"><span class="paramname"><em>dest</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="#a781d6d6a9d4788f56f8071ce9b2b9ca3">Shift_type</a></td> <td class="paramname"><span class="paramname"><em>val</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the bits corresponding to <span class="tt"><a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367" title="Get the shifted bits for val.">val</a></span>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dest</td><td>The current value of the whole bit field. </td></tr>
|
|
<tr><td class="paramname">val</td><td>The value shifted <a class="el" href="#a104a69c25da249e74ab5858ba67f5c82aae230140b2dc77764062352e4c0b27a2" title="index of the LSB">Lsb</a> bits to the left that shall be set into the bit field.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>the new value of the whole bit field. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="bitfield_source.html#l00173">173</a> of file <a class="el" href="bitfield_source.html">bitfield</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8e305e8c9e712e990c0c433563df6e9d" name="a8e305e8c9e712e990c0c433563df6e9d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8e305e8c9e712e990c0c433563df6e9d">◆ </a></span>set_unshifted_dirty()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T, unsigned LSB, unsigned MSB> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">constexpr Base_type <a class="el" href="classcxx_1_1Bitfield.html">cxx::Bitfield</a>< T, LSB, MSB >::set_unshifted_dirty </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Base_type</td> <td class="paramname"><span class="paramname"><em>dest</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="#a781d6d6a9d4788f56f8071ce9b2b9ca3">Shift_type</a></td> <td class="paramname"><span class="paramname"><em>val</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the bits corresponding to <span class="tt"><a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367" title="Get the shifted bits for val.">val</a></span>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dest</td><td>The current value of the whole bit field. </td></tr>
|
|
<tr><td class="paramname">val</td><td>The value shifted <a class="el" href="#a104a69c25da249e74ab5858ba67f5c82aae230140b2dc77764062352e4c0b27a2" title="index of the LSB">Lsb</a> bits to the left that shall be set into the bits.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The new value of the whole bit field.</dd></dl>
|
|
<dl class="section pre"><dt>Precondition</dt><dd><span class="tt"><a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367" title="Get the shifted bits for val.">val</a></span> must not contain more than <a class="el" href="#a104a69c25da249e74ab5858ba67f5c82aa177a701313bc78e77f61c807e89559a" title="Number of bits.">Bits</a> bits shifted <a class="el" href="#a104a69c25da249e74ab5858ba67f5c82aae230140b2dc77764062352e4c0b27a2" title="index of the LSB">Lsb</a> bits to the left.</dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>This function does not mask <span class="tt"><a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367" title="Get the shifted bits for val.">val</a></span> to the right number of bits. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="bitfield_source.html#l00147">147</a> of file <a class="el" href="bitfield_source.html">bitfield</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="bitfield_source.html#l00173">cxx::Bitfield< decltype(raw), 0, 0 >::set_unshifted()</a>.</p>
|
|
<div id="dynsection-3" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</div>
|
|
<div id="dynsection-3-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-3-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Bitfield_a8e305e8c9e712e990c0c433563df6e9d_icgraph.svg" width="384" height="51"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9eb831cf0efee1b05529a685f9cf8367" name="a9eb831cf0efee1b05529a685f9cf8367"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9eb831cf0efee1b05529a685f9cf8367">◆ </a></span>val()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T, unsigned LSB, unsigned MSB> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">constexpr Base_type <a class="el" href="classcxx_1_1Bitfield.html">cxx::Bitfield</a>< T, LSB, MSB >::val </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#ac1dcfd2c2916485bae6edf52e7cb326a">Bits_type</a></td> <td class="paramname"><span class="paramname"><em>val</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the shifted bits for <span class="tt"><a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367" title="Get the shifted bits for val.">val</a></span>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">val</td><td>The value to set into the bits.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The raw bit field value. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="bitfield_source.html#l00196">196</a> of file <a class="el" href="bitfield_source.html">bitfield</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a818da07b2e19e478f5deb4f30fed2b68" name="a818da07b2e19e478f5deb4f30fed2b68"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a818da07b2e19e478f5deb4f30fed2b68">◆ </a></span>val_dirty()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T, unsigned LSB, unsigned MSB> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">constexpr Base_type <a class="el" href="classcxx_1_1Bitfield.html">cxx::Bitfield</a>< T, LSB, MSB >::val_dirty </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a781d6d6a9d4788f56f8071ce9b2b9ca3">Shift_type</a></td> <td class="paramname"><span class="paramname"><em>val</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the shifted bits for <span class="tt"><a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367" title="Get the shifted bits for val.">val</a></span>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">val</td><td>The value to set into the bits.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The raw bit field value.</dd></dl>
|
|
<dl class="section pre"><dt>Precondition</dt><dd><span class="tt"><a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367" title="Get the shifted bits for val.">val</a></span> must not contain more than <a class="el" href="#a104a69c25da249e74ab5858ba67f5c82aa177a701313bc78e77f61c807e89559a" title="Number of bits.">Bits</a> bits.</dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>This function does not mask <span class="tt"><a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367" title="Get the shifted bits for val.">val</a></span> to the right number of bits. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="bitfield_source.html#l00187">187</a> of file <a class="el" href="bitfield_source.html">bitfield</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="bitfield_source.html#l00196">cxx::Bitfield< decltype(raw), 0, 0 >::val()</a>.</p>
|
|
<div id="dynsection-4" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</div>
|
|
<div id="dynsection-4-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-4-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Bitfield_a818da07b2e19e478f5deb4f30fed2b68_icgraph.svg" width="639" height="435"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a348dd87b1a812459bf3a575c89925f16" name="a348dd87b1a812459bf3a575c89925f16"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a348dd87b1a812459bf3a575c89925f16">◆ </a></span>val_unshifted()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T, unsigned LSB, unsigned MSB> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">constexpr Base_type <a class="el" href="classcxx_1_1Bitfield.html">cxx::Bitfield</a>< T, LSB, MSB >::val_unshifted </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a781d6d6a9d4788f56f8071ce9b2b9ca3">Shift_type</a></td> <td class="paramname"><span class="paramname"><em>val</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the shifted bits for <span class="tt"><a class="el" href="#a9eb831cf0efee1b05529a685f9cf8367" title="Get the shifted bits for val.">val</a></span>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">val</td><td>The value shifted <a class="el" href="#a104a69c25da249e74ab5858ba67f5c82aae230140b2dc77764062352e4c0b27a2" title="index of the LSB">Lsb</a> bits to the left that shall be set into the bits.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The raw bit field value. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="bitfield_source.html#l00206">206</a> of file <a class="el" href="bitfield_source.html">bitfield</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>l4/cxx/<a class="el" href="bitfield_source.html">bitfield</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 -->
|
|
<!-- HTML footer for doxygen 1.9.1-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a href="namespacecxx.html">cxx</a></li><li class="navelem"><a href="classcxx_1_1Bitfield.html">Bitfield</a></li>
|
|
<li class="footer">Generated on <span class="timestamp"></span> for L4Re Operating System Framework by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|