source: Vago/Libs/quazip-0.7.2/doc/latex/classQuaCrc32.tex@ 1069

Last change on this file since 1069 was 1050, checked in by s10k, 8 years ago
File size: 3.7 KB
RevLine 
[1050]1\section{QuaCrc32 Class Reference}
2\label{classQuaCrc32}\index{QuaCrc32@{QuaCrc32}}
3
4
5CRC32 checksum.
6
7
8
9
10{\ttfamily \#include $<$quazip/quacrc32.h$>$}
11
12
13
14Inheritance diagram for QuaCrc32:
15\nopagebreak
16\begin{figure}[H]
17\begin{center}
18\leavevmode
19\includegraphics[width=136pt]{classQuaCrc32__inherit__graph}
20\end{center}
21\end{figure}
22
23
24Collaboration diagram for QuaCrc32:
25\nopagebreak
26\begin{figure}[H]
27\begin{center}
28\leavevmode
29\includegraphics[width=136pt]{classQuaCrc32__coll__graph}
30\end{center}
31\end{figure}
32\subsection*{Public Member Functions}
33\begin{DoxyCompactItemize}
34\item
35quint32 {\bf calculate} (const {\bf QByteArray} \&data)
36\begin{DoxyCompactList}\small\item\em Calculates the checksum for data. \end{DoxyCompactList}\item
37void {\bf reset} ()\label{classQuaCrc32_a3fe7ce6cb73512c963ffaabfbbc66363}
38
39\begin{DoxyCompactList}\small\item\em Resets the calculation on a checksun for a stream. \end{DoxyCompactList}\item
40void {\bf update} (const {\bf QByteArray} \&buf)
41\begin{DoxyCompactList}\small\item\em Updates the calculated checksum for the stream. \end{DoxyCompactList}\item
42quint32 {\bf value} ()
43\begin{DoxyCompactList}\small\item\em Value of the checksum calculated for the stream passed throw \doxyref{update()}{p.}{classQuaCrc32_a5015d80e04afe6e6d094155b7e99888e}. \end{DoxyCompactList}\end{DoxyCompactItemize}
44
45
46\subsection{Detailed Description}
47CRC32 checksum.
48
49This class wrappers the crc32 function with the \doxyref{QuaChecksum32}{p.}{classQuaChecksum32} interface. See \doxyref{QuaChecksum32}{p.}{classQuaChecksum32} for more info.
50
51\subsection{Member Function Documentation}
52\index{QuaCrc32@{QuaCrc32}!calculate@{calculate}}
53\index{calculate@{calculate}!QuaCrc32@{QuaCrc32}}
54\subsubsection[{calculate}]{\setlength{\rightskip}{0pt plus 5cm}quint32 QuaCrc32::calculate (
55\begin{DoxyParamCaption}
56\item[{const {\bf QByteArray} \&}]{data}
57\end{DoxyParamCaption}
58)\hspace{0.3cm}{\ttfamily [virtual]}}\label{classQuaCrc32_aaf6fdf6e36e55c97bf9eab6ec65ecb9e}
59
60
61Calculates the checksum for data.
62
63{\itshape data\/} source data \begin{DoxyReturn}{Returns}
64data checksum
65\end{DoxyReturn}
66This function has no efect on the value returned by \doxyref{value()}{p.}{classQuaCrc32_a957ce46a53862f75c89d6a3ac4f73389}.
67
68Implements {\bf QuaChecksum32} \doxyref{}{p.}{classQuaChecksum32_a14d800fcfd55b2ae11ef07d3924fe0b1}.
69
70
71
72References QByteArray::data(), and QByteArray::size().
73
74\index{QuaCrc32@{QuaCrc32}!update@{update}}
75\index{update@{update}!QuaCrc32@{QuaCrc32}}
76\subsubsection[{update}]{\setlength{\rightskip}{0pt plus 5cm}void QuaCrc32::update (
77\begin{DoxyParamCaption}
78\item[{const {\bf QByteArray} \&}]{buf}
79\end{DoxyParamCaption}
80)\hspace{0.3cm}{\ttfamily [virtual]}}\label{classQuaCrc32_a5015d80e04afe6e6d094155b7e99888e}
81
82
83Updates the calculated checksum for the stream.
84
85{\itshape buf\/} next portion of data from the stream
86
87Implements {\bf QuaChecksum32} \doxyref{}{p.}{classQuaChecksum32_a63a6ed3171f9243214d307da67557f7e}.
88
89
90
91References QByteArray::data(), and QByteArray::size().
92
93\index{QuaCrc32@{QuaCrc32}!value@{value}}
94\index{value@{value}!QuaCrc32@{QuaCrc32}}
95\subsubsection[{value}]{\setlength{\rightskip}{0pt plus 5cm}quint32 QuaCrc32::value (
96\begin{DoxyParamCaption}
97{}
98\end{DoxyParamCaption}
99)\hspace{0.3cm}{\ttfamily [virtual]}}\label{classQuaCrc32_a957ce46a53862f75c89d6a3ac4f73389}
100
101
102Value of the checksum calculated for the stream passed throw \doxyref{update()}{p.}{classQuaCrc32_a5015d80e04afe6e6d094155b7e99888e}.
103
104\begin{DoxyReturn}{Returns}
105checksum
106\end{DoxyReturn}
107
108
109Implements {\bf QuaChecksum32} \doxyref{}{p.}{classQuaChecksum32_afd836e7534194fce08356be6a8336da7}.
110
111
112
113The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
114\item
115quazip/quacrc32.h\item
116quazip/quacrc32.cpp\end{DoxyCompactItemize}
Note: See TracBrowser for help on using the repository browser.