zoriya/ComSquare
1
0
Fork 0
mirror of https://github.com/zoriya/ComSquare.git synced 2026-05-14 19:49:30 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
Documentation
ComSquare/classComSquare_1_1Memory_1_1ARectangleMemory.html
AnonymusRaccoon d33b0ab52d Deploying the doc
2021-07-13 21:32:24 +00:00

457 lines
28 KiB
HTML
Raw Permalink Blame History

<!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: ComSquare::Memory::ARectangleMemory 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="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="namespaceComSquare.html">ComSquare</a></li><li class="navelem"><a class="el" href="namespaceComSquare_1_1Memory.html">Memory</a></li><li class="navelem"><a class="el" href="classComSquare_1_1Memory_1_1ARectangleMemory.html">ARectangleMemory</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classComSquare_1_1Memory_1_1ARectangleMemory-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ComSquare::Memory::ARectangleMemory Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Base memory class to map non continuous rectangle to the memory. (A rectangle that spam across more than one bank but that does not start at $0000 or end at $FFFF).
<a href="classComSquare_1_1Memory_1_1ARectangleMemory.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ARectangleMemory_8hpp_source.html">ARectangleMemory.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ComSquare::Memory::ARectangleMemory:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classComSquare_1_1Memory_1_1ARectangleMemory__inherit__graph.svg" width="384" height="1227"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
<div class="dynheader">
Collaboration diagram for ComSquare::Memory::ARectangleMemory:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classComSquare_1_1Memory_1_1ARectangleMemory__coll__graph.svg" width="198" height="463"><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 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae3d2535084fcf3d923aea4d9b0d9626e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1ARectangleMemory.html#ae3d2535084fcf3d923aea4d9b0d9626e">getRelativeAddress</a> (<a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr) const override</td></tr>
<tr class="memdesc:ae3d2535084fcf3d923aea4d9b0d9626e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Translate an absolute address to a relative address. <a href="classComSquare_1_1Memory_1_1ARectangleMemory.html#ae3d2535084fcf3d923aea4d9b0d9626e">More...</a><br /></td></tr>
<tr class="separator:ae3d2535084fcf3d923aea4d9b0d9626e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a182a3c6842814d052199adc24bc85ed3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a182a3c6842814d052199adc24bc85ed3">hasMemoryAt</a> (<a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr) const override</td></tr>
<tr class="memdesc:a182a3c6842814d052199adc24bc85ed3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return true if this component has mapped the address. <a href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a182a3c6842814d052199adc24bc85ed3">More...</a><br /></td></tr>
<tr class="separator:a182a3c6842814d052199adc24bc85ed3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf39bde614e7044e3de2ea4356abb63b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1ARectangleMemory.html#aaf39bde614e7044e3de2ea4356abb63b">setMemoryRegion</a> (uint8_t startBank, uint8_t endBank, uint16_t startPage, uint16_t endPage)</td></tr>
<tr class="memdesc:aaf39bde614e7044e3de2ea4356abb63b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Change starting and ending points of this mapped memory. <a href="classComSquare_1_1Memory_1_1ARectangleMemory.html#aaf39bde614e7044e3de2ea4356abb63b">More...</a><br /></td></tr>
<tr class="separator:aaf39bde614e7044e3de2ea4356abb63b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7125cd1619a07e1030c88bb849d44425"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a7125cd1619a07e1030c88bb849d44425">getValueName</a> (<a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr) const override</td></tr>
<tr class="memdesc:a7125cd1619a07e1030c88bb849d44425"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the name of the data at the address. <a href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a7125cd1619a07e1030c88bb849d44425">More...</a><br /></td></tr>
<tr class="separator:a7125cd1619a07e1030c88bb849d44425"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a76baca93e0dbd0b43f4952295e300edc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a76baca93e0dbd0b43f4952295e300edc">~ARectangleMemory</a> () override=default</td></tr>
<tr class="memdesc:a76baca93e0dbd0b43f4952295e300edc"><td class="mdescLeft">&#160;</td><td class="mdescRight">A default destructor. <a href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a76baca93e0dbd0b43f4952295e300edc">More...</a><br /></td></tr>
<tr class="separator:a76baca93e0dbd0b43f4952295e300edc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classComSquare_1_1Memory_1_1IMemory"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classComSquare_1_1Memory_1_1IMemory')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classComSquare_1_1Memory_1_1IMemory.html">ComSquare::Memory::IMemory</a></td></tr>
<tr class="memitem:a8459ed12c4172ee29ecdc84330f99ff7 inherit pub_methods_classComSquare_1_1Memory_1_1IMemory"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1IMemory.html#a8459ed12c4172ee29ecdc84330f99ff7">read</a> (<a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr)=0</td></tr>
<tr class="memdesc:a8459ed12c4172ee29ecdc84330f99ff7 inherit pub_methods_classComSquare_1_1Memory_1_1IMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read data from the component. <a href="classComSquare_1_1Memory_1_1IMemory.html#a8459ed12c4172ee29ecdc84330f99ff7">More...</a><br /></td></tr>
<tr class="separator:a8459ed12c4172ee29ecdc84330f99ff7 inherit pub_methods_classComSquare_1_1Memory_1_1IMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a449bc89798a0b86028bb0413106514d9 inherit pub_methods_classComSquare_1_1Memory_1_1IMemory"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1IMemory.html#a449bc89798a0b86028bb0413106514d9">write</a> (<a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr, uint8_t data)=0</td></tr>
<tr class="memdesc:a449bc89798a0b86028bb0413106514d9 inherit pub_methods_classComSquare_1_1Memory_1_1IMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write data to this component. <a href="classComSquare_1_1Memory_1_1IMemory.html#a449bc89798a0b86028bb0413106514d9">More...</a><br /></td></tr>
<tr class="separator:a449bc89798a0b86028bb0413106514d9 inherit pub_methods_classComSquare_1_1Memory_1_1IMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1072ab44e7389913ff67cb77ff118c8b inherit pub_methods_classComSquare_1_1Memory_1_1IMemory"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1IMemory.html#a1072ab44e7389913ff67cb77ff118c8b">getSize</a> () const =0</td></tr>
<tr class="memdesc:a1072ab44e7389913ff67cb77ff118c8b inherit pub_methods_classComSquare_1_1Memory_1_1IMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the size of the data. This size can be lower than the mapped data. <a href="classComSquare_1_1Memory_1_1IMemory.html#a1072ab44e7389913ff67cb77ff118c8b">More...</a><br /></td></tr>
<tr class="separator:a1072ab44e7389913ff67cb77ff118c8b inherit pub_methods_classComSquare_1_1Memory_1_1IMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34d654c04a8a992b439c4270d566263f inherit pub_methods_classComSquare_1_1Memory_1_1IMemory"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1IMemory.html#a34d654c04a8a992b439c4270d566263f">getName</a> () const =0</td></tr>
<tr class="memdesc:a34d654c04a8a992b439c4270d566263f inherit pub_methods_classComSquare_1_1Memory_1_1IMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the name of this accessor (used for debug purpose) <a href="classComSquare_1_1Memory_1_1IMemory.html#a34d654c04a8a992b439c4270d566263f">More...</a><br /></td></tr>
<tr class="separator:a34d654c04a8a992b439c4270d566263f inherit pub_methods_classComSquare_1_1Memory_1_1IMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31289443bb26086fb74c724cdafd2241 inherit pub_methods_classComSquare_1_1Memory_1_1IMemory"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceComSquare.html#a891b49feb5c3e0aaa4873ff19b49968c">Component</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1IMemory.html#a31289443bb26086fb74c724cdafd2241">getComponent</a> () const =0</td></tr>
<tr class="memdesc:a31289443bb26086fb74c724cdafd2241 inherit pub_methods_classComSquare_1_1Memory_1_1IMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the component of this accessor (used for debug purpose) <a href="classComSquare_1_1Memory_1_1IMemory.html#a31289443bb26086fb74c724cdafd2241">More...</a><br /></td></tr>
<tr class="separator:a31289443bb26086fb74c724cdafd2241 inherit pub_methods_classComSquare_1_1Memory_1_1IMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a0679f3cf924e3562d6f89a80aae069 inherit pub_methods_classComSquare_1_1Memory_1_1IMemory"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1IMemory.html#a0a0679f3cf924e3562d6f89a80aae069">~IMemory</a> ()=default</td></tr>
<tr class="memdesc:a0a0679f3cf924e3562d6f89a80aae069 inherit pub_methods_classComSquare_1_1Memory_1_1IMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">A virtual default destructor. <a href="classComSquare_1_1Memory_1_1IMemory.html#a0a0679f3cf924e3562d6f89a80aae069">More...</a><br /></td></tr>
<tr class="separator:a0a0679f3cf924e3562d6f89a80aae069 inherit pub_methods_classComSquare_1_1Memory_1_1IMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a61cac92b775cdfa5a0f534e67b83ddf4"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a61cac92b775cdfa5a0f534e67b83ddf4">_startBank</a> = 0</td></tr>
<tr class="memdesc:a61cac92b775cdfa5a0f534e67b83ddf4"><td class="mdescLeft">&#160;</td><td class="mdescRight">The first bank to map to. <a href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a61cac92b775cdfa5a0f534e67b83ddf4">More...</a><br /></td></tr>
<tr class="separator:a61cac92b775cdfa5a0f534e67b83ddf4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09ec93e172a976fb4b762f77dcb8b709"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a09ec93e172a976fb4b762f77dcb8b709">_endBank</a> = 0</td></tr>
<tr class="memdesc:a09ec93e172a976fb4b762f77dcb8b709"><td class="mdescLeft">&#160;</td><td class="mdescRight">The last bank to map to. <a href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a09ec93e172a976fb4b762f77dcb8b709">More...</a><br /></td></tr>
<tr class="separator:a09ec93e172a976fb4b762f77dcb8b709"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8bba8f5e10bd9dfd122a84f6707a73f8"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a8bba8f5e10bd9dfd122a84f6707a73f8">_startPage</a> = 0</td></tr>
<tr class="memdesc:a8bba8f5e10bd9dfd122a84f6707a73f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">The first address of each bank to map. <a href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a8bba8f5e10bd9dfd122a84f6707a73f8">More...</a><br /></td></tr>
<tr class="separator:a8bba8f5e10bd9dfd122a84f6707a73f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5e3772f4f9c40f65b3e165646876110"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1ARectangleMemory.html#ac5e3772f4f9c40f65b3e165646876110">_endPage</a> = 0</td></tr>
<tr class="memdesc:ac5e3772f4f9c40f65b3e165646876110"><td class="mdescLeft">&#160;</td><td class="mdescRight">The last address of each bank to map. <a href="classComSquare_1_1Memory_1_1ARectangleMemory.html#ac5e3772f4f9c40f65b3e165646876110">More...</a><br /></td></tr>
<tr class="separator:ac5e3772f4f9c40f65b3e165646876110"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base memory class to map non continuous rectangle to the memory. (A rectangle that spam across more than one bank but that does not start at $0000 or end at $FFFF). </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a76baca93e0dbd0b43f4952295e300edc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a76baca93e0dbd0b43f4952295e300edc">&#9670;&nbsp;</a></span>~ARectangleMemory()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ComSquare::Memory::ARectangleMemory::~ARectangleMemory </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A default destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ae3d2535084fcf3d923aea4d9b0d9626e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3d2535084fcf3d923aea4d9b0d9626e">&#9670;&nbsp;</a></span>getRelativeAddress()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> ComSquare::Memory::ARectangleMemory::getRelativeAddress </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a>&#160;</td>
<td class="paramname"><em>addr</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Translate an absolute address to a relative address. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">addr</td><td>The absolute address (in the 24 bit bus) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The local address (0 refers to the first byte of this component). </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classComSquare_1_1InvalidAddress.html" title="Exception thrown when trying to read/write to an invalid address.">InvalidAddress</a></td><td>is thrown if the address is not mapped by this component. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classComSquare_1_1Memory_1_1IMemory.html#a44a24003df048c5e832ba23722ef026d">ComSquare::Memory::IMemory</a>.</p>
<p>Reimplemented in <a class="el" href="classComSquare_1_1Memory_1_1RectangleShadow.html#a8e9ecd31b62134e08a811a8583a0af3c">ComSquare::Memory::RectangleShadow</a>.</p>
</div>
</div>
<a id="a7125cd1619a07e1030c88bb849d44425"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7125cd1619a07e1030c88bb849d44425">&#9670;&nbsp;</a></span>getValueName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string ComSquare::Memory::ARectangleMemory::getValueName </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a>&#160;</td>
<td class="paramname"><em>addr</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the name of the data at the address. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">addr</td><td>The address (in local space) </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classComSquare_1_1Memory_1_1IMemory.html#a1f02b894a85d7b1a0b8bae677039d821">ComSquare::Memory::IMemory</a>.</p>
</div>
</div>
<a id="a182a3c6842814d052199adc24bc85ed3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a182a3c6842814d052199adc24bc85ed3">&#9670;&nbsp;</a></span>hasMemoryAt()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ComSquare::Memory::ARectangleMemory::hasMemoryAt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a>&#160;</td>
<td class="paramname"><em>addr</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return true if this component has mapped the address. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">addr</td><td>The address to check. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if this address is mapped to the component. False otherwise. </dd></dl>
<p>Implements <a class="el" href="classComSquare_1_1Memory_1_1IMemory.html#a6b7cf04f893b04b9b063759ad67d5bff">ComSquare::Memory::IMemory</a>.</p>
</div>
</div>
<a id="aaf39bde614e7044e3de2ea4356abb63b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf39bde614e7044e3de2ea4356abb63b">&#9670;&nbsp;</a></span>setMemoryRegion()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ComSquare::Memory::ARectangleMemory::setMemoryRegion </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>startBank</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>endBank</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>startPage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>endPage</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Change starting and ending points of this mapped memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">startBank</td><td>The first bank mapped to this component. </td></tr>
<tr><td class="paramname">endBank</td><td>The last bank mapped to this component. </td></tr>
<tr><td class="paramname">startPage</td><td>The first page mapped to this component (every mapped banks will have this page mapped) </td></tr>
<tr><td class="paramname">endPage</td><td>The end page mapped to this component (every mapped banks will have this pages lower than this mapped) </td></tr>
</table>
</dd>
</dl>
<dl class="section warning"><dt>Warning</dt><dd>The start/end address should be a rectangle. To mirror memory, use the <a class="el" href="classComSquare_1_1Memory_1_1MemoryShadow.html">MemoryShadow</a> class and not this one. </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a09ec93e172a976fb4b762f77dcb8b709"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09ec93e172a976fb4b762f77dcb8b709">&#9670;&nbsp;</a></span>_endBank</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t ComSquare::Memory::ARectangleMemory::_endBank = 0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The last bank to map to. </p>
</div>
</div>
<a id="ac5e3772f4f9c40f65b3e165646876110"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac5e3772f4f9c40f65b3e165646876110">&#9670;&nbsp;</a></span>_endPage</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint16_t ComSquare::Memory::ARectangleMemory::_endPage = 0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The last address of each bank to map. </p>
</div>
</div>
<a id="a61cac92b775cdfa5a0f534e67b83ddf4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61cac92b775cdfa5a0f534e67b83ddf4">&#9670;&nbsp;</a></span>_startBank</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t ComSquare::Memory::ARectangleMemory::_startBank = 0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The first bank to map to. </p>
</div>
</div>
<a id="a8bba8f5e10bd9dfd122a84f6707a73f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8bba8f5e10bd9dfd122a84f6707a73f8">&#9670;&nbsp;</a></span>_startPage</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint16_t ComSquare::Memory::ARectangleMemory::_startPage = 0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The first address of each bank to map. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>sources/Memory/<a class="el" href="ARectangleMemory_8hpp_source.html">ARectangleMemory.hpp</a></li>
<li>sources/Memory/<a class="el" href="ARectangleMemory_8cpp.html">ARectangleMemory.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- 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>
Reference in New Issue View Git Blame Copy Permalink