mirror of
https://github.com/zoriya/ComSquare.git
synced 2026-05-24 07:11:19 +00:00
AnonymusRaccoon
296 lines
20 KiB
TeX
296 lines
20 KiB
TeX
\hypertarget{classComSquare_1_1Memory_1_1RectangleShadow}{}\doxysection{Com\+Square\+::Memory\+::Rectangle\+Shadow Class Reference}
|
|
\label{classComSquare_1_1Memory_1_1RectangleShadow}\index{ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}}
|
|
|
|
|
|
{\ttfamily \#include $<$Rectangle\+Shadow.\+hpp$>$}
|
|
|
|
|
|
|
|
Inheritance diagram for Com\+Square\+::Memory\+::Rectangle\+Shadow\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[height=550pt]{classComSquare_1_1Memory_1_1RectangleShadow__inherit__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
|
|
|
|
Collaboration diagram for Com\+Square\+::Memory\+::Rectangle\+Shadow\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[height=550pt]{classComSquare_1_1Memory_1_1RectangleShadow__coll__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{classComSquare_1_1Memory_1_1RectangleShadow_aee4593f936633db7ab0045b8838312ad}{Rectangle\+Shadow}} (\mbox{\hyperlink{classComSquare_1_1Memory_1_1IMemory}{I\+Memory}} \&initial, uint8\+\_\+t start\+Bank, uint8\+\_\+t end\+Bank, uint16\+\_\+t start\+Page, uint16\+\_\+t end\+Page)
|
|
\begin{DoxyCompactList}\small\item\em Create a shadow for the memory given as parameter. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classComSquare_1_1Memory_1_1RectangleShadow_a2b06531cad0f436fe80817d726f66c38}{Rectangle\+Shadow}} (const \mbox{\hyperlink{classComSquare_1_1Memory_1_1RectangleShadow}{Rectangle\+Shadow}} \&)=default
|
|
\begin{DoxyCompactList}\small\item\em A rectangle shadow is copy constructable. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classComSquare_1_1Memory_1_1RectangleShadow}{Rectangle\+Shadow}} \& \mbox{\hyperlink{classComSquare_1_1Memory_1_1RectangleShadow_a5ddf968ddbfb1767d78ffe6ad6a6ee12}{operator=}} (const \mbox{\hyperlink{classComSquare_1_1Memory_1_1RectangleShadow}{Rectangle\+Shadow}} \&)=delete
|
|
\begin{DoxyCompactList}\small\item\em @brrief A rectangle shadow is not assignable \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classComSquare_1_1Memory_1_1RectangleShadow_abc88d4a0ec2b74cff09efb6080728d26}{$\sim$\+Rectangle\+Shadow}} () override=default
|
|
\begin{DoxyCompactList}\small\item\em A default destructor. \end{DoxyCompactList}\item
|
|
uint8\+\_\+t \mbox{\hyperlink{classComSquare_1_1Memory_1_1RectangleShadow_ac4edb47abc275812298f1314ed0cd959}{read}} (\mbox{\hyperlink{Ints_8hpp_a89f009aaf5d1964a000f44f09fa0bcf8}{uint24\+\_\+t}} addr) override
|
|
\begin{DoxyCompactList}\small\item\em Read from the initial \mbox{\hyperlink{classComSquare_1_1Memory_1_1AMemory}{A\+Memory}} given. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classComSquare_1_1Memory_1_1RectangleShadow_abd2c3a785eb5c43249965650d8b53574}{write}} (\mbox{\hyperlink{Ints_8hpp_a89f009aaf5d1964a000f44f09fa0bcf8}{uint24\+\_\+t}} addr, uint8\+\_\+t data) override
|
|
\begin{DoxyCompactList}\small\item\em Write data to the ram. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{Ints_8hpp_a89f009aaf5d1964a000f44f09fa0bcf8}{uint24\+\_\+t}} \mbox{\hyperlink{classComSquare_1_1Memory_1_1RectangleShadow_a8e9ecd31b62134e08a811a8583a0af3c}{get\+Relative\+Address}} (\mbox{\hyperlink{Ints_8hpp_a89f009aaf5d1964a000f44f09fa0bcf8}{uint24\+\_\+t}} addr) const override
|
|
\begin{DoxyCompactList}\small\item\em Translate an absolute address to a relative address. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{Ints_8hpp_a89f009aaf5d1964a000f44f09fa0bcf8}{uint24\+\_\+t}} \mbox{\hyperlink{classComSquare_1_1Memory_1_1RectangleShadow_aa009d6ceb2d3ef951fecf54b1e25811e}{get\+Size}} () const override
|
|
\begin{DoxyCompactList}\small\item\em Get the size of the data. This size can be lower than the mapped data. \end{DoxyCompactList}\item
|
|
std\+::string \mbox{\hyperlink{classComSquare_1_1Memory_1_1RectangleShadow_a1a940ad2e7ed79dc2af3b4682caab527}{get\+Name}} () const override
|
|
\begin{DoxyCompactList}\small\item\em Get the name of this accessor (used for debug purpose) \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{namespaceComSquare_a891b49feb5c3e0aaa4873ff19b49968c}{Component}} \mbox{\hyperlink{classComSquare_1_1Memory_1_1RectangleShadow_a6f15e3bb70408dd939a7178b243c60f6}{get\+Component}} () const override
|
|
\begin{DoxyCompactList}\small\item\em Get the component of this accessor (used for debug purpose) \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classComSquare_1_1Memory_1_1IMemory}{I\+Memory}} \& \mbox{\hyperlink{classComSquare_1_1Memory_1_1RectangleShadow_a9552aedaed64347f56201f743a9cb42d}{get\+Mirrored}} () const
|
|
\begin{DoxyCompactList}\small\item\em Return the memory accessor this accessor mirror if any. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classComSquare_1_1Memory_1_1RectangleShadow_aed4a58c4ef9a27a40a1f17838db745f9}{set\+Bank\+Offset}} (int bank\+Offset)
|
|
\begin{DoxyCompactList}\small\item\em Set the number of bank this component do not shadow. Referring to the first byte of this component will refer to the first byte of the bank at (bank\+Offset + start of initial memory). \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsection*{Private Attributes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{classComSquare_1_1Memory_1_1IMemory}{I\+Memory}} \& \mbox{\hyperlink{classComSquare_1_1Memory_1_1RectangleShadow_af2fa7c3726a966734401c9d74efb9857}{\+\_\+initial}}
|
|
\begin{DoxyCompactList}\small\item\em \mbox{\hyperlink{namespaceComSquare_1_1Memory}{Memory}} to shadow from. \end{DoxyCompactList}\item
|
|
int \mbox{\hyperlink{classComSquare_1_1Memory_1_1RectangleShadow_a281490c83f087fed5b4ab9abbaa80e32}{\+\_\+bank\+Offset}} = 0
|
|
\begin{DoxyCompactList}\small\item\em The number of banks to add to the memory before accessing it from the initial data. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsection*{Additional Inherited Members}
|
|
|
|
|
|
\doxysubsection{Constructor \& Destructor Documentation}
|
|
\mbox{\Hypertarget{classComSquare_1_1Memory_1_1RectangleShadow_aee4593f936633db7ab0045b8838312ad}\label{classComSquare_1_1Memory_1_1RectangleShadow_aee4593f936633db7ab0045b8838312ad}}
|
|
\index{ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}!RectangleShadow@{RectangleShadow}}
|
|
\index{RectangleShadow@{RectangleShadow}!ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}}
|
|
\doxysubsubsection{\texorpdfstring{RectangleShadow()}{RectangleShadow()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
|
{\footnotesize\ttfamily Com\+Square\+::\+Memory\+::\+Rectangle\+Shadow\+::\+Rectangle\+Shadow (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classComSquare_1_1Memory_1_1IMemory}{I\+Memory}} \&}]{initial, }\item[{uint8\+\_\+t}]{start\+Bank, }\item[{uint8\+\_\+t}]{end\+Bank, }\item[{uint16\+\_\+t}]{start\+Page, }\item[{uint16\+\_\+t}]{end\+Page }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Create a shadow for the memory given as parameter.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em start\+Bank} & The starting bank of the memory to shadow. \\
|
|
\hline
|
|
{\em end\+Bank} & The ending bank of the memory to shadow \\
|
|
\hline
|
|
{\em start\+Page} & The starting page of the memory to shadow \\
|
|
\hline
|
|
{\em end\+Page} & The ending page of the memory to shadow \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\mbox{\Hypertarget{classComSquare_1_1Memory_1_1RectangleShadow_a2b06531cad0f436fe80817d726f66c38}\label{classComSquare_1_1Memory_1_1RectangleShadow_a2b06531cad0f436fe80817d726f66c38}}
|
|
\index{ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}!RectangleShadow@{RectangleShadow}}
|
|
\index{RectangleShadow@{RectangleShadow}!ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}}
|
|
\doxysubsubsection{\texorpdfstring{RectangleShadow()}{RectangleShadow()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
|
{\footnotesize\ttfamily Com\+Square\+::\+Memory\+::\+Rectangle\+Shadow\+::\+Rectangle\+Shadow (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classComSquare_1_1Memory_1_1RectangleShadow}{Rectangle\+Shadow}} \&}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [default]}}
|
|
|
|
|
|
|
|
A rectangle shadow is copy constructable.
|
|
|
|
\mbox{\Hypertarget{classComSquare_1_1Memory_1_1RectangleShadow_abc88d4a0ec2b74cff09efb6080728d26}\label{classComSquare_1_1Memory_1_1RectangleShadow_abc88d4a0ec2b74cff09efb6080728d26}}
|
|
\index{ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}!````~RectangleShadow@{$\sim$RectangleShadow}}
|
|
\index{````~RectangleShadow@{$\sim$RectangleShadow}!ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}}
|
|
\doxysubsubsection{\texorpdfstring{$\sim$RectangleShadow()}{~RectangleShadow()}}
|
|
{\footnotesize\ttfamily Com\+Square\+::\+Memory\+::\+Rectangle\+Shadow\+::$\sim$\+Rectangle\+Shadow (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [default]}}
|
|
|
|
|
|
|
|
A default destructor.
|
|
|
|
|
|
|
|
\doxysubsection{Member Function Documentation}
|
|
\mbox{\Hypertarget{classComSquare_1_1Memory_1_1RectangleShadow_a6f15e3bb70408dd939a7178b243c60f6}\label{classComSquare_1_1Memory_1_1RectangleShadow_a6f15e3bb70408dd939a7178b243c60f6}}
|
|
\index{ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}!getComponent@{getComponent}}
|
|
\index{getComponent@{getComponent}!ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}}
|
|
\doxysubsubsection{\texorpdfstring{getComponent()}{getComponent()}}
|
|
{\footnotesize\ttfamily \mbox{\hyperlink{namespaceComSquare_a891b49feb5c3e0aaa4873ff19b49968c}{Component}} Com\+Square\+::\+Memory\+::\+Rectangle\+Shadow\+::get\+Component (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}
|
|
|
|
|
|
|
|
Get the component of this accessor (used for debug purpose)
|
|
|
|
|
|
|
|
Implements \mbox{\hyperlink{classComSquare_1_1Memory_1_1IMemory_a31289443bb26086fb74c724cdafd2241}{Com\+Square\+::\+Memory\+::\+I\+Memory}}.
|
|
|
|
\mbox{\Hypertarget{classComSquare_1_1Memory_1_1RectangleShadow_a9552aedaed64347f56201f743a9cb42d}\label{classComSquare_1_1Memory_1_1RectangleShadow_a9552aedaed64347f56201f743a9cb42d}}
|
|
\index{ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}!getMirrored@{getMirrored}}
|
|
\index{getMirrored@{getMirrored}!ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}}
|
|
\doxysubsubsection{\texorpdfstring{getMirrored()}{getMirrored()}}
|
|
{\footnotesize\ttfamily \mbox{\hyperlink{classComSquare_1_1Memory_1_1IMemory}{I\+Memory}} \& Com\+Square\+::\+Memory\+::\+Rectangle\+Shadow\+::get\+Mirrored (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}
|
|
|
|
|
|
|
|
Return the memory accessor this accessor mirror if any.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
nullptr if is\+Mirror is false, the source otherwise.
|
|
\end{DoxyReturn}
|
|
\mbox{\Hypertarget{classComSquare_1_1Memory_1_1RectangleShadow_a1a940ad2e7ed79dc2af3b4682caab527}\label{classComSquare_1_1Memory_1_1RectangleShadow_a1a940ad2e7ed79dc2af3b4682caab527}}
|
|
\index{ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}!getName@{getName}}
|
|
\index{getName@{getName}!ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}}
|
|
\doxysubsubsection{\texorpdfstring{getName()}{getName()}}
|
|
{\footnotesize\ttfamily std\+::string Com\+Square\+::\+Memory\+::\+Rectangle\+Shadow\+::get\+Name (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}
|
|
|
|
|
|
|
|
Get the name of this accessor (used for debug purpose)
|
|
|
|
|
|
|
|
Implements \mbox{\hyperlink{classComSquare_1_1Memory_1_1IMemory_a34d654c04a8a992b439c4270d566263f}{Com\+Square\+::\+Memory\+::\+I\+Memory}}.
|
|
|
|
\mbox{\Hypertarget{classComSquare_1_1Memory_1_1RectangleShadow_a8e9ecd31b62134e08a811a8583a0af3c}\label{classComSquare_1_1Memory_1_1RectangleShadow_a8e9ecd31b62134e08a811a8583a0af3c}}
|
|
\index{ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}!getRelativeAddress@{getRelativeAddress}}
|
|
\index{getRelativeAddress@{getRelativeAddress}!ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}}
|
|
\doxysubsubsection{\texorpdfstring{getRelativeAddress()}{getRelativeAddress()}}
|
|
{\footnotesize\ttfamily \mbox{\hyperlink{Ints_8hpp_a89f009aaf5d1964a000f44f09fa0bcf8}{uint24\+\_\+t}} Com\+Square\+::\+Memory\+::\+Rectangle\+Shadow\+::get\+Relative\+Address (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{Ints_8hpp_a89f009aaf5d1964a000f44f09fa0bcf8}{uint24\+\_\+t}}}]{addr }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}
|
|
|
|
|
|
|
|
Translate an absolute address to a relative address.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em addr} & The absolute address (in the 24 bit bus) \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
The local address (0 refers to the first byte of this component).
|
|
\end{DoxyReturn}
|
|
|
|
\begin{DoxyExceptions}{Exceptions}
|
|
{\em \mbox{\hyperlink{classComSquare_1_1InvalidAddress}{Invalid\+Address}}} & is thrown if the address is not mapped by this component. \\
|
|
\hline
|
|
\end{DoxyExceptions}
|
|
|
|
|
|
Reimplemented from \mbox{\hyperlink{classComSquare_1_1Memory_1_1ARectangleMemory_ae3d2535084fcf3d923aea4d9b0d9626e}{Com\+Square\+::\+Memory\+::\+A\+Rectangle\+Memory}}.
|
|
|
|
\mbox{\Hypertarget{classComSquare_1_1Memory_1_1RectangleShadow_aa009d6ceb2d3ef951fecf54b1e25811e}\label{classComSquare_1_1Memory_1_1RectangleShadow_aa009d6ceb2d3ef951fecf54b1e25811e}}
|
|
\index{ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}!getSize@{getSize}}
|
|
\index{getSize@{getSize}!ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}}
|
|
\doxysubsubsection{\texorpdfstring{getSize()}{getSize()}}
|
|
{\footnotesize\ttfamily \mbox{\hyperlink{Ints_8hpp_a89f009aaf5d1964a000f44f09fa0bcf8}{uint24\+\_\+t}} Com\+Square\+::\+Memory\+::\+Rectangle\+Shadow\+::get\+Size (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}
|
|
|
|
|
|
|
|
Get the size of the data. This size can be lower than the mapped data.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
The number of bytes inside this memory.
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Implements \mbox{\hyperlink{classComSquare_1_1Memory_1_1IMemory_a1072ab44e7389913ff67cb77ff118c8b}{Com\+Square\+::\+Memory\+::\+I\+Memory}}.
|
|
|
|
\mbox{\Hypertarget{classComSquare_1_1Memory_1_1RectangleShadow_a5ddf968ddbfb1767d78ffe6ad6a6ee12}\label{classComSquare_1_1Memory_1_1RectangleShadow_a5ddf968ddbfb1767d78ffe6ad6a6ee12}}
|
|
\index{ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}!operator=@{operator=}}
|
|
\index{operator=@{operator=}!ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}}
|
|
\doxysubsubsection{\texorpdfstring{operator=()}{operator=()}}
|
|
{\footnotesize\ttfamily \mbox{\hyperlink{classComSquare_1_1Memory_1_1RectangleShadow}{Rectangle\+Shadow}}\& Com\+Square\+::\+Memory\+::\+Rectangle\+Shadow\+::operator= (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classComSquare_1_1Memory_1_1RectangleShadow}{Rectangle\+Shadow}} \&}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [delete]}}
|
|
|
|
|
|
|
|
@brrief A rectangle shadow is not assignable
|
|
|
|
\mbox{\Hypertarget{classComSquare_1_1Memory_1_1RectangleShadow_ac4edb47abc275812298f1314ed0cd959}\label{classComSquare_1_1Memory_1_1RectangleShadow_ac4edb47abc275812298f1314ed0cd959}}
|
|
\index{ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}!read@{read}}
|
|
\index{read@{read}!ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}}
|
|
\doxysubsubsection{\texorpdfstring{read()}{read()}}
|
|
{\footnotesize\ttfamily uint8\+\_\+t Com\+Square\+::\+Memory\+::\+Rectangle\+Shadow\+::read (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{Ints_8hpp_a89f009aaf5d1964a000f44f09fa0bcf8}{uint24\+\_\+t}}}]{addr }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}
|
|
|
|
|
|
|
|
Read from the initial \mbox{\hyperlink{classComSquare_1_1Memory_1_1AMemory}{A\+Memory}} given.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em addr} & The address to read from. The address 0x0 should refer to the first byte of the initial \mbox{\hyperlink{classComSquare_1_1Memory_1_1AMemory}{A\+Memory}}. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
\begin{DoxyExceptions}{Exceptions}
|
|
{\em \mbox{\hyperlink{classComSquare_1_1InvalidAddress}{Invalid\+Address}}} & will be thrown if the address is more than the size of the initial \mbox{\hyperlink{classComSquare_1_1Memory_1_1AMemory}{A\+Memory}}. \\
|
|
\hline
|
|
\end{DoxyExceptions}
|
|
\begin{DoxyReturn}{Returns}
|
|
Return the data at the address.
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Implements \mbox{\hyperlink{classComSquare_1_1Memory_1_1IMemory_a8459ed12c4172ee29ecdc84330f99ff7}{Com\+Square\+::\+Memory\+::\+I\+Memory}}.
|
|
|
|
\mbox{\Hypertarget{classComSquare_1_1Memory_1_1RectangleShadow_aed4a58c4ef9a27a40a1f17838db745f9}\label{classComSquare_1_1Memory_1_1RectangleShadow_aed4a58c4ef9a27a40a1f17838db745f9}}
|
|
\index{ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}!setBankOffset@{setBankOffset}}
|
|
\index{setBankOffset@{setBankOffset}!ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}}
|
|
\doxysubsubsection{\texorpdfstring{setBankOffset()}{setBankOffset()}}
|
|
{\footnotesize\ttfamily void Com\+Square\+::\+Memory\+::\+Rectangle\+Shadow\+::set\+Bank\+Offset (\begin{DoxyParamCaption}\item[{int}]{bank\+Offset }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Set the number of bank this component do not shadow. Referring to the first byte of this component will refer to the first byte of the bank at (bank\+Offset + start of initial memory).
|
|
|
|
\mbox{\Hypertarget{classComSquare_1_1Memory_1_1RectangleShadow_abd2c3a785eb5c43249965650d8b53574}\label{classComSquare_1_1Memory_1_1RectangleShadow_abd2c3a785eb5c43249965650d8b53574}}
|
|
\index{ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}!write@{write}}
|
|
\index{write@{write}!ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}}
|
|
\doxysubsubsection{\texorpdfstring{write()}{write()}}
|
|
{\footnotesize\ttfamily void Com\+Square\+::\+Memory\+::\+Rectangle\+Shadow\+::write (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{Ints_8hpp_a89f009aaf5d1964a000f44f09fa0bcf8}{uint24\+\_\+t}}}]{addr, }\item[{uint8\+\_\+t}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}
|
|
|
|
|
|
|
|
Write data to the ram.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em addr} & The address to write to. The address 0x0 should refer to the first byte of the initial \mbox{\hyperlink{classComSquare_1_1Memory_1_1AMemory}{A\+Memory}}. \\
|
|
\hline
|
|
{\em data} & The data to write. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
\begin{DoxyExceptions}{Exceptions}
|
|
{\em \mbox{\hyperlink{classComSquare_1_1InvalidAddress}{Invalid\+Address}}} & will be thrown if the address is more than the size of the initial \mbox{\hyperlink{classComSquare_1_1Memory_1_1AMemory}{A\+Memory}}. \\
|
|
\hline
|
|
\end{DoxyExceptions}
|
|
|
|
|
|
Implements \mbox{\hyperlink{classComSquare_1_1Memory_1_1IMemory_a449bc89798a0b86028bb0413106514d9}{Com\+Square\+::\+Memory\+::\+I\+Memory}}.
|
|
|
|
|
|
|
|
\doxysubsection{Member Data Documentation}
|
|
\mbox{\Hypertarget{classComSquare_1_1Memory_1_1RectangleShadow_a281490c83f087fed5b4ab9abbaa80e32}\label{classComSquare_1_1Memory_1_1RectangleShadow_a281490c83f087fed5b4ab9abbaa80e32}}
|
|
\index{ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}!\_bankOffset@{\_bankOffset}}
|
|
\index{\_bankOffset@{\_bankOffset}!ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}}
|
|
\doxysubsubsection{\texorpdfstring{\_bankOffset}{\_bankOffset}}
|
|
{\footnotesize\ttfamily int Com\+Square\+::\+Memory\+::\+Rectangle\+Shadow\+::\+\_\+bank\+Offset = 0\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
The number of banks to add to the memory before accessing it from the initial data.
|
|
|
|
\mbox{\Hypertarget{classComSquare_1_1Memory_1_1RectangleShadow_af2fa7c3726a966734401c9d74efb9857}\label{classComSquare_1_1Memory_1_1RectangleShadow_af2fa7c3726a966734401c9d74efb9857}}
|
|
\index{ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}!\_initial@{\_initial}}
|
|
\index{\_initial@{\_initial}!ComSquare::Memory::RectangleShadow@{ComSquare::Memory::RectangleShadow}}
|
|
\doxysubsubsection{\texorpdfstring{\_initial}{\_initial}}
|
|
{\footnotesize\ttfamily \mbox{\hyperlink{classComSquare_1_1Memory_1_1IMemory}{I\+Memory}}\& Com\+Square\+::\+Memory\+::\+Rectangle\+Shadow\+::\+\_\+initial\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
\mbox{\hyperlink{namespaceComSquare_1_1Memory}{Memory}} to shadow from.
|
|
|
|
|
|
|
|
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
sources/\+Memory/\mbox{\hyperlink{RectangleShadow_8hpp}{Rectangle\+Shadow.\+hpp}}\item
|
|
sources/\+Memory/\mbox{\hyperlink{RectangleShadow_8cpp}{Rectangle\+Shadow.\+cpp}}\end{DoxyCompactItemize}
|