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

466 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::IMemory 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_1IMemory.html">IMemory</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classComSquare_1_1Memory_1_1IMemory-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ComSquare::Memory::IMemory Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Common interface implemented by all components mapping memory.
<a href="classComSquare_1_1Memory_1_1IMemory.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="IMemory_8hpp_source.html">IMemory.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ComSquare::Memory::IMemory:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classComSquare_1_1Memory_1_1IMemory__inherit__graph.svg" width="1464" height="1564"><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::IMemory:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classComSquare_1_1Memory_1_1IMemory__coll__graph.svg" width="186" height="220"><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:a8459ed12c4172ee29ecdc84330f99ff7"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a449bc89798a0b86028bb0413106514d9"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b7cf04f893b04b9b063759ad67d5bff"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1IMemory.html#a6b7cf04f893b04b9b063759ad67d5bff">hasMemoryAt</a> (<a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr) const =0</td></tr>
<tr class="memdesc:a6b7cf04f893b04b9b063759ad67d5bff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return true if this component has mapped the address. <a href="classComSquare_1_1Memory_1_1IMemory.html#a6b7cf04f893b04b9b063759ad67d5bff">More...</a><br /></td></tr>
<tr class="separator:a6b7cf04f893b04b9b063759ad67d5bff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44a24003df048c5e832ba23722ef026d"><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#a44a24003df048c5e832ba23722ef026d">getRelativeAddress</a> (<a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr) const =0</td></tr>
<tr class="memdesc:a44a24003df048c5e832ba23722ef026d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Translate an absolute address to a relative address. <a href="classComSquare_1_1Memory_1_1IMemory.html#a44a24003df048c5e832ba23722ef026d">More...</a><br /></td></tr>
<tr class="separator:a44a24003df048c5e832ba23722ef026d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1072ab44e7389913ff67cb77ff118c8b"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34d654c04a8a992b439c4270d566263f"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31289443bb26086fb74c724cdafd2241"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f02b894a85d7b1a0b8bae677039d821"><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#a1f02b894a85d7b1a0b8bae677039d821">getValueName</a> (<a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr) const =0</td></tr>
<tr class="memdesc:a1f02b894a85d7b1a0b8bae677039d821"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the name of the data at the address. <a href="classComSquare_1_1Memory_1_1IMemory.html#a1f02b894a85d7b1a0b8bae677039d821">More...</a><br /></td></tr>
<tr class="separator:a1f02b894a85d7b1a0b8bae677039d821"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a0679f3cf924e3562d6f89a80aae069"><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"><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"><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>Common interface implemented by all components mapping memory. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a0a0679f3cf924e3562d6f89a80aae069"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a0679f3cf924e3562d6f89a80aae069">&#9670;&nbsp;</a></span>~IMemory()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ComSquare::Memory::IMemory::~IMemory </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A virtual default destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a31289443bb26086fb74c724cdafd2241"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31289443bb26086fb74c724cdafd2241">&#9670;&nbsp;</a></span>getComponent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespaceComSquare.html#a891b49feb5c3e0aaa4873ff19b49968c">Component</a> ComSquare::Memory::IMemory::getComponent </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the component of this accessor (used for debug purpose) </p>
<p>Implemented in <a class="el" href="classComSquare_1_1CPU_1_1CPU.html#acc8a35786bc453f56d913b4a9a9c2946">ComSquare::CPU::CPU</a>, <a class="el" href="classComSquare_1_1APU_1_1APU.html#a8b78bdff28ca5bfaa0743f170014511b">ComSquare::APU::APU</a>, <a class="el" href="classComSquare_1_1PPU_1_1PPU.html#aa2cf0928eaa6dab3bb1b933f35c273ef">ComSquare::PPU::PPU</a>, <a class="el" href="classComSquare_1_1APU_1_1IPL_1_1IPL.html#a6764873766efe6e9a9cd38558aba28c7">ComSquare::APU::IPL::IPL</a>, <a class="el" href="classComSquare_1_1Memory_1_1RectangleShadow.html#a6f15e3bb70408dd939a7178b243c60f6">ComSquare::Memory::RectangleShadow</a>, <a class="el" href="classComSquare_1_1Ram_1_1Ram.html#a80af60fecd948b647d590435028ecf1f">ComSquare::Ram::Ram</a>, and <a class="el" href="classComSquare_1_1Memory_1_1MemoryShadow.html#a44297bdec2e515e550b6fcd99f635aa1">ComSquare::Memory::MemoryShadow</a>.</p>
</div>
</div>
<a id="a34d654c04a8a992b439c4270d566263f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34d654c04a8a992b439c4270d566263f">&#9670;&nbsp;</a></span>getName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string ComSquare::Memory::IMemory::getName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the name of this accessor (used for debug purpose) </p>
<p>Implemented in <a class="el" href="classComSquare_1_1CPU_1_1CPU.html#a2de75cee00237888b5998677df33205a">ComSquare::CPU::CPU</a>, <a class="el" href="classComSquare_1_1APU_1_1APU.html#adebd1f46d0737254a943fd97a3192d2d">ComSquare::APU::APU</a>, <a class="el" href="classComSquare_1_1PPU_1_1PPU.html#a19a8610b12f36db9d236108c5de7b42b">ComSquare::PPU::PPU</a>, <a class="el" href="classComSquare_1_1APU_1_1IPL_1_1IPL.html#aae5515da2fdc63abae1fe59e60703a9d">ComSquare::APU::IPL::IPL</a>, <a class="el" href="classComSquare_1_1Memory_1_1RectangleShadow.html#a1a940ad2e7ed79dc2af3b4682caab527">ComSquare::Memory::RectangleShadow</a>, <a class="el" href="classComSquare_1_1Ram_1_1Ram.html#a71d2424b05cf638d04402db2260c71aa">ComSquare::Ram::Ram</a>, and <a class="el" href="classComSquare_1_1Memory_1_1MemoryShadow.html#a6c5a02f97b97a258d60d8011b805cb6e">ComSquare::Memory::MemoryShadow</a>.</p>
</div>
</div>
<a id="a44a24003df048c5e832ba23722ef026d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44a24003df048c5e832ba23722ef026d">&#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">virtual <a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> ComSquare::Memory::IMemory::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">pure 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>Implemented in <a class="el" href="classComSquare_1_1Memory_1_1RectangleShadow.html#a8e9ecd31b62134e08a811a8583a0af3c">ComSquare::Memory::RectangleShadow</a>, <a class="el" href="classComSquare_1_1Memory_1_1ARectangleMemory.html#ae3d2535084fcf3d923aea4d9b0d9626e">ComSquare::Memory::ARectangleMemory</a>, and <a class="el" href="classComSquare_1_1Memory_1_1AMemory.html#aff943c07bcf7f7ccb88c82fe47127928">ComSquare::Memory::AMemory</a>.</p>
</div>
</div>
<a id="a1072ab44e7389913ff67cb77ff118c8b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1072ab44e7389913ff67cb77ff118c8b">&#9670;&nbsp;</a></span>getSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> ComSquare::Memory::IMemory::getSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the size of the data. This size can be lower than the mapped data. </p>
<dl class="section return"><dt>Returns</dt><dd>The number of bytes inside this memory. </dd></dl>
<p>Implemented in <a class="el" href="classComSquare_1_1CPU_1_1CPU.html#aafdb38e48a7f5ea9d91a2c77a9172157">ComSquare::CPU::CPU</a>, <a class="el" href="classComSquare_1_1APU_1_1APU.html#afe51d33787c89667f29e250447e9dd03">ComSquare::APU::APU</a>, <a class="el" href="classComSquare_1_1Cartridge_1_1Cartridge.html#ad033c3f0cb15f5b6124dcb8ba18e95b0">ComSquare::Cartridge::Cartridge</a>, <a class="el" href="classComSquare_1_1PPU_1_1PPU.html#a896e5d0f9c12c8edae06a53507ffec3c">ComSquare::PPU::PPU</a>, <a class="el" href="classComSquare_1_1APU_1_1IPL_1_1IPL.html#ab0614592ba5b08b1e1447745d030e146">ComSquare::APU::IPL::IPL</a>, <a class="el" href="classComSquare_1_1Ram_1_1Ram.html#a003803dabc201990c870f5405c7e6de1">ComSquare::Ram::Ram</a>, <a class="el" href="classComSquare_1_1Memory_1_1RectangleShadow.html#aa009d6ceb2d3ef951fecf54b1e25811e">ComSquare::Memory::RectangleShadow</a>, and <a class="el" href="classComSquare_1_1Memory_1_1MemoryShadow.html#ac18f444c8b40e9ef8a077a93c0e7024e">ComSquare::Memory::MemoryShadow</a>.</p>
</div>
</div>
<a id="a1f02b894a85d7b1a0b8bae677039d821"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f02b894a85d7b1a0b8bae677039d821">&#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">virtual std::string ComSquare::Memory::IMemory::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">pure 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>Implemented in <a class="el" href="classComSquare_1_1CPU_1_1CPU.html#ad3032863a475f3bc1a49bfb9c429941c">ComSquare::CPU::CPU</a>, <a class="el" href="classComSquare_1_1APU_1_1APU.html#ad403c0a40bcd5a58ff6a485e9b3873a1">ComSquare::APU::APU</a>, <a class="el" href="classComSquare_1_1PPU_1_1PPU.html#ad216351b7b356ed3ae700aec322c59a2">ComSquare::PPU::PPU</a>, <a class="el" href="classComSquare_1_1APU_1_1IPL_1_1IPL.html#aa359ca3e84f72be052ea75d16c7ecf2f">ComSquare::APU::IPL::IPL</a>, <a class="el" href="classComSquare_1_1Memory_1_1MemoryShadow.html#a3181d146bea3924d4c24974cf7338c97">ComSquare::Memory::MemoryShadow</a>, and <a class="el" href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a7125cd1619a07e1030c88bb849d44425">ComSquare::Memory::ARectangleMemory</a>.</p>
</div>
</div>
<a id="a6b7cf04f893b04b9b063759ad67d5bff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b7cf04f893b04b9b063759ad67d5bff">&#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">virtual bool ComSquare::Memory::IMemory::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">pure 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>Implemented in <a class="el" href="classComSquare_1_1Memory_1_1AMemory.html#aadca52185b1b3db17d6881e91d81516f">ComSquare::Memory::AMemory</a>, and <a class="el" href="classComSquare_1_1Memory_1_1ARectangleMemory.html#a182a3c6842814d052199adc24bc85ed3">ComSquare::Memory::ARectangleMemory</a>.</p>
</div>
</div>
<a id="a8459ed12c4172ee29ecdc84330f99ff7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8459ed12c4172ee29ecdc84330f99ff7">&#9670;&nbsp;</a></span>read()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint8_t ComSquare::Memory::IMemory::read </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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Read data from the component. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">addr</td><td>The local address to read from (0x0 should refer to the first byte of this component). </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">This</td><td>function should thrown an <a class="el" href="classComSquare_1_1InvalidAddress.html" title="Exception thrown when trying to read/write to an invalid address.">InvalidAddress</a> for address that are not mapped to the component. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Return the data at the address given as parameter. </dd></dl>
<p>Implemented in <a class="el" href="classComSquare_1_1CPU_1_1CPU.html#a2f5e100896256e62f1995a0172f3a5e5">ComSquare::CPU::CPU</a>, <a class="el" href="classComSquare_1_1APU_1_1APU.html#acf11685da76ce208cf57a4209cdbd0c2">ComSquare::APU::APU</a>, <a class="el" href="classComSquare_1_1Cartridge_1_1Cartridge.html#a765f900de75ab1af9595221e754d93c7">ComSquare::Cartridge::Cartridge</a>, <a class="el" href="classComSquare_1_1PPU_1_1PPU.html#afb3e0bd3fdeddb091813ef3c36b20607">ComSquare::PPU::PPU</a>, <a class="el" href="classComSquare_1_1APU_1_1IPL_1_1IPL.html#a555cbf72be48bdea082e98cb12b1c79b">ComSquare::APU::IPL::IPL</a>, <a class="el" href="classComSquare_1_1Memory_1_1RectangleShadow.html#ac4edb47abc275812298f1314ed0cd959">ComSquare::Memory::RectangleShadow</a>, <a class="el" href="classComSquare_1_1Ram_1_1Ram.html#a873f2becaa9b63d8864bb43eaae89fc6">ComSquare::Ram::Ram</a>, and <a class="el" href="classComSquare_1_1Memory_1_1MemoryShadow.html#abc27d0d65cf3f5b4b258a5aa8e1250ff">ComSquare::Memory::MemoryShadow</a>.</p>
</div>
</div>
<a id="a449bc89798a0b86028bb0413106514d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a449bc89798a0b86028bb0413106514d9">&#9670;&nbsp;</a></span>write()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ComSquare::Memory::IMemory::write </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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>data</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Write data to this component. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">addr</td><td>The local address to write data (0x0 should refer to the first byte of this component). </td></tr>
<tr><td class="paramname">data</td><td>The new data to write. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">This</td><td>function should thrown an <a class="el" href="classComSquare_1_1InvalidAddress.html" title="Exception thrown when trying to read/write to an invalid address.">InvalidAddress</a> for address that are not mapped to the component. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classComSquare_1_1CPU_1_1CPU.html#a98d7a910393934e63f4ea479cea49f2e">ComSquare::CPU::CPU</a>, <a class="el" href="classComSquare_1_1APU_1_1APU.html#ab77224524520cbad442e89f3663cf67f">ComSquare::APU::APU</a>, <a class="el" href="classComSquare_1_1Cartridge_1_1Cartridge.html#aa30c32b23035b94f67063e06ab5759bc">ComSquare::Cartridge::Cartridge</a>, <a class="el" href="classComSquare_1_1PPU_1_1PPU.html#aaf2261c0ef235d3181b038355b97cbe3">ComSquare::PPU::PPU</a>, <a class="el" href="classComSquare_1_1APU_1_1IPL_1_1IPL.html#a55b7a5d487ce206ee3a42255c67a3258">ComSquare::APU::IPL::IPL</a>, <a class="el" href="classComSquare_1_1Memory_1_1RectangleShadow.html#abd2c3a785eb5c43249965650d8b53574">ComSquare::Memory::RectangleShadow</a>, <a class="el" href="classComSquare_1_1Ram_1_1Ram.html#a0f42b342ebf151574c1e523719f9cf52">ComSquare::Ram::Ram</a>, and <a class="el" href="classComSquare_1_1Memory_1_1MemoryShadow.html#a885d4559319980e9e5b706f7fe4c3f49">ComSquare::Memory::MemoryShadow</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>sources/Memory/<a class="el" href="IMemory_8hpp_source.html">IMemory.hpp</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