Files
moslab-code/doc/source/html/classL4vcpu_1_1State.html
2025-09-12 15:55:45 +02:00

299 lines
13 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: L4vcpu::State 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>
<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('classL4vcpu_1_1State.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">L4vcpu::State Class Reference<div class="ingroups"><a class="el" href="group__api__libvcpu.html">vCPU Support Library</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>C++ implementation of state word in the vCPU area.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="vcpu_source.html">vcpu</a>&gt;</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>Collaboration diagram for L4vcpu::State:</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="classL4vcpu_1_1State__coll__graph.svg" width="114" height="136"><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-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:abeace1f0e3a18ae88f23abc55f49743f" id="r_abeace1f0e3a18ae88f23abc55f49743f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abeace1f0e3a18ae88f23abc55f49743f">State</a> (unsigned v)</td></tr>
<tr class="memdesc:abeace1f0e3a18ae88f23abc55f49743f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize state. <br /></td></tr>
<tr class="memitem:a7de8ab5f3939c2a415f1fadd7aa9ae52" id="r_a7de8ab5f3939c2a415f1fadd7aa9ae52"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7de8ab5f3939c2a415f1fadd7aa9ae52">add</a> (unsigned bits) throw ()</td></tr>
<tr class="memdesc:a7de8ab5f3939c2a415f1fadd7aa9ae52"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add flags. <br /></td></tr>
<tr class="memitem:ad5a1e16dfef69c5d359f6cac6c05a53c" id="r_ad5a1e16dfef69c5d359f6cac6c05a53c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad5a1e16dfef69c5d359f6cac6c05a53c">clear</a> (unsigned bits) throw ()</td></tr>
<tr class="memdesc:ad5a1e16dfef69c5d359f6cac6c05a53c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear flags. <br /></td></tr>
<tr class="memitem:a789c2da9e14fee921107c968332347cb" id="r_a789c2da9e14fee921107c968332347cb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a789c2da9e14fee921107c968332347cb">set</a> (unsigned v) throw ()</td></tr>
<tr class="memdesc:a789c2da9e14fee921107c968332347cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set flags. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>C++ implementation of state word in the vCPU area. </p>
<p class="definition">Definition at line <a class="el" href="vcpu_source.html#l00024">24</a> of file <a class="el" href="vcpu_source.html">vcpu</a>.</p>
</div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="abeace1f0e3a18ae88f23abc55f49743f" name="abeace1f0e3a18ae88f23abc55f49743f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abeace1f0e3a18ae88f23abc55f49743f">&#9670;&#160;</a></span>State()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">L4vcpu::State::State </td>
<td>(</td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>v</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 explicit">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize state. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">v</td><td>Initial state. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="vcpu_source.html#l00034">34</a> of file <a class="el" href="vcpu_source.html">vcpu</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="a7de8ab5f3939c2a415f1fadd7aa9ae52" name="a7de8ab5f3939c2a415f1fadd7aa9ae52"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7de8ab5f3939c2a415f1fadd7aa9ae52">&#9670;&#160;</a></span>add()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void L4vcpu::State::add </td>
<td>(</td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>bits</em></span></td><td>)</td>
<td></td>
</tr>
<tr>
<td align="right">throw </td><td>(</td><td colspan="2">&#160;)</td><td></td><td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Add flags. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bits</td><td>Bits to add to the word. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="vcpu_source.html#l00041">41</a> of file <a class="el" href="vcpu_source.html">vcpu</a>.</p>
</div>
</div>
<a id="ad5a1e16dfef69c5d359f6cac6c05a53c" name="ad5a1e16dfef69c5d359f6cac6c05a53c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5a1e16dfef69c5d359f6cac6c05a53c">&#9670;&#160;</a></span>clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void L4vcpu::State::clear </td>
<td>(</td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>bits</em></span></td><td>)</td>
<td></td>
</tr>
<tr>
<td align="right">throw </td><td>(</td><td colspan="2">&#160;)</td><td></td><td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clear flags. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bits</td><td>Bits to clear in the word. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="vcpu_source.html#l00048">48</a> of file <a class="el" href="vcpu_source.html">vcpu</a>.</p>
</div>
</div>
<a id="a789c2da9e14fee921107c968332347cb" name="a789c2da9e14fee921107c968332347cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a789c2da9e14fee921107c968332347cb">&#9670;&#160;</a></span>set()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void L4vcpu::State::set </td>
<td>(</td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>v</em></span></td><td>)</td>
<td></td>
</tr>
<tr>
<td align="right">throw </td><td>(</td><td colspan="2">&#160;)</td><td></td><td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set flags. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">v</td><td>Set the word to the value of v. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="vcpu_source.html#l00055">55</a> of file <a class="el" href="vcpu_source.html">vcpu</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>l4/vcpu/<a class="el" href="vcpu_source.html">vcpu</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"><b>L4vcpu</b></li><li class="navelem"><a href="classL4vcpu_1_1State.html">State</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>