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

127 lines
15 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/ARectangleMemory.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">ARectangleMemory.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="ARectangleMemory_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/29/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 &quot;<a class="code" href="IMemory_8hpp.html">IMemory.hpp</a>&quot;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</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="l00009"></a><span class="lineno"> 9</span>&#160; </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceComSquare_1_1Memory.html">ComSquare::Memory</a></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;{</div>
<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="classComSquare_1_1Memory_1_1ARectangleMemory.html"> 13</a></span>&#160; <span class="keyword">class </span><a class="code" href="classComSquare_1_1Memory_1_1ARectangleMemory.html">ARectangleMemory</a> : <span class="keyword">public</span> <a class="code" href="classComSquare_1_1Memory_1_1IMemory.html">IMemory</a></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">protected</span>:</div>
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a61cac92b775cdfa5a0f534e67b83ddf4"> 17</a></span>&#160; uint8_t <a class="code" href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a61cac92b775cdfa5a0f534e67b83ddf4">_startBank</a> = 0;</div>
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a09ec93e172a976fb4b762f77dcb8b709"> 19</a></span>&#160; uint8_t <a class="code" href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a09ec93e172a976fb4b762f77dcb8b709">_endBank</a> = 0;</div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a8bba8f5e10bd9dfd122a84f6707a73f8"> 21</a></span>&#160; uint16_t <a class="code" href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a8bba8f5e10bd9dfd122a84f6707a73f8">_startPage</a> = 0;</div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classComSquare_1_1Memory_1_1ARectangleMemory.html#ac5e3772f4f9c40f65b3e165646876110"> 23</a></span>&#160; uint16_t <a class="code" href="classComSquare_1_1Memory_1_1ARectangleMemory.html#ac5e3772f4f9c40f65b3e165646876110">_endPage</a> = 0;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; [[nodiscard]] <a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> <a class="code" href="classComSquare_1_1Memory_1_1ARectangleMemory.html#ae3d2535084fcf3d923aea4d9b0d9626e">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="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; [[nodiscard]] <span class="keywordtype">bool</span> <a class="code" href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a182a3c6842814d052199adc24bc85ed3">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="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classComSquare_1_1Memory_1_1ARectangleMemory.html#aaf39bde614e7044e3de2ea4356abb63b">setMemoryRegion</a>(uint8_t startBank, uint8_t endBank, uint16_t startPage, uint16_t endPage);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; [[nodiscard]] std::string <a class="code" href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a7125cd1619a07e1030c88bb849d44425">getValueName</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="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <a class="code" href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a76baca93e0dbd0b43f4952295e300edc">~ARectangleMemory</a>() <span class="keyword">override</span> = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; };</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;}<span class="comment">// namespace ComSquare::Memory</span></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_1ARectangleMemory_html"><div class="ttname"><a href="classComSquare_1_1Memory_1_1ARectangleMemory.html">ComSquare::Memory::ARectangleMemory</a></div><div class="ttdoc">Base memory class to map non continuous rectangle to the memory. (A rectangle that spam across more t...</div><div class="ttdef"><b>Definition:</b> ARectangleMemory.hpp:13</div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1ARectangleMemory_html_a182a3c6842814d052199adc24bc85ed3"><div class="ttname"><a href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a182a3c6842814d052199adc24bc85ed3">ComSquare::Memory::ARectangleMemory::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> ARectangleMemory.cpp:26</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_1ARectangleMemory_html_aaf39bde614e7044e3de2ea4356abb63b"><div class="ttname"><a href="classComSquare_1_1Memory_1_1ARectangleMemory.html#aaf39bde614e7044e3de2ea4356abb63b">ComSquare::Memory::ARectangleMemory::setMemoryRegion</a></div><div class="ttdeci">void setMemoryRegion(uint8_t startBank, uint8_t endBank, uint16_t startPage, uint16_t endPage)</div><div class="ttdoc">Change starting and ending points of this mapped memory.</div><div class="ttdef"><b>Definition:</b> ARectangleMemory.cpp:37</div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1ARectangleMemory_html_a61cac92b775cdfa5a0f534e67b83ddf4"><div class="ttname"><a href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a61cac92b775cdfa5a0f534e67b83ddf4">ComSquare::Memory::ARectangleMemory::_startBank</a></div><div class="ttdeci">uint8_t _startBank</div><div class="ttdoc">The first bank to map to.</div><div class="ttdef"><b>Definition:</b> ARectangleMemory.hpp:17</div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1ARectangleMemory_html_a7125cd1619a07e1030c88bb849d44425"><div class="ttname"><a href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a7125cd1619a07e1030c88bb849d44425">ComSquare::Memory::ARectangleMemory::getValueName</a></div><div class="ttdeci">std::string getValueName(uint24_t addr) const override</div><div class="ttdoc">Get the name of the data at the address.</div><div class="ttdef"><b>Definition:</b> ARectangleMemory.cpp:45</div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1ARectangleMemory_html_a76baca93e0dbd0b43f4952295e300edc"><div class="ttname"><a href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a76baca93e0dbd0b43f4952295e300edc">ComSquare::Memory::ARectangleMemory::~ARectangleMemory</a></div><div class="ttdeci">~ARectangleMemory() override=default</div><div class="ttdoc">A default destructor.</div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1ARectangleMemory_html_a09ec93e172a976fb4b762f77dcb8b709"><div class="ttname"><a href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a09ec93e172a976fb4b762f77dcb8b709">ComSquare::Memory::ARectangleMemory::_endBank</a></div><div class="ttdeci">uint8_t _endBank</div><div class="ttdoc">The last bank to map to.</div><div class="ttdef"><b>Definition:</b> ARectangleMemory.hpp:19</div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1ARectangleMemory_html_a8bba8f5e10bd9dfd122a84f6707a73f8"><div class="ttname"><a href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a8bba8f5e10bd9dfd122a84f6707a73f8">ComSquare::Memory::ARectangleMemory::_startPage</a></div><div class="ttdeci">uint16_t _startPage</div><div class="ttdoc">The first address of each bank to map.</div><div class="ttdef"><b>Definition:</b> ARectangleMemory.hpp:21</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="aIMemory_8hpp_html"><div class="ttname"><a href="IMemory_8hpp.html">IMemory.hpp</a></div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1ARectangleMemory_html_ae3d2535084fcf3d923aea4d9b0d9626e"><div class="ttname"><a href="classComSquare_1_1Memory_1_1ARectangleMemory.html#ae3d2535084fcf3d923aea4d9b0d9626e">ComSquare::Memory::ARectangleMemory::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> ARectangleMemory.cpp:11</div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1ARectangleMemory_html_ac5e3772f4f9c40f65b3e165646876110"><div class="ttname"><a href="classComSquare_1_1Memory_1_1ARectangleMemory.html#ac5e3772f4f9c40f65b3e165646876110">ComSquare::Memory::ARectangleMemory::_endPage</a></div><div class="ttdeci">uint16_t _endPage</div><div class="ttdoc">The last address of each bank to map.</div><div class="ttdef"><b>Definition:</b> ARectangleMemory.hpp:23</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>