Files
ComSquare/AMemory_8hpp_source.html
AnonymusRaccoon d33b0ab52d Deploying the doc
2021-07-13 21:32:24 +00:00

124 lines
13 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">
<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.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ComSquare: sources/Memory/AMemory.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ComSquare
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_08d237fc27d4ecd563f71c5d52f2fecc.html">sources</a></li><li class="navelem"><a class="el" href="dir_b6b0f0b7471b46e8c4cfc0f00c8af2f6.html">Memory</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">AMemory.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="AMemory_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Created by anonymus-raccoon on 1/23/20.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160; </div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &lt;cstdint&gt;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="Ints_8hpp.html">Models/Ints.hpp</a>&quot;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="Components_8hpp.html">Models/Components.hpp</a>&quot;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="IMemory_8hpp.html">IMemory.hpp</a>&quot;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceComSquare_1_1Memory.html">ComSquare::Memory</a></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;{</div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="classComSquare_1_1Memory_1_1AMemory.html"> 18</a></span>&#160; <span class="keyword">class </span><a class="code" href="classComSquare_1_1Memory_1_1AMemory.html">AMemory</a> : <span class="keyword">public</span> <a class="code" href="classComSquare_1_1Memory_1_1IMemory.html">IMemory</a> {</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classComSquare_1_1Memory_1_1AMemory.html#a360315d82100f5a8b0c6f002028054de"> 21</a></span>&#160; <a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> <a class="code" href="classComSquare_1_1Memory_1_1AMemory.html#a360315d82100f5a8b0c6f002028054de">_start</a> = 0;</div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classComSquare_1_1Memory_1_1AMemory.html#a69f0e308e2f8dee9ba61bf9bb96c292b"> 23</a></span>&#160; <a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> <a class="code" href="classComSquare_1_1Memory_1_1AMemory.html#a69f0e308e2f8dee9ba61bf9bb96c292b">_end</a> = 0;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; [[nodiscard]] <a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> <a class="code" href="classComSquare_1_1Memory_1_1AMemory.html#aff943c07bcf7f7ccb88c82fe47127928">getRelativeAddress</a>(<a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classComSquare_1_1Memory_1_1AMemory.html#ae5f0d99dbda62614dda07fdd74d52773">setMemoryRegion</a>(<a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> start, <a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> end);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; [[nodiscard]] <span class="keywordtype">bool</span> <a class="code" href="classComSquare_1_1Memory_1_1AMemory.html#aadca52185b1b3db17d6881e91d81516f">hasMemoryAt</a>(<a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <a class="code" href="classComSquare_1_1Memory_1_1AMemory.html#aed637aac92569a5aa0f0f18095742ff3">~AMemory</a>() <span class="keyword">override</span> = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; };</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aInts_8hpp_html"><div class="ttname"><a href="Ints_8hpp.html">Ints.hpp</a></div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1AMemory_html_aff943c07bcf7f7ccb88c82fe47127928"><div class="ttname"><a href="classComSquare_1_1Memory_1_1AMemory.html#aff943c07bcf7f7ccb88c82fe47127928">ComSquare::Memory::AMemory::getRelativeAddress</a></div><div class="ttdeci">uint24_t getRelativeAddress(uint24_t addr) const override</div><div class="ttdoc">Translate an absolute address to a relative address.</div><div class="ttdef"><b>Definition:</b> AMemory.cpp:9</div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1AMemory_html_aed637aac92569a5aa0f0f18095742ff3"><div class="ttname"><a href="classComSquare_1_1Memory_1_1AMemory.html#aed637aac92569a5aa0f0f18095742ff3">ComSquare::Memory::AMemory::~AMemory</a></div><div class="ttdeci">~AMemory() override=default</div><div class="ttdoc">A default destructor.</div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1AMemory_html_a360315d82100f5a8b0c6f002028054de"><div class="ttname"><a href="classComSquare_1_1Memory_1_1AMemory.html#a360315d82100f5a8b0c6f002028054de">ComSquare::Memory::AMemory::_start</a></div><div class="ttdeci">uint24_t _start</div><div class="ttdoc">The starting address mapped to this component.</div><div class="ttdef"><b>Definition:</b> AMemory.hpp:21</div></div>
<div class="ttc" id="aInts_8hpp_html_a89f009aaf5d1964a000f44f09fa0bcf8"><div class="ttname"><a href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a></div><div class="ttdeci">unsigned uint24_t</div><div class="ttdef"><b>Definition:</b> Ints.hpp:10</div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1IMemory_html"><div class="ttname"><a href="classComSquare_1_1Memory_1_1IMemory.html">ComSquare::Memory::IMemory</a></div><div class="ttdoc">Common interface implemented by all components mapping memory.</div><div class="ttdef"><b>Definition:</b> IMemory.hpp:17</div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1AMemory_html_a69f0e308e2f8dee9ba61bf9bb96c292b"><div class="ttname"><a href="classComSquare_1_1Memory_1_1AMemory.html#a69f0e308e2f8dee9ba61bf9bb96c292b">ComSquare::Memory::AMemory::_end</a></div><div class="ttdeci">uint24_t _end</div><div class="ttdoc">The last continuous address mapped to this components. For shadows, see the MemoryShadow class.</div><div class="ttdef"><b>Definition:</b> AMemory.hpp:23</div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1AMemory_html"><div class="ttname"><a href="classComSquare_1_1Memory_1_1AMemory.html">ComSquare::Memory::AMemory</a></div><div class="ttdoc">Abstract class representing a continuous block of memory.</div><div class="ttdef"><b>Definition:</b> AMemory.hpp:18</div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1AMemory_html_aadca52185b1b3db17d6881e91d81516f"><div class="ttname"><a href="classComSquare_1_1Memory_1_1AMemory.html#aadca52185b1b3db17d6881e91d81516f">ComSquare::Memory::AMemory::hasMemoryAt</a></div><div class="ttdeci">bool hasMemoryAt(uint24_t addr) const override</div><div class="ttdoc">Return true if this component has mapped the address.</div><div class="ttdef"><b>Definition:</b> AMemory.cpp:20</div></div>
<div class="ttc" id="anamespaceComSquare_1_1Memory_html"><div class="ttname"><a href="namespaceComSquare_1_1Memory.html">ComSquare::Memory</a></div><div class="ttdef"><b>Definition:</b> AMemory.cpp:7</div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1AMemory_html_ae5f0d99dbda62614dda07fdd74d52773"><div class="ttname"><a href="classComSquare_1_1Memory_1_1AMemory.html#ae5f0d99dbda62614dda07fdd74d52773">ComSquare::Memory::AMemory::setMemoryRegion</a></div><div class="ttdeci">void setMemoryRegion(uint24_t start, uint24_t end)</div><div class="ttdoc">Change starting and ending points of this mapped memory.</div><div class="ttdef"><b>Definition:</b> AMemory.cpp:14</div></div>
<div class="ttc" id="aIMemory_8hpp_html"><div class="ttname"><a href="IMemory_8hpp.html">IMemory.hpp</a></div></div>
<div class="ttc" id="aComponents_8hpp_html"><div class="ttname"><a href="Components_8hpp.html">Components.hpp</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>